@eslint/shell 0.1.0 → 0.1.2

package/README.md

@@ -22,20 +22,26 @@ Requires Node.js `^20.19.0 || ^22.13.0 || >=24`. Tested with ESLint v10.
 Add the plugin to your `eslint.config.js`:
 
 ```js
+import { defineConfig } from "eslint/config";
 import shell from "@eslint/shell";
 
-export default [
-	// use the recommended rules for *.sh and *.bash files
-	shell.configs.recommended,
-];
+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 [
+export default defineConfig([
 	{
 		files: ["**/*.sh"],
 		plugins: { shell },
@@ -45,7 +51,7 @@ export default [
 			"shell/no-unquoted-expansions": "error",
 		},
 	},
-];
+]);
 ```
 
 ### Languages
@@ -59,14 +65,17 @@ The plugin provides one language per shell dialect:
 | `shell/mksh`  | MirBSD Korn shell.                    |
 
 ```js
-export default [
+import { defineConfig } from "eslint/config";
+import shell from "@eslint/shell";
+
+export default defineConfig([
 	{
 		files: ["**/*.sh"],
 		plugins: { shell },
+		extends: ["shell/recommended"],
 		language: "shell/posix",
-		rules: { "shell/no-backticks": "error" },
 	},
-];
+]);
 ```
 
 ## Rules
@@ -143,13 +152,14 @@ 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://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="#"><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>

package/dist/index.js

@@ -33,7 +33,7 @@ const plugin = {
     meta: {
         name: "@eslint/shell",
         namespace: "shell",
-        version: "0.1.0", // x-release-please-version
+        version: "0.1.2", // x-release-please-version
     },
     languages: {
         bash: new ShellLanguage({ mode: "bash" }),

package/dist/rules/no-backticks.d.ts

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to disallow legacy backtick command substitution.
- * Mirrors ShellCheck SC2006.
  */
 import type { ShellRuleDefinition } from "../types.js";
 declare const rule: ShellRuleDefinition<{

package/dist/rules/no-backticks.js

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to disallow legacy backtick command substitution.
- * Mirrors ShellCheck SC2006.
  */
 //------------------------------------------------------------------------------
 // Rule Definition
@@ -16,7 +15,7 @@ const rule = {
         fixable: "code",
         schema: [],
         messages: {
-            useDollarParen: "Use $(...) notation instead of legacy backticks. (ShellCheck SC2006)",
+            useDollarParen: "Use $(...) notation instead of legacy backticks.",
         },
     },
     create(context) {

package/dist/rules/no-expansions-in-single-quotes.d.ts

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to flag expansion-like text inside single quotes.
- * Mirrors ShellCheck SC2016.
  */
 import type { ShellRuleDefinition } from "../types.js";
 declare const rule: ShellRuleDefinition<{

package/dist/rules/no-expansions-in-single-quotes.js

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to flag expansion-like text inside single quotes.
- * Mirrors ShellCheck SC2016.
  */
 //------------------------------------------------------------------------------
 // Helpers
@@ -24,7 +23,7 @@ const rule = {
         },
         schema: [],
         messages: {
-            expansionInSingleQuotes: "Expressions don't expand in single quotes; use double quotes for that. (ShellCheck SC2016)",
+            expansionInSingleQuotes: "Expressions don't expand in single quotes; use double quotes for that.",
         },
     },
     create(context) {

package/dist/rules/no-ls-iteration.d.ts

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to disallow iterating over `ls` output.
- * Mirrors ShellCheck SC2045.
  */
 import type { ShellRuleDefinition } from "../types.js";
 declare const rule: ShellRuleDefinition<{

package/dist/rules/no-ls-iteration.js

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to disallow iterating over `ls` output.
- * Mirrors ShellCheck SC2045.
  */
 //------------------------------------------------------------------------------
 // Imports
@@ -19,7 +18,7 @@ const rule = {
         },
         schema: [],
         messages: {
-            lsIteration: "Iterating over ls output is fragile. Use globs (e.g. *) instead. (ShellCheck SC2045)",
+            lsIteration: "Iterating over ls output is fragile. Use globs (e.g. *) instead.",
         },
     },
     create(context) {

package/dist/rules/no-unquoted-expansions.d.ts

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to require quoting expansions that undergo word
- * splitting and globbing. Mirrors ShellCheck SC2086/SC2046.
+ * splitting and globbing.
  */
 import type { ShellRuleDefinition } from "../types.js";
 declare const rule: ShellRuleDefinition<{

package/dist/rules/no-unquoted-expansions.js

@@ -1,6 +1,6 @@
 /**
  * @fileoverview Rule to require quoting expansions that undergo word
- * splitting and globbing. Mirrors ShellCheck SC2086/SC2046.
+ * splitting and globbing.
  */
 import { startsWithCommand } from "./utils.js";
 //------------------------------------------------------------------------------
@@ -27,8 +27,8 @@ const rule = {
         fixable: "code",
         schema: [],
         messages: {
-            unquotedParameterExpansion: 'Double quote "{{expansion}}" to prevent word splitting and globbing. (ShellCheck SC2086)',
-            unquotedCommandSubstitution: "Quote this command substitution to prevent word splitting. (ShellCheck SC2046)",
+            unquotedParameterExpansion: 'Double quote "{{expansion}}" to prevent word splitting and globbing.',
+            unquotedCommandSubstitution: "Quote this command substitution to prevent word splitting.",
         },
     },
     create(context) {

package/dist/rules/no-unused-vars.d.ts

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to flag variables that are assigned but never used.
- * Mirrors ShellCheck SC2034.
  */
 import type { ShellRuleDefinition } from "../types.js";
 declare const rule: ShellRuleDefinition<{

package/dist/rules/no-unused-vars.js

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to flag variables that are assigned but never used.
- * Mirrors ShellCheck SC2034.
  */
 //------------------------------------------------------------------------------
 // Imports
@@ -81,7 +80,7 @@ const rule = {
         ],
         defaultOptions: [{}],
         messages: {
-            unusedVariable: "Variable '{{name}}' is assigned but never used. (ShellCheck SC2034)",
+            unusedVariable: "Variable '{{name}}' is assigned but never used.",
         },
     },
     create(context) {

package/dist/rules/no-useless-cat.d.ts

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to disallow piping from a single-file `cat`.
- * Mirrors ShellCheck SC2002.
  */
 import type { ShellRuleDefinition } from "../types.js";
 declare const rule: ShellRuleDefinition<{

package/dist/rules/no-useless-cat.js

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to disallow piping from a single-file `cat`.
- * Mirrors ShellCheck SC2002.
  */
 //------------------------------------------------------------------------------
 // Imports
@@ -42,7 +41,7 @@ const rule = {
         },
         schema: [],
         messages: {
-            uselessCat: "Useless cat. Consider 'cmd < file' or 'cmd file' instead. (ShellCheck SC2002)",
+            uselessCat: "Useless cat. Consider 'cmd < file' or 'cmd file' instead.",
         },
     },
     create(context) {

package/dist/rules/no-useless-echo.d.ts

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to disallow `$(echo ...)` command substitutions.
- * Mirrors ShellCheck SC2116.
  */
 import type { ShellRuleDefinition } from "../types.js";
 declare const rule: ShellRuleDefinition<{

package/dist/rules/no-useless-echo.js

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to disallow `$(echo ...)` command substitutions.
- * Mirrors ShellCheck SC2116.
  */
 //------------------------------------------------------------------------------
 // Imports
@@ -19,7 +18,7 @@ const rule = {
         },
         schema: [],
         messages: {
-            uselessEcho: "Useless echo? Instead of 'cmd $(echo foo)', just use 'cmd foo'. (ShellCheck SC2116)",
+            uselessEcho: "Useless echo? Instead of 'cmd $(echo foo)', just use 'cmd foo'.",
         },
     },
     create(context) {

package/dist/rules/no-variables-in-printf-format.d.ts

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to disallow variables in the printf format string.
- * Mirrors ShellCheck SC2059.
  */
 import type { ShellRuleDefinition } from "../types.js";
 declare const rule: ShellRuleDefinition<{

package/dist/rules/no-variables-in-printf-format.js

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to disallow variables in the printf format string.
- * Mirrors ShellCheck SC2059.
  */
 //------------------------------------------------------------------------------
 // Imports
@@ -19,7 +18,7 @@ const rule = {
         },
         schema: [],
         messages: {
-            variableInFormat: "Don't use variables in the printf format string. Use printf '...%s...' \"$foo\". (ShellCheck SC2059)",
+            variableInFormat: "Don't use variables in the printf format string. Use printf '...%s...' \"$foo\".",
         },
     },
     create(context) {

package/dist/rules/require-cd-guard.d.ts

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to require handling `cd` failure.
- * Mirrors ShellCheck SC2164.
  */
 import type { ShellRuleDefinition } from "../types.js";
 declare const rule: ShellRuleDefinition<{

package/dist/rules/require-cd-guard.js

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to require handling `cd` failure.
- * Mirrors ShellCheck SC2164.
  */
 //------------------------------------------------------------------------------
 // Imports
@@ -20,7 +19,7 @@ const rule = {
         hasSuggestions: true,
         schema: [],
         messages: {
-            uncheckedCd: "Use 'cd ... || exit' or 'cd ... || return' in case cd fails. (ShellCheck SC2164)",
+            uncheckedCd: "Use 'cd ... || exit' or 'cd ... || return' in case cd fails.",
             addGuard: "Add '|| exit' after the cd command.",
         },
     },

package/dist/rules/require-read-r.d.ts

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to require the `-r` flag when using `read`.
- * Mirrors ShellCheck SC2162.
  */
 import type { ShellRuleDefinition } from "../types.js";
 declare const rule: ShellRuleDefinition<{

package/dist/rules/require-read-r.js

@@ -1,6 +1,5 @@
 /**
  * @fileoverview Rule to require the `-r` flag when using `read`.
- * Mirrors ShellCheck SC2162.
  */
 //------------------------------------------------------------------------------
 // Imports
@@ -24,7 +23,7 @@ const rule = {
         fixable: "code",
         schema: [],
         messages: {
-            missingR: "read without -r will mangle backslashes. (ShellCheck SC2162)",
+            missingR: "Using read without -r will mangle backslashes.",
         },
     },
     create(context) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint/shell",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Shell language plugin for ESLint",
   "license": "Apache-2.0",
   "type": "module",
@@ -66,6 +66,7 @@
     "@types/node": "~20.19.0",
     "@vitest/coverage-v8": "^4.1.10",
     "eslint": "^10.8.1",
+    "eslint-plugin-eslint-plugin": "^7.6.2",
     "lint-staged": "^16.4.0",
     "prettier": "^3.9.6",
     "typescript": "^6.0.3",