Skip to content

Commit

Permalink
feat!: migrate to ESLint flat config
Browse files Browse the repository at this point in the history
  • Loading branch information
targos committed Jul 2, 2024
1 parent c2eaeb2 commit 5241f69
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 63 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# eslint-config
# eslint-config-zakodium

Various shared ESLint configurations for Zakodium projects
Various shared ESLint configurations for Zakodium projects.

## Installation

Expand All @@ -10,19 +10,20 @@ npm install -D eslint-config-zakodium eslint

## Configuration

Create a file named `.eslintrc.yml` at the root of the project and extend the
Create a file named `eslint.config.mjs` at the root of the project and extend the
config that you want to use. Example:

```yaml
extends:
- zakodium/ts
- zakodium/adonis-v5
```js
import ts from 'eslint-config-zakodium/ts';
import adonisV5 from 'eslint-config-zakodium/adonis-v5';

export default [...ts, ...adonisV5];
```

## Available configs

- `zakodium/js`: Same as [cheminfo/base](https://github.com/cheminfo/eslint-config/blob/main/base.js).
- `zakodium/ts`: Same as [cheminfo-typescript/base](https://github.com/cheminfo/eslint-config-cheminfo-typescript/blob/main/base.js).
- `zakodium/ts`: Same as [cheminfo-typescript/base](https://github.com/cheminfo/eslint-config-cheminfo-typescript/blob/main/base.js). Also includes `cheminfo/base`!
- `zakodium/jsdoc`: Same as [cheminfo/jsdoc](https://github.com/cheminfo/eslint-config/blob/main/jsdoc.js).
- `zakodium/unicorn`: Same as [cheminfo/unicorn](https://github.com/cheminfo/eslint-config/blob/main/unicorn.js).
- `zakodium/react`: Same as [cheminfo-react/base](https://github.com/cheminfo/eslint-config-cheminfo-react/blob/main/base.js)
Expand Down
64 changes: 32 additions & 32 deletions configs/adonis-v5.js
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
'use strict';

module.exports = {
rules: {
'import/no-unresolved': 'off',
'import/default': 'off',
'import/order': [
'warn',
{
groups: [
'builtin',
'external',
'internal',
'parent',
'sibling',
'index',
],
'newlines-between': 'always',
alphabetize: { order: 'asc' },
pathGroups: [
{
pattern: '{@ioc:*,@ioc:*/**}',
group: 'external',
position: 'after',
},
{ pattern: 'Contracts/**', group: 'internal', position: 'before' },
{ pattern: 'App/**', group: 'internal', position: 'before' },
],
pathGroupsExcludedImportTypes: ['builtin'],
},
],
export default [
{
rules: {
'import/no-unresolved': 'off',
'import/default': 'off',
'import/order': [
'warn',
{
groups: [
'builtin',
'external',
'internal',
'parent',
'sibling',
'index',
],
'newlines-between': 'always',
alphabetize: { order: 'asc' },
pathGroups: [
{
pattern: '{@ioc:*,@ioc:*/**}',
group: 'external',
position: 'after',
},
{ pattern: 'Contracts/**', group: 'internal', position: 'before' },
{ pattern: 'App/**', group: 'internal', position: 'before' },
],
pathGroupsExcludedImportTypes: ['builtin'],
},
],
},
},
};
];
6 changes: 2 additions & 4 deletions configs/js.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
'use strict';
import { default as js } from 'eslint-config-cheminfo/base';

module.exports = {
extends: 'cheminfo/base',
};
export default js;
6 changes: 2 additions & 4 deletions configs/jsdoc.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
'use strict';
import { default as jsdoc } from 'eslint-config-cheminfo/jsdoc';

module.exports = {
extends: 'cheminfo/jsdoc',
};
export default jsdoc;
6 changes: 2 additions & 4 deletions configs/react.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
'use strict';
import { default as react } from 'eslint-config-cheminfo-react/base';

module.exports = {
extends: 'cheminfo-react/base',
};
export default react;
6 changes: 2 additions & 4 deletions configs/ts.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
'use strict';
import { default as ts } from 'eslint-config-cheminfo-typescript/base';

module.exports = {
extends: 'cheminfo-typescript/base',
};
export default ts;
6 changes: 2 additions & 4 deletions configs/unicorn.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
'use strict';
import { default as unicorn } from 'eslint-config-cheminfo/unicorn';

module.exports = {
extends: 'cheminfo/unicorn',
};
export default unicorn;
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"name": "eslint-config-zakodium",
"version": "10.0.0",
"description": "Various shared ESLint configurations for Zakodium projects",
"type": "module",
"exports": {
"./adonis-v5": "./configs/adonis-v5.js",
"./js": "./configs/js.js",
Expand All @@ -27,9 +28,9 @@
},
"homepage": "https://github.com/zakodium/eslint-config#readme",
"dependencies": {
"eslint-config-cheminfo": "^10.0.0",
"eslint-config-cheminfo-react": "^12.0.0",
"eslint-config-cheminfo-typescript": "^13.0.0"
"eslint-config-cheminfo": "^11.0.3",
"eslint-config-cheminfo-react": "^13.0.0",
"eslint-config-cheminfo-typescript": "^14.0.0"
},
"peerDependencies": {
"eslint": "^8.57.0"
Expand Down

0 comments on commit 5241f69

Please sign in to comment.