eslint-sh 0.0.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mike North
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,76 @@
+# eslint-sh
+
+Shell script parsing and syntax-error reporting for ESLint, with custom-rule authoring over a
+typed shell AST.
+
+This is the canonical quickstart for the `eslint-sh` / `@eslint-sh/eslint-plugin` project — start
+here regardless of which of the two packages you install.
+
+**Roadmap:** built-in lint rules and shared configs are planned but not implemented yet.
+
+## Installation
+
+```sh
+npm install --save-dev eslint-sh
+```
+
+## Usage
+
+This release reports shell syntax (parse) errors only — no lint rules ship yet, so a "0 problems"
+result means the script parsed without a syntax error, not that it is problem-free.
+
+```js
+// eslint.config.mjs
+import { defineConfig } from 'eslint/config';
+import sh from 'eslint-sh'; // equivalent to: import sh from '@eslint-sh/eslint-plugin'
+
+export default defineConfig([
+  {
+    files: ['**/*.sh', '**/*.bash'],
+    plugins: { sh },
+    language: 'sh/sh',
+    languageOptions: { dialect: 'bash', shellVersion: '3.2' },
+  },
+]);
+```
+
+## `languageOptions` reference
+
+| Option            | Allowed values                                                          | Default    | Effect                                                                                                                            |
+| ----------------- | ----------------------------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| `dialect`         | `"bash"`, `"posix"`, `"mksh"`, `"bats"`, `"zsh"`                        | `"bash"`   | Selects which shell grammar the parser accepts; parsing a construct outside the chosen dialect produces a parse error.            |
+| `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. |
+| `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 ...`.       |
+
+## Troubleshooting
+
+- **ESLint doesn't seem to look at my `.sh`/`.bash` files at all.** Confirm the config object's
+  `files` glob actually matches them, and that `language: 'sh/sh'` is set alongside
+  `plugins: { sh }` — without both, ESLint won't route the file through this plugin's language.
+- **A script I believe is valid reports a parse error.** The parser is dialect-sensitive: a
+  construct that's valid in one shell grammar (e.g. `[[ ... ]]` in bash) is a parse error in
+  another (e.g. `posix`). Set `languageOptions.dialect` to match the shell the script is actually
+  written for.
+- **Setting `shellVersion` doesn't change anything.** That's expected today — see the
+  `languageOptions` reference table above: `shellVersion` is reserved for a future rule layer and
+  has no effect on parsing while no lint rules ship.
+- **`# eslint-disable-next-line ...` comments don't seem to do anything.** No lint rules ship yet
+  in this release, so there's nothing for a disable comment to suppress until you register a
+  custom rule (see the `@eslint-sh/eslint-plugin` README's "Writing your own rules" section). If
+  you've registered a custom rule and the directive still isn't recognized, check
+  `languageOptions.directivePrefix` — it must match the prefix your comment uses (the default
+  `"eslint"` only recognizes `# eslint-disable-next-line ...`, not a custom prefix).
+
+## Status
+
+Thin umbrella re-exporting `@eslint-sh/eslint-plugin`'s plugin object unchanged as this
+package's default export — `import sh from "eslint-sh"` and `import sh from "@eslint-sh/eslint-plugin"`
+refer to the same object. `@eslint-sh/eslint-plugin` currently ships `ShellLanguage`/
+`ShellSourceCode` only; rules and shared configs are not implemented yet. Disable directives /
+inline config are implemented and live. No lint rules ship yet, so the rule id in the
+troubleshooting section above is illustrative: after you register a custom rule as
+`sh/your-rule`, `# eslint-disable-next-line sh/your-rule -- justification` suppresses it on the
+following line.
+
+For the plugin's public API reference (types, exports, selector cookbook, and a custom-rule
+authoring tutorial), see the `@eslint-sh/eslint-plugin` package's README.

package/dist/eslint-sh.d.ts

@@ -0,0 +1,5 @@
+import sh from '@eslint-sh/eslint-plugin';
+
+export default sh;
+
+export { }

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import sh from '@eslint-sh/eslint-plugin';
+/**
+ * `eslint-sh` — the unscoped umbrella package (design/PACKAGES.md's Naming
+ * decision). Re-exports `@eslint-sh/eslint-plugin`'s plugin object
+ * unchanged as this package's default export, so `import sh from
+ * "eslint-sh"` and `import sh from "@eslint-sh/eslint-plugin"` are
+ * equivalent.
+ *
+ * @public
+ */
+export default sh;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAE1C;;;;;;;;GAQG;AACH,eAAe,EAAE,CAAC"}

package/dist/index.js

@@ -0,0 +1,12 @@
+import sh from '@eslint-sh/eslint-plugin';
+/**
+ * `eslint-sh` — the unscoped umbrella package (design/PACKAGES.md's Naming
+ * decision). Re-exports `@eslint-sh/eslint-plugin`'s plugin object
+ * unchanged as this package's default export, so `import sh from
+ * "eslint-sh"` and `import sh from "@eslint-sh/eslint-plugin"` are
+ * equivalent.
+ *
+ * @public
+ */
+export default sh;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAE1C;;;;;;;;GAQG;AACH,eAAe,EAAE,CAAC"}

package/package.json

@@ -1,13 +1,68 @@
 {
   "name": "eslint-sh",
-  "version": "0.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "description": "Shell script parsing and syntax-error reporting for ESLint, with custom-rule authoring over a typed shell AST",
+  "version": "0.1.1",
+  "author": "Mike North <michael.l.north@gmail.com>",
+  "dependencies": {
+    "@eslint-sh/eslint-plugin": "0.1.1"
+  },
+  "devDependencies": {
+    "eslint": "^10.7.0"
+  },
+  "peerDependencies": {
+    "eslint": "^10.0.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/eslint-sh.d.ts",
+      "default": "./dist/index.js"
+    }
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "type": "commonjs"
-}
+  "files": [
+    "dist"
+  ],
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "nx": {
+    "targets": {
+      "check:api-report": {
+        "outputs": [
+          "{projectRoot}/api-report",
+          "{projectRoot}/temp",
+          "{projectRoot}/dist/eslint-sh.d.ts"
+        ]
+      },
+      "uplevel-api-reports": {
+        "dependsOn": [
+          "check:api-report"
+        ],
+        "cache": true,
+        "inputs": [
+          "{projectRoot}/api-report/**",
+          "{projectRoot}/temp/**"
+        ],
+        "outputs": [
+          "{workspaceRoot}/api-report-combined/eslint-sh.api.md",
+          "{workspaceRoot}/api-docs-temp/eslint-sh.api.json"
+        ]
+      }
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "types": "./dist/eslint-sh.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "check": "concurrently -n lint,types,api-report \"pnpm run check:lint-ts\" \"pnpm run check:typecheck\" \"pnpm run check:api-report\"",
+    "check:api-report": "api-extractor run",
+    "check:lint-ts": "eslint .",
+    "check:typecheck": "tsc --noEmit",
+    "clean": "rimraf --glob dist \"temp/*\" \"*.tsbuildinfo\"",
+    "fix:api-report": "api-extractor run --local",
+    "fix:lint-ts": "eslint . --fix",
+    "test": "vitest run",
+    "uplevel-api-reports": "mkdir -p ../../api-report-combined ../../api-docs-temp && cp api-report/eslint-sh.api.md ../../api-report-combined/ && cp temp/eslint-sh.api.json ../../api-docs-temp/"
+  }
+}