Skip to content

Migrate to flat config (eslint v9+) #20

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

Open
wants to merge 5 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
9 changes: 0 additions & 9 deletions .eslintrc.json

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node: [ 14, 16, 18 ]
node: [ 18, 20, 22 ]
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
Expand Down
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,10 @@ npm install --save-dev eslint-plugin-require-extensions
```

2. Edit `.eslintrc`
```json
```js
{
"extends": [
"plugin:require-extensions/recommended"
],
"plugins": [
"require-extensions"
requireExtensions.configs.recommended,
]
}
```
Expand Down
15 changes: 15 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { defineConfig } from "eslint/config";
import requireExtensions from "./index.js";

export default defineConfig([{
extends: [
requireExtensions.configs.recommended,
],
languageOptions: {
ecmaVersion: 2020,
sourceType: "module",
},
ignores: [
"index.js"
]
}]);
2 changes: 2 additions & 0 deletions example/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ import 'foo';
import './foo.js';
import './foo.json';
import json from './foo.json?raw';
import './bar/index.js';

// eslint-disable-next-line require-extensions/require-extensions
import queryNoExt from './foo?raw';
// eslint-disable-next-line require-extensions/require-extensions
Expand Down
85 changes: 47 additions & 38 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,46 +1,53 @@
const { existsSync, lstatSync } = require('fs');
const { dirname, resolve } = require('path');
import { existsSync, lstatSync } from 'fs';
import { dirname, resolve } from 'path';

module.exports = {
configs: {
recommended: {
plugins: ['require-extensions'],
rules: {
'require-extensions/require-extensions': 'error',
'require-extensions/require-index': 'error',
},
const requireExtensions = {
configs: {},
rules: {},
processors: {},
};

Object.assign(requireExtensions.configs, {
recommended: {
plugins: {
'require-extensions': requireExtensions,
},
rules: {
'require-extensions/require-extensions': 'error',
'require-extensions/require-index': 'error',
},
},
rules: {
'require-extensions': rule((context, node, path) => {
if (!existsSync(path)) {
let fix;
if (!node.source.value.includes('?')) {
fix = (fixer) => {
return fixer.replaceText(node.source, `'${node.source.value}.js'`);
};
}
});

context.report({
node,
message: 'Relative imports and exports must end with .js',
fix,
});
}
}),
'require-index': rule((context, node, path) => {
if (existsSync(path) && lstatSync(path).isDirectory()) {
context.report({
node,
message: 'Directory paths must end with index.js',
fix(fixer) {
return fixer.replaceText(node.source, `'${node.source.value}/index.js'`);
},
});
Object.assign(requireExtensions.rules, {
'require-extensions': rule((context, node, path) => {
if (!existsSync(path)) {
let fix;
if (!node.source.value.includes('?')) {
fix = (fixer) => {
return fixer.replaceText(node.source, `'${node.source.value.replace(/(\.|\.j)$/, '')}.js'`);
};
}
}),
},
};

context.report({
node,
message: 'Relative imports and exports must end with .js',
fix,
});
}
}),
'require-index': rule((context, node, path) => {
if (existsSync(path) && lstatSync(path).isDirectory()) {
context.report({
node,
message: 'Directory paths must end with index.js',
fix(fixer) {
return fixer.replaceText(node.source, `'${node.source.value}/index.js'`);
},
});
}
}),
});

function rule(check) {
return {
Expand All @@ -67,3 +74,5 @@ function rule(check) {
},
};
}

export default requireExtensions;
Loading