@eslint/shell 0.0.0-stage → 0.1.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,168 @@
-# Temporary Holding Version
+# ESLint Shell Language Plugin
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A shell language plugin for [ESLint](https://eslint.org), providing:
+
+- an ESLint-style **parser** for shell scripts (wrapping
+  [mvdan-sh](https://www.npmjs.com/package/mvdan-sh), the parser behind
+  `shfmt`) that produces an ESTree-style syntax tree,
+- an ESLint **language** implementation so rules can traverse that tree,
+- **rules** inspired by [ShellCheck](https://www.shellcheck.net) checks, and
+- a **recommended configuration**.
+
+## Installation
+
+```bash
+npm install --save-dev eslint @eslint/shell
+```
+
+Requires Node.js `^20.19.0 || ^22.13.0 || >=24`. Tested with ESLint v10.
+
+## Usage
+
+Add the plugin to your `eslint.config.js`:
+
+```js
+import { defineConfig } from "eslint/config";
+import shell from "@eslint/shell";
+
+export default defineConfig([
+	{
+		// use the recommended rules for *.sh and *.bash files
+		files: ["**/*.sh", "**/*.bash"],
+		plugins: { shell },
+		extends: ["shell/recommended"],
+	},
+]);
+```
+
+Or configure it manually:
+
+```js
+import { defineConfig } from "eslint/config";
+import shell from "@eslint/shell";
+
+export default defineConfig([
+	{
+		files: ["**/*.sh"],
+		plugins: { shell },
+		language: "shell/bash",
+		rules: {
+			"shell/no-backticks": "error",
+			"shell/no-unquoted-expansions": "error",
+		},
+	},
+]);
+```
+
+### Languages
+
+The plugin provides one language per shell dialect:
+
+| Language      | Description                           |
+| ------------- | ------------------------------------- |
+| `shell/bash`  | Bash. Used by the recommended config. |
+| `shell/posix` | POSIX `sh`, without Bash extensions.  |
+| `shell/mksh`  | MirBSD Korn shell.                    |
+
+```js
+import { defineConfig } from "eslint/config";
+import shell from "@eslint/shell";
+
+export default defineConfig([
+	{
+		files: ["**/*.sh"],
+		plugins: { shell },
+		extends: ["shell/recommended"],
+		language: "shell/posix",
+	},
+]);
+```
+
+## Rules
+
+Each rule mirrors a well-known ShellCheck check.
+
+| Rule                                                                               | ShellCheck | Description                                             | Fixable | Recommended |
+| ---------------------------------------------------------------------------------- | ---------- | ------------------------------------------------------- | ------- | ----------- |
+| [`no-backticks`](./docs/rules/no-backticks.md)                                     | SC2006     | Use `$(...)` instead of legacy backticks                | ✅      | error       |
+| [`no-expansions-in-single-quotes`](./docs/rules/no-expansions-in-single-quotes.md) | SC2016     | Expressions don't expand in single quotes               |         | warn        |
+| [`no-ls-iteration`](./docs/rules/no-ls-iteration.md)                               | SC2045     | Don't iterate over `ls` output; use globs               |         | error       |
+| [`no-unquoted-expansions`](./docs/rules/no-unquoted-expansions.md)                 | SC2086/46  | Quote expansions subject to word splitting and globbing | ✅      | error       |
+| [`no-unused-vars`](./docs/rules/no-unused-vars.md)                                 | SC2034     | Disallow variables that are assigned but never used     |         | error       |
+| [`no-useless-cat`](./docs/rules/no-useless-cat.md)                                 | SC2002     | Don't pipe from a single-file `cat`                     |         | error       |
+| [`no-useless-echo`](./docs/rules/no-useless-echo.md)                               | SC2116     | Disallow `$(echo ...)`                                  |         | error       |
+| [`no-variables-in-printf-format`](./docs/rules/no-variables-in-printf-format.md)   | SC2059     | Don't put variables in the `printf` format string       |         | error       |
+| [`require-cd-guard`](./docs/rules/require-cd-guard.md)                             | SC2164     | Handle `cd` failure with `\|\| exit` (has suggestions)  |         | error       |
+| [`require-read-r`](./docs/rules/require-read-r.md)                                 | SC2162     | Use `read -r` so backslashes aren't mangled             | ✅      | error       |
+
+### Rule options
+
+`shell/no-unused-vars` accepts an object option:
+
+```js
+"shell/no-unused-vars": ["error", { allowed: ["MY_GLOBAL"] }]
+```
+
+## Configuration comments
+
+Standard ESLint configuration comments work inside shell scripts:
+
+```bash
+# eslint-disable-next-line shell/no-backticks
+echo `pwd`
+
+echo `pwd` # eslint-disable-line shell/no-backticks -- legacy
+
+# eslint shell/no-useless-echo: "warn"
+```
+
+## Syntax tree
+
+The tree format is documented in [docs/syntax-tree.md](docs/syntax-tree.md).
+Nodes carry `start`/`end` character offsets instead of `range`/`loc`
+properties; use `sourceCode.getRange(node)` and `sourceCode.getLoc(node)`.
+
+The parser is also exported directly:
+
+```js
+import { parseShell } from "@eslint/shell";
+
+const { ast, comments } = parseShell('echo "hello"\n');
+```
+
+## Development
+
+```bash
+npm install
+npm test          # unit + integration tests (Vitest)
+npm run lint      # ESLint on the plugin's own sources
+npm run fmt       # Prettier
+npm run build     # compile TypeScript to dist/
+```
+
+Pre-commit hooks (via [yorkie](https://www.npmjs.com/package/yorkie) and
+lint-staged) run Prettier and ESLint on staged files. Releases are managed
+with [release-please](https://github.com/googleapis/release-please) through
+GitHub Actions.
+
+## License
+
+Apache-2.0
+
+<!-- NOTE: This section is autogenerated. Do not manually edit.-->
+<!--sponsorsstart-->
+
+
+## Sponsors
+
+The following companies, organizations, and individuals support ESLint's ongoing maintenance and development. [Become a Sponsor](https://eslint.org/donate)
+to get your logo on our READMEs and [website](https://eslint.org/sponsors).
+
+<h3>Gold Sponsors</h3>
+<p><a href="#"><img src="https://images.opencollective.com/vite-ecosystem-fund/logo.png" alt="Vite Ecosystem Fund" height="96"></a> <a href="https://forceindexer.com"><img src="https://images.opencollective.com/forceindexer/588566e/logo.png" alt="ForceIndexer" height="96"></a> <a href="https://qlty.sh/"><img src="https://images.opencollective.com/qltysh/33d157d/logo.png" alt="Qlty Software" height="96"></a> <a href="https://shopify.engineering/"><img src="https://avatars.githubusercontent.com/u/8085" alt="Shopify" height="96"></a> <a href="https://www.coderabbit.ai/?utm_source=cr_org&utm_medium=github"><img src="https://avatars.githubusercontent.com/u/132028505" alt="CodeRabbit" height="96"></a> <a href="https://automattic.com"><img src="https://avatars.githubusercontent.com/u/887802" alt="Automattic" height="96"></a></p><h3>Silver Sponsors</h3>
+<p><a href="https://vite.dev/"><img src="https://images.opencollective.com/vite/d472863/logo.png" alt="Vite" height="64"></a> <a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/2d6c3b6/logo.png" alt="Liftoff" height="64"></a> <a href="https://stackblitz.com"><img src="https://avatars.githubusercontent.com/u/28635252" alt="StackBlitz" height="64"></a></p><h3>Bronze Sponsors</h3>
+<p><a href="https://cybozu.co.jp/"><img src="https://images.opencollective.com/cybozu/933e46d/logo.png" alt="Cybozu" height="32"></a> <a href="https://opensource.sap.com"><img src="https://avatars.githubusercontent.com/u/2531208" alt="SAP" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://www.gitbook.com"><img src="https://avatars.githubusercontent.com/u/7111340" alt="GitBook" height="32"></a> <a href="https://citadel-ai.com"><img src="https://avatars.githubusercontent.com/u/75781367" alt="Citadel AI" height="32"></a> <a href="https://www.testmuai.com"><img src="https://avatars.githubusercontent.com/u/171592363" alt="TestMu AI Open Source Office (Formerly LambdaTest)" height="32"></a></p>
+<h3>Technology Sponsors</h3>
+Technology sponsors allow us to use their products and services for free as part of a contribution to the open source ecosystem and our work.
+<p><a href="https://netlify.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/netlify-icon.svg" alt="Netlify" height="32"></a> <a href="https://algolia.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/algolia-icon.svg" alt="Algolia" height="32"></a> <a href="https://1password.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/1password-icon.svg" alt="1Password" height="32"></a></p>
+<!--sponsorsend-->

package/dist/index.d.ts

@@ -0,0 +1,79 @@
+/**
+ * @fileoverview The @eslint/shell plugin: a shell language definition for
+ * ESLint, ShellCheck-inspired rules, and a recommended configuration.
+ * @author Claude Opus 5.5
+ */
+import { ShellLanguage } from "./languages/shell-language.js";
+declare const plugin: {
+    meta: {
+        name: string;
+        namespace: string;
+        version: string;
+    };
+    languages: {
+        bash: ShellLanguage;
+        posix: ShellLanguage;
+        mksh: ShellLanguage;
+    };
+    rules: {
+        "no-backticks": import("./types.js").ShellRuleDefinition<{
+            MessageIds: "useDollarParen";
+        }>;
+        "no-expansions-in-single-quotes": import("./types.js").ShellRuleDefinition<{
+            MessageIds: "expansionInSingleQuotes";
+        }>;
+        "no-ls-iteration": import("./types.js").ShellRuleDefinition<{
+            MessageIds: "lsIteration";
+        }>;
+        "no-unquoted-expansions": import("./types.js").ShellRuleDefinition<{
+            MessageIds: "unquotedParameterExpansion" | "unquotedCommandSubstitution";
+        }>;
+        "no-unused-vars": import("./types.js").ShellRuleDefinition<{
+            MessageIds: "unusedVariable";
+            RuleOptions: [{
+                allowed?: string[];
+            }?];
+        }>;
+        "no-useless-cat": import("./types.js").ShellRuleDefinition<{
+            MessageIds: "uselessCat";
+        }>;
+        "no-useless-echo": import("./types.js").ShellRuleDefinition<{
+            MessageIds: "uselessEcho";
+        }>;
+        "no-variables-in-printf-format": import("./types.js").ShellRuleDefinition<{
+            MessageIds: "variableInFormat";
+        }>;
+        "require-cd-guard": import("./types.js").ShellRuleDefinition<{
+            MessageIds: "uncheckedCd" | "addGuard";
+        }>;
+        "require-read-r": import("./types.js").ShellRuleDefinition<{
+            MessageIds: "missingR";
+        }>;
+    };
+    configs: {
+        recommended: {
+            name: string;
+            files: string[];
+            language: string;
+            plugins: {};
+            rules: {
+                "shell/no-backticks": string;
+                "shell/no-expansions-in-single-quotes": string;
+                "shell/no-ls-iteration": string;
+                "shell/no-unquoted-expansions": string;
+                "shell/no-unused-vars": string;
+                "shell/no-useless-cat": string;
+                "shell/no-useless-echo": string;
+                "shell/no-variables-in-printf-format": string;
+                "shell/require-cd-guard": string;
+                "shell/require-read-r": string;
+            };
+        };
+    };
+};
+export default plugin;
+export { ShellLanguage } from "./languages/shell-language.js";
+export { ShellSourceCode } from "./languages/shell-source-code.js";
+export { parseShell, ShellSyntaxError } from "./parser/parse.js";
+export { visitorKeys } from "./visitor-keys.js";
+export type * from "./types.js";

package/dist/index.js

@@ -0,0 +1,74 @@
+/**
+ * @fileoverview The @eslint/shell plugin: a shell language definition for
+ * ESLint, ShellCheck-inspired rules, and a recommended configuration.
+ * @author Claude Opus 5.5
+ */
+//------------------------------------------------------------------------------
+// Plugin
+//------------------------------------------------------------------------------
+import { ShellLanguage } from "./languages/shell-language.js";
+import noBackticks from "./rules/no-backticks.js";
+import noExpansionsInSingleQuotes from "./rules/no-expansions-in-single-quotes.js";
+import noLsIteration from "./rules/no-ls-iteration.js";
+import noUnquotedExpansions from "./rules/no-unquoted-expansions.js";
+import noUnusedVars from "./rules/no-unused-vars.js";
+import noUselessCat from "./rules/no-useless-cat.js";
+import noUselessEcho from "./rules/no-useless-echo.js";
+import noVariablesInPrintfFormat from "./rules/no-variables-in-printf-format.js";
+import requireCdGuard from "./rules/require-cd-guard.js";
+import requireReadR from "./rules/require-read-r.js";
+const rules = {
+    "no-backticks": noBackticks,
+    "no-expansions-in-single-quotes": noExpansionsInSingleQuotes,
+    "no-ls-iteration": noLsIteration,
+    "no-unquoted-expansions": noUnquotedExpansions,
+    "no-unused-vars": noUnusedVars,
+    "no-useless-cat": noUselessCat,
+    "no-useless-echo": noUselessEcho,
+    "no-variables-in-printf-format": noVariablesInPrintfFormat,
+    "require-cd-guard": requireCdGuard,
+    "require-read-r": requireReadR,
+};
+const plugin = {
+    meta: {
+        name: "@eslint/shell",
+        namespace: "shell",
+        version: "0.1.2", // x-release-please-version
+    },
+    languages: {
+        bash: new ShellLanguage({ mode: "bash" }),
+        posix: new ShellLanguage({ mode: "posix" }),
+        mksh: new ShellLanguage({ mode: "mksh" }),
+    },
+    rules,
+    configs: {
+        recommended: {
+            name: "shell/recommended",
+            files: ["**/*.sh", "**/*.bash"],
+            language: "shell/bash",
+            plugins: {},
+            rules: {
+                "shell/no-backticks": "error",
+                "shell/no-expansions-in-single-quotes": "warn",
+                "shell/no-ls-iteration": "error",
+                "shell/no-unquoted-expansions": "error",
+                "shell/no-unused-vars": "error",
+                "shell/no-useless-cat": "error",
+                "shell/no-useless-echo": "error",
+                "shell/no-variables-in-printf-format": "error",
+                "shell/require-cd-guard": "error",
+                "shell/require-read-r": "error",
+            },
+        },
+    },
+};
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+// The recommended config must reference the plugin itself.
+Object.assign(plugin.configs.recommended.plugins, { shell: plugin });
+export default plugin;
+export { ShellLanguage } from "./languages/shell-language.js";
+export { ShellSourceCode } from "./languages/shell-source-code.js";
+export { parseShell, ShellSyntaxError } from "./parser/parse.js";
+export { visitorKeys } from "./visitor-keys.js";

package/dist/languages/shell-language.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @fileoverview The ShellLanguage class, the ESLint Language implementation
+ * for shell scripts.
+ */
+import type { File, Language, OkParseResult, ParseResult } from "@eslint/core";
+import { ShellSourceCode } from "./shell-source-code.js";
+import type { ShellLanguageOptions, ShellNode, ShellVariant, CommentNode, ProgramNode } from "../types.js";
+export interface ShellLanguageConstructorOptions {
+    /** The shell dialect to parse. Defaults to `"bash"`. */
+    mode?: ShellVariant;
+}
+export type ShellOkParseResult = OkParseResult<ProgramNode> & {
+    comments: CommentNode[];
+};
+/**
+ * ESLint Language implementation for shell scripts. Each instance parses
+ * one shell dialect, chosen by the `mode` constructor option.
+ */
+export declare class ShellLanguage implements Language<{
+    LangOptions: ShellLanguageOptions;
+    Code: ShellSourceCode;
+    RootNode: ProgramNode;
+    Node: ShellNode;
+}> {
+    #private;
+    fileType: "text";
+    lineStart: 1;
+    columnStart: 1;
+    nodeTypeKey: string;
+    visitorKeys: Record<string, string[]>;
+    defaultLanguageOptions: ShellLanguageOptions;
+    constructor({ mode }?: ShellLanguageConstructorOptions);
+    validateLanguageOptions(): void;
+    parse(file: File): ParseResult<ProgramNode>;
+    createSourceCode(file: File, parseResult: ShellOkParseResult): ShellSourceCode;
+}

package/dist/languages/shell-language.js

@@ -0,0 +1,72 @@
+/**
+ * @fileoverview The ShellLanguage class, the ESLint Language implementation
+ * for shell scripts.
+ */
+import { ShellSyntaxError, parseShell } from "../parser/parse.js";
+import { ShellSourceCode } from "./shell-source-code.js";
+import { visitorKeys } from "../visitor-keys.js";
+const SHELL_MODES = new Set(["bash", "posix", "mksh"]);
+/**
+ * ESLint Language implementation for shell scripts. Each instance parses
+ * one shell dialect, chosen by the `mode` constructor option.
+ */
+export class ShellLanguage {
+    fileType = "text";
+    lineStart = 1;
+    columnStart = 1;
+    nodeTypeKey = "type";
+    visitorKeys = visitorKeys;
+    defaultLanguageOptions = {};
+    #mode;
+    constructor({ mode = "bash" } = {}) {
+        if (!SHELL_MODES.has(mode)) {
+            throw new TypeError(`Invalid shell mode "${String(mode)}". Expected "bash", "posix", or "mksh".`);
+        }
+        this.#mode = mode;
+    }
+    validateLanguageOptions() {
+        // There are no language options to validate.
+    }
+    parse(file) {
+        const text = file.body;
+        try {
+            const { ast, comments } = parseShell(text, {
+                variant: this.#mode,
+                path: file.path,
+            });
+            return { ok: true, ast, comments };
+        }
+        catch (error) {
+            if (error instanceof ShellSyntaxError) {
+                return {
+                    ok: false,
+                    errors: [
+                        {
+                            message: error.message,
+                            line: error.line,
+                            column: error.column,
+                        },
+                    ],
+                };
+            }
+            return {
+                ok: false,
+                errors: [
+                    {
+                        message: error instanceof Error
+                            ? error.message
+                            : String(error),
+                        line: 1,
+                        column: 1,
+                    },
+                ],
+            };
+        }
+    }
+    createSourceCode(file, parseResult) {
+        return new ShellSourceCode({
+            text: file.body,
+            ast: parseResult.ast,
+        });
+    }
+}