Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support flat config (and thus ESLint 9) #26

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 0 additions & 25 deletions .eslintrc.json

This file was deleted.

42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,47 @@ $ npm install @fintechstudios/eslint-plugin-chai-as-promised --save-dev

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `@fintechstudios/eslint-plugin-chai-as-promised` globally.

## Usage
## Usage for eslint.config.js flat (ESLint >= 8)

Add `@fintechstudios/chai-as-promised` to a plugins object within your `eslint.config.js` configuration file. You can omit the `eslint-plugin-` prefix:

```js
import chaiAsPromised from '@fintechstudios/chai-as-promised';

export default [
{
"plugins": {
"@fintechstudios/eslint-plugin-chai-as-promised": chaiAsPromised
}
}
];
```


Then configure the rules you want to use under the rules section.

```json
{
"rules": {
"@fintechstudios/chai-as-promised/no-unhandled-promises": 2,
"@fintechstudios/chai-as-promised/no-await-in-condition": 2
}
}
```

Or, to just use the configuration above as is, you can simply add the
following instead:

```js
import chaiAsPromised from '@fintechstudios/chai-as-promised';

export default [
chaiAsPromised.configs['flat/recommended'];
];
```


## Usage for .eslintrc (ESLint < 9)

Add `@fintechstudios/chai-as-promised` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

Expand Down
32 changes: 32 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import eslint from '@eslint/js';
import globals from 'globals';

export default [
eslint.configs.recommended,
{
files: ['**/*.js'],
languageOptions: {
globals: {
...globals.node,
expect: true,
ruleTester: true,
RuleTester: true
},
sourceType: 'commonjs',
ecmaVersion: 2015
}
},
{
rules: {
'strict': ['error'],
'indent': ['error', 2],

'semi': ['error'],
'prefer-const': ['error'],
'no-var': ['error'],
'prefer-destructuring': ['error'],
'object-shorthand': ['error'],
'quotes': ['error', 'single']
}
}
];
29 changes: 20 additions & 9 deletions lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,28 @@ const noAwaitInCondition = require('./rules/no-await-in-condition');
const noUnhandledPromisesRules = require('./rules/no-unhandled-promises');

module.exports = {
configs: {
recommended: {
plugins: ['@fintechstudios/chai-as-promised'],
rules: {
'@fintechstudios/chai-as-promised/no-await-in-condition': 'error',
'@fintechstudios/chai-as-promised/no-unhandled-promises': 'error'
}
}
},
rules: {
'no-await-in-condition': noAwaitInCondition,
'no-unhandled-promises': noUnhandledPromisesRules,
},
};

module.exports.configs = {
recommended: {
plugins: ['@fintechstudios/chai-as-promised'],
rules: {
'@fintechstudios/chai-as-promised/no-await-in-condition': 'error',
'@fintechstudios/chai-as-promised/no-unhandled-promises': 'error'
}
},
'flat/recommended': {
name: '@fintechstudios/chai-as-promised/flat/recommended',
plugins: {
'@fintechstudios/chai-as-promised': module.exports
},
rules: {
'@fintechstudios/chai-as-promised/no-await-in-condition': 'error',
'@fintechstudios/chai-as-promised/no-unhandled-promises': 'error'
}
}
};
Loading