eslint-sh 0.3.0 → 0.5.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 (4) hide show
  1. package/README.md +28 -7
  2. package/dist/index.d.ts +2 -2
  3. package/dist/index.js +2 -2
  4. package/package.json +7 -2
package/README.md CHANGED
@@ -10,6 +10,9 @@ here regardless of which of the two packages you install.
10
10
 
11
11
  ## Installation
12
12
 
13
+ Requires `eslint@^10` as a peer dependency (already listed as a peer in `eslint-sh`'s
14
+ `package.json`, so a compatible `eslint` install satisfies it automatically):
15
+
13
16
  ```sh
14
17
  npm install --save-dev eslint-sh
15
18
  ```
@@ -34,13 +37,20 @@ export default defineConfig([
34
37
  ]);
35
38
  ```
36
39
 
40
+ `languageOptions` is entirely optional — omitting it is equivalent to
41
+ `languageOptions: { dialect: 'bash' }`, since `dialect` defaults to `"bash"` (see the
42
+ `languageOptions` reference table below). This README's own [custom-rule tutorial](https://github.com/mike-north/eslint-sh/blob/main/packages/eslint-plugin/docs/custom-rule-tutorial.md)
43
+ config omits `languageOptions` for exactly that reason — it targets bash, the default, so
44
+ there's nothing to override; add it explicitly (as above) when you need a non-default
45
+ `dialect`, a `shellVersion` hint, or a custom `directivePrefix`.
46
+
37
47
  ## `languageOptions` reference
38
48
 
39
- | Option | Allowed values | Default | Effect |
40
- | ----------------- | ----------------------------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
41
- | `dialect` | `"bash"`, `"posix"`, `"mksh"`, `"bats"`, `"zsh"` | `"bash"` | Selects which shell grammar the parser accepts. Enforcement is partial: some non-dialect constructs are rejected (e.g. bash array literals under `posix`), but others (e.g. `[[ ... ]]`, `let`) are accepted as ordinary commands — see the [per-dialect enforcement table](https://github.com/mike-north/sh-ast/pull/28). |
42
- | `shellVersion` | A numeric `MAJOR` or `MAJOR.MINOR` string, e.g. `"5"` or `"3.2"` | unset | Reserved for the rule layer (e.g. a future bash-3.2 compatibility check); has no effect on parsing today since no rules ship yet. |
43
- | `directivePrefix` | Lowercase, hyphen-separated words, e.g. `"eslint"` or `"shellcheck-sh"` | `"eslint"` | The prefix directive/inline-config comments must start with — e.g. the default recognizes `# eslint-disable-next-line ...`. |
49
+ | Option | Allowed values | Default | Effect |
50
+ | ----------------- | ----------------------------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
51
+ | `dialect` | `"bash"`, `"posix"`, `"mksh"`, `"bats"`, `"zsh"` | `"bash"` | Selects which shell grammar the parser accepts. Enforcement is partial: some non-dialect constructs are rejected (e.g. bash array literals under `posix`), but others (e.g. `[[ ... ]]`, `let`) are accepted as ordinary commands — see the [per-dialect enforcement table](https://github.com/mike-north/sh-ast/blob/main/packages/sh-ast/README.md#dialect-enforcement). |
52
+ | `shellVersion` | A numeric `MAJOR` or `MAJOR.MINOR` string, e.g. `"5"` or `"3.2"` | unset | Reserved for the rule layer (e.g. a future bash-3.2 compatibility check); has no effect on parsing today since no rules ship yet. |
53
+ | `directivePrefix` | Lowercase, hyphen-separated words, e.g. `"eslint"` or `"shellcheck-sh"` | `"eslint"` | The prefix directive/inline-config comments must start with — e.g. the default recognizes `# eslint-disable-next-line ...`. |
44
54
 
45
55
  ## Troubleshooting
46
56
 
@@ -127,8 +137,8 @@ from what the plugin actually does.
127
137
  dialect enforcement is partial by design: some bash-isms — notably `[[ ... ]]` and `let` — are
128
138
  not parse errors under `dialect: 'posix'`; they silently parse as ordinary commands instead, so
129
139
  a clean `posix` run does not by itself prove a script is POSIX-compliant. See the
130
- [per-dialect construct enforcement audit](https://github.com/mike-north/sh-ast/pull/28) in
131
- `sh-ast` for the full accept/reject matrix and rationale.
140
+ [per-dialect construct enforcement audit](https://github.com/mike-north/sh-ast/blob/main/packages/sh-ast/README.md#dialect-enforcement)
141
+ in `sh-ast` for the full accept/reject matrix and rationale.
132
142
 
133
143
  - **Setting `shellVersion` doesn't change anything.** That's expected today — see the
134
144
  `languageOptions` reference table above: `shellVersion` is reserved for a future rule layer and
@@ -139,6 +149,17 @@ from what the plugin actually does.
139
149
  you've registered a custom rule and the directive still isn't recognized, check
140
150
  `languageOptions.directivePrefix` — it must match the prefix your comment uses (the default
141
151
  `"eslint"` only recognizes `# eslint-disable-next-line ...`, not a custom prefix).
152
+ - **A disable directive's rule id doesn't match anything I've registered.** An unknown rule id in
153
+ a disable comment (e.g. `# eslint-disable-next-line sh/typo-d-rule`) is a lint-time error, not a
154
+ silent no-op: ESLint reports `Definition for rule '<rule-id>' was not found.` at the directive's
155
+ location. Double-check the rule id against the name you registered it under (the `plugins`
156
+ namespace plus the rule key, e.g. `sh/your-rule`).
157
+ - **`TypeError: Key "language": Could not find "..." in plugin "sh".`** A typo in the
158
+ `language` value (e.g. `language: 'sh/shell'` instead of the registered `language: 'sh/sh'`).
159
+ This error is thrown by ESLint core itself (`Config`'s constructor), before any of this
160
+ plugin's own code runs, and does not currently enumerate the plugin's actually-registered
161
+ language ids in its message (current ESLint 10.x behavior). This plugin registers exactly one
162
+ language: `sh` (selected as `language: 'sh/sh'`).
142
163
 
143
164
  ## Status
144
165
 
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import sh from '@eslint-sh/eslint-plugin';
2
2
  /**
3
- * `eslint-sh` — the unscoped umbrella package (design/PACKAGES.md's Naming
4
- * decision). Re-exports `@eslint-sh/eslint-plugin`'s plugin object
3
+ * `eslint-sh` — the unscoped umbrella package. Re-exports
4
+ * `@eslint-sh/eslint-plugin`'s plugin object
5
5
  * unchanged as this package's default export, so `import sh from
6
6
  * "eslint-sh"` and `import sh from "@eslint-sh/eslint-plugin"` are
7
7
  * equivalent.
package/dist/index.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import sh from '@eslint-sh/eslint-plugin';
2
2
  /**
3
- * `eslint-sh` — the unscoped umbrella package (design/PACKAGES.md's Naming
4
- * decision). Re-exports `@eslint-sh/eslint-plugin`'s plugin object
3
+ * `eslint-sh` — the unscoped umbrella package. Re-exports
4
+ * `@eslint-sh/eslint-plugin`'s plugin object
5
5
  * unchanged as this package's default export, so `import sh from
6
6
  * "eslint-sh"` and `import sh from "@eslint-sh/eslint-plugin"` are
7
7
  * equivalent.
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "eslint-sh",
3
3
  "description": "Shell script parsing and syntax-error reporting for ESLint, with custom-rule authoring over a typed shell AST",
4
- "version": "0.3.0",
4
+ "version": "0.5.0",
5
5
  "author": "Mike North <michael.l.north@gmail.com>",
6
6
  "dependencies": {
7
- "@eslint-sh/eslint-plugin": "0.3.0"
7
+ "@eslint-sh/eslint-plugin": "0.5.0"
8
8
  },
9
9
  "devDependencies": {
10
10
  "eslint": "^10.7.0"
@@ -53,6 +53,11 @@
53
53
  },
54
54
  "type": "module",
55
55
  "types": "./dist/eslint-sh.d.ts",
56
+ "repository": {
57
+ "type": "git",
58
+ "url": "git+https://github.com/mike-north/eslint-sh.git",
59
+ "directory": "packages/eslint-sh"
60
+ },
56
61
  "scripts": {
57
62
  "build": "tsc -p tsconfig.json",
58
63
  "check": "concurrently -n lint,types,api-report \"pnpm run check:lint-ts\" \"pnpm run check:typecheck\" \"pnpm run check:api-report\"",