Skip to content
This repository was archived by the owner on Jul 11, 2024. It is now read-only.

refactor: create recommended config based on rules config #35

Merged
merged 4 commits into from
Jun 23, 2020
Merged
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
2 changes: 1 addition & 1 deletion .huskyrc.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module.exports = {
hooks: {
'pre-commit': 'lint-staged',
'pre-commit': 'npm run pre-commit',
},
}
31 changes: 31 additions & 0 deletions package-lock.json

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

7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "eslint-plugin-ngrx",
"version": "0.0.1-development",
"version": "0.0.0-development",
"description": "ESLint plugin for NgRx",
"keywords": [
"NgRx",
Expand All @@ -25,7 +25,9 @@
"prebuild": "rimraf ./dist",
"build": "tsc",
"postbuild": "cpy ./{package.json,README.md} ./dist",
"lint": "eslint --ext .ts ./src/** ./tests/**"
"lint": "eslint --ext .ts ./src/** ./tests/**",
"generate:config": "ts-node ./scripts/generate-config.ts",
"pre-commit": "npm run generate:config && git add ./src/configs/**.ts && lint-staged"
},
"dependencies": {
"@typescript-eslint/experimental-utils": "^2.29.0",
Expand All @@ -49,6 +51,7 @@
"prettier": "^2.0.5",
"rimraf": "^3.0.2",
"ts-jest": "^26.0.0",
"ts-node": "^8.10.2",
"typescript": "^3.9.3"
}
}
30 changes: 30 additions & 0 deletions scripts/generate-config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import { writeFileSync } from 'fs'
import { join } from 'path'
import { format, resolveConfig } from 'prettier'
import { rules } from '../src/rules'

const prettierConfig = resolveConfig.sync(__dirname)

const RULE_NAME_PREFIX = 'ngrx/'
const CONFIG_DIRECTORY = './src/configs/'

const recommendedRules = Object.entries(rules).reduce(
(rules, [ruleName, rule]) => {
if (rule.meta.docs.recommended) {
rules[`${RULE_NAME_PREFIX}${ruleName}`] = rule.meta.docs.recommended
}
return rules
},
{},
)

const code = `export = {
plugins: ['ngrx'],
rules: ${JSON.stringify(recommendedRules)},
}
`
const config = format(code, {
parser: 'typescript',
...prettierConfig,
})
writeFileSync(join(CONFIG_DIRECTORY, 'recommended.ts'), config)
17 changes: 0 additions & 17 deletions src/configs/recommended.json

This file was deleted.

17 changes: 17 additions & 0 deletions src/configs/recommended.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
export = {
plugins: ['ngrx'],
rules: {
'ngrx/action-hygiene': 'error',
'ngrx/avoid-dispatching-multiple-actions-sequentially': 'error',
'ngrx/no-dispatch-in-effects': 'error',
'ngrx/no-effect-decorator-and-creator': 'error',
'ngrx/no-effect-decorator': 'error',
'ngrx/no-effects-in-providers': 'error',
'ngrx/no-multiple-actions-in-effects': 'error',
'ngrx/no-multiple-stores': 'error',
'ngrx/no-reducer-in-key-names': 'error',
'ngrx/no-typed-store': 'error',
'ngrx/on-function-explicit-return-type': 'error',
'ngrx/use-selector-in-select': 'error',
},
}
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { rules } from './rules'

import recommended from './configs/recommended.json'
import recommended from './configs/recommended'

export = {
rules,
Expand Down
2 changes: 1 addition & 1 deletion tests/recommended-config.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { rules } from '../src/rules'
import recommended from '../src/configs/recommended.json'
import recommended from '../src/configs/recommended'

it('should export recommended rules', () => {
const recommmendedRules: { [name: string]: false | 'error' | 'warn' } = {}
Expand Down
2 changes: 1 addition & 1 deletion tsconfig.eslint.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "./tsconfig.json",
"include": ["**/*.ts"],
"include": ["**/*.ts", "./*.js"],
"files": ["fake.ts"]
}