Skip to content

refactor: eslint-config to flat config file #83

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.

Sign up for GitHub

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

Draft
YvetteNikolov wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

refactor: eslint-config to flat config file #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
208 changes: 128 additions & 80 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
"scripts": {
"lint:js": "yard-toolkit lint js -m custom ./packages/**/src/**/*.js",
"format:js": "yard-toolkit format js -m custom ./packages/**/*.js",
"dep:check": "syncpack list-mismatches",
"dep:fix": "syncpack fix-mismatches",
"dep:check": "syncpack lint",
"dep:fix": "syncpack fix",
"dep:outdated": "npm outdated --workspaces",
"dep:update": "ncu --deep -u && npm install",
"prepare": "husky"
Expand Down
14 changes: 6 additions & 8 deletions packages/eslint-config/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,21 @@ npm i @yardinternet/eslint-config

## Usage

`@yardinternet/eslint-config` can be required in the `.eslint.config.js`
`@yardinternet/eslint-config` can be required in the `.eslint.config.cjs`

```js
module.exports = require('@yardinternet/eslint-config');
```

If you want to add or override settings you can use tools like [deepmerge](https://www.npmjs.com/package/deepmerge).
You can merge or override rules by spreading this config and adding your own objects:

```js
const merge = require('deepmerge');
const eslintSettings = merge(require('@yardinternet/eslint-config'), [
module.exports = [
...require('@yardinternet/eslint-config'),
{
rules: {
// Your overrides here
"jsdoc/require-param": 0,
},
},
])

module.exports = eslintSettings;
];
```
6 changes: 2 additions & 4 deletions packages/eslint-config/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,12 @@
"license": "ISC",
"dependencies": {
"@babel/preset-react": "^7.28.5",
"@eslint/compat": "^2.0.2",
"@eslint/eslintrc": "^3.3.3",
"@eslint/js": "^9.39.1",
"@typescript-eslint/eslint-plugin": "^8.56.0",
"@wordpress/eslint-plugin": "^24.2.0",
"eslint-config-prettier": "^10.1.8",
"eslint": "^9.39.2",
"eslint-import-resolver-alias": "^1.1.2",
"eslint-plugin-import": "^2.32.0",
"eslint-plugin-prettier": "^5.5.5",
"eslint-plugin-react-hooks": "^7.0.1",
"globals": "^17.3.0"
}
Expand Down
Loading