eslint-config-beslogic 2.4.13 → 2.4.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Changelog
2
2
 
3
+ ## 2.4.14
4
+
5
+ - Updated pre-commit.ci documentation
6
+
3
7
  ## 2.4.13
4
8
 
5
9
  - Made `eslint-import-resolver-typescript` optional since it can't correctly resolve our shared `tsconfig.json` when ran in pre-commit.ci
package/README.md CHANGED
@@ -75,9 +75,27 @@ If also using [`beslogic/json-like` preset](#beslogicjson-like) extend from `htt
75
75
 
76
76
  ### Usage with `pre-commit.ci` (`.pre-commit-config.yaml`)
77
77
 
78
- Use the following hook: <https://github.com/pre-commit/mirrors-eslint>
79
-
80
- Set `args: [--fix, --quiet]`.
78
+ <!-- Use the following hook: <https://github.com/pre-commit/mirrors-eslint>
79
+ Set `args: [--ignore-path, .gitignore, --fix, --quiet]`.\
80
+ For mono-repos, specify your frontend project: `args: [frontend_project, --ignore-path, frontend_project/.gitignore, --fix, --quiet]`.
81
+ -->
82
+
83
+ ```yaml
84
+ repos:
85
+ - repo: local
86
+ hooks:
87
+ - id: eslint
88
+ name: eslint
89
+ language: node
90
+ # To run at root
91
+ entry: npm run eslint -- --fix --quiet
92
+ # To run in specific project (for monorepos)
93
+ entry: bash -c 'cd frontend_project && npm run eslint -- --fix --quiet'
94
+ files: \.[jt]sx?$ # *.js, *.jsx, *.ts and *.tsx
95
+ types: [file]
96
+ pass_filenames: false
97
+ additional_dependencies: [...]
98
+ ```
81
99
 
82
100
  In the `additional_dependencies` field, you'll need to include _all_ the plugins we use (copy this project's `dependencies` in `package.json`), as well as the optional plugins you need for yor presets.
83
101
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "eslint-config-beslogic",
3
- "version": "2.4.13",
3
+ "version": "2.4.14",
4
4
  "description": "ESLint rules, plugins and configs used at Beslogic",
5
5
  "main": "index.js",
6
6
  "// dependencies": "Run for ourselves when we install dependencies w/o running npm i afterward",