eslint-sh 0.6.0 → 0.7.0

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.
Files changed (2) hide show
  1. package/README.md +8 -1
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -242,6 +242,13 @@ to the `files` patterns in your config. `--no-warn-ignored` keeps a staged file
242
242
  does not cover from failing the hook as an "ignored file" warning. File names are passed
243
243
  NUL-separated, so names with spaces work, and the hook does nothing when no shell file is staged.
244
244
 
245
+ **Linting code you don't control.** The job above runs the checkout's own config and install,
246
+ which is right for your own repository. When CI lints contributions from people who don't own the
247
+ policy, a script can switch rules off with `# eslint-disable` comments, and the checkout's
248
+ `eslint.config.mjs` is code the contributor wrote. See
249
+ [linting code you don't control](https://github.com/mike-north/eslint-sh/blob/main/packages/eslint-plugin/docs/untrusted-code.md)
250
+ for a config that ignores those comments and a command that runs ESLint from outside the checkout.
251
+
245
252
  ## Editor setup
246
253
 
247
254
  Editors that run ESLint through its language server, such as the VS Code ESLint extension, run
@@ -448,7 +455,7 @@ from what the plugin actually does.
448
455
  ```
449
456
 
450
457
  - **Setting `shellVersion` doesn't change anything.** `shellVersion` has no effect on parsing,
451
- and only the version-gated `compat/*` rules read it (`sh/compat/no-append-all-redirect`, `sh/compat/no-associative-arrays`, `sh/compat/no-case-attributes`, `sh/compat/no-case-fallthrough`, `sh/compat/no-case-modification`, `sh/compat/no-coproc`, `sh/compat/no-declare-g`, `sh/compat/no-epoch-variables`, `sh/compat/no-fd-variable`, `sh/compat/no-globstar`, `sh/compat/no-lastpipe-semantics`, `sh/compat/no-mapfile`, `sh/compat/no-nameref`, `sh/compat/no-negative-array-index`, `sh/compat/no-nounset-empty-array`, `sh/compat/no-parameter-transformation`, `sh/compat/no-pipe-all`, `sh/compat/no-printf-time-format`, `sh/compat/no-test-v`, `sh/compat/no-unicode-escape` and `sh/compat/no-wait-n`). The `bash-3.2` and `posix-portable` presets enable them; to pick rules yourself,
458
+ and only the version-gated `compat/*` rules read it (`sh/compat/no-append-all-redirect`, `sh/compat/no-associative-arrays`, `sh/compat/no-brace-sequence-padding-step`, `sh/compat/no-case-attributes`, `sh/compat/no-case-fallthrough`, `sh/compat/no-case-modification`, `sh/compat/no-coproc`, `sh/compat/no-declare-g`, `sh/compat/no-epoch-variables`, `sh/compat/no-fd-variable`, `sh/compat/no-globstar`, `sh/compat/no-lastpipe-semantics`, `sh/compat/no-mapfile`, `sh/compat/no-nameref`, `sh/compat/no-negative-array-index`, `sh/compat/no-nounset-empty-array`, `sh/compat/no-parameter-transformation`, `sh/compat/no-pipe-all`, `sh/compat/no-printf-time-format`, `sh/compat/no-test-v`, `sh/compat/no-unicode-escape` and `sh/compat/no-wait-n`). The `bash-3.2` and `posix-portable` presets enable them; to pick rules yourself,
452
459
  enable the ones you want, for example `'sh/compat/no-mapfile': 'error'`. See
453
460
  [version compatibility](https://github.com/mike-north/eslint-sh/blob/main/packages/eslint-plugin/docs/compat.md).
454
461
  - **`# eslint-disable-next-line ...` comments don't seem to do anything.** First check that the
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "eslint-sh",
3
3
  "description": "Shell script linting for ESLint, with built-in policy rules, shared presets, and custom rules over a typed shell AST",
4
- "version": "0.6.0",
4
+ "version": "0.7.0",
5
5
  "author": "Mike North <michael.l.north@gmail.com>",
6
6
  "dependencies": {
7
- "@eslint-sh/eslint-plugin": "0.6.0"
7
+ "@eslint-sh/eslint-plugin": "0.7.0"
8
8
  },
9
9
  "devDependencies": {
10
10
  "eslint": "^10.7.0"