Commit 6ad639be authored by Hugo "ThePooN" Denizart's avatar Hugo "ThePooN" Denizart
Browse files

馃敄 锔 Release 0.1.0, dependencies and docs upgrade

parent 9d971d0e
Pipeline #4736 passed with stage
in 18 seconds
......@@ -2,7 +2,7 @@ module.exports = {
parser: "@typescript-eslint/parser",
parserOptions: {
project: "./tsconfig.json",
},
},
ignorePatterns: ["node_modules/", "build"],
plugins: [
"@typescript-eslint",
......@@ -28,11 +28,13 @@ module.exports = {
"named": "never",
"asyncArrow": "always"
}],
"indent": ["error", 4],
"comma-dangle": ["error", "always-multiline"],
"curly": ["error", "multi"],
"keyword-spacing": ["error", { overrides: { if: { after: false }, for: { after: false } } }],
"lines-between-class-members": "off",
"no-console": "error",
"quotes": ["error", "double"],
"require-await": "off",
"semi": ["error", "always"],
"sort-imports": ["error", { ignoreCase: true }],
......
# @osufrlive/config
# @osufrlive/eslint-config
ESLint config for osu!frlive projects.
## Usage
Tested on npm 7+. Peer dependencies behavior change often in between major releases.
- Install as a development dependency:
```
npm i -D @osufrlive/eslint-config
npx install-peerdeps -o -d @osufrlive/eslint-config
```
Paste in .eslintrc.js:
- Paste in .eslintrc.js:
```javascript
module.exports = {
root: true,
extends: [
"@osufrlive",
],
root: true,
extends: [
"@osufrlive",
],
};
```
Add the following script to `package.json`:
- Add the following script to `package.json`:
```json
"lint": "eslint --ext .js,.ts -- src/ config/"
"lint": "eslint --ext .js,.ts src/"
```
## Tip to allow linting entire repository
Files never included in the TypeScript context (such as .eslintrc.js) may error out with:
```
/home/thepoon/Documents/git/osufrlive/form-auth/.eslintrc.js
0:0 error Parsing error: "parserOptions.project" has been set for @typescript-eslint/parser.
The file does not match your project config: .eslintrc.js.
The file must be included in at least one of the projects provided
```
Suggested work-around:
- Create a new `tsconfig.eslint.json` file with:
```json
{
"extends": "./tsconfig.json",
"include": [
".eslintrc.js",
],
}
```
- Override `parserOptions.project` in `.eslintrc.js`, eg.:
```js
module.exports = {
root: true,
parserOptions: {
project: ["./tsconfig.json", "./tsconfig.eslint.json"],
},
extends: [
"@osufrlive",
],
};
```
## Upgrading
If upgrading from 0.0.x:
- Remove any peer dependencies introduced by the package
- Remove the package
- Reinstall the package
- Update .eslintrc.js (see above)
This diff is collapsed.
{
"name": "@osufrlive/eslint-config",
"version": "0.0.5",
"version": "0.1.0",
"main": "index.js",
"peerDependencies": {
"@typescript-eslint/eslint-plugin": "^4.22.1",
"eslint": "^7.25.0",
"eslint-config-standard-with-typescript": "^20.0.0",
"eslint-plugin-import": "^2.22.1",
"eslint-plugin-node": "^11.1.0",
"eslint-plugin-promise": "^4.3.1",
"eslint-plugin-standard": "^4.1.0",
"typescript": "^4.2.4"
"eslint-config-standard-with-typescript": "^21.0.1",
"typescript": ">=4 && <4.5.0"
},
"devDependencies": {
"version-from-git": "^1.1.1"
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment