@eslint-sh/eslint-plugin 0.1.0 → 0.1.1

package/README.md

@@ -1,36 +1,14 @@
 # @eslint-sh/eslint-plugin
 
-Shell script parsing and syntax-error reporting for ESLint, with custom-rule authoring over a
-typed shell AST. Provides the `ShellLanguage` / `ShellSourceCode` core that lets ESLint parse and
-traverse `.sh`/`.bash` files, backed by `sh-ast`.
-
-**Roadmap:** built-in lint rules and shared configs are planned but not implemented yet.
-
-## `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 ...`.       |
-
-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/eslint-plugin'; // or the umbrella: import sh from "eslint-sh"
-
-export default defineConfig([
-  {
-    files: ['**/*.sh', '**/*.bash'],
-    plugins: { sh },
-    language: 'sh/sh',
-    languageOptions: { dialect: 'bash', shellVersion: '3.2' },
-  },
-]);
-```
+The underlying ESLint plugin behind the `eslint-sh` umbrella package: shell script parsing and
+syntax-error reporting for ESLint, with custom-rule authoring over a typed shell AST. Provides the
+`ShellLanguage` / `ShellSourceCode` core that lets ESLint parse and traverse `.sh`/`.bash` files,
+backed by `sh-ast`.
+
+For installation, the config example, the `languageOptions` reference table, the capability
+caveat, and troubleshooting, see the [`eslint-sh` package's README](https://github.com/mike-north/eslint-sh/blob/main/packages/eslint-sh/README.md) —
+that's the canonical quickstart for this project, and applies whether you install `eslint-sh` or
+this package directly.
 
 ## Status
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eslint-sh/eslint-plugin",
   "description": "Shell script parsing and syntax-error reporting for ESLint, with custom-rule authoring over a typed shell AST, backed by sh-ast.",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "author": "Mike North <michael.l.north@gmail.com>",
   "dependencies": {
     "@eslint/core": "^1.2.1",