feat(prettier-plugin-sh): better support for dotenv and husky files out of box (#479)

JounQin · web-flow · commit a607eefef983 · 2025-06-26T12:03:13.000+08:00
diff --git a/.changeset/large-bananas-tease.md b/.changeset/large-bananas-tease.md
@@ -0,0 +1,5 @@
+---
+"prettier-plugin-sh": minor
+---
+
+feat: better support for `dotenv` and `husky` files out of box
diff --git a/.github/workflows/autofix.yml b/.github/workflows/autofix.yml
@@ -31,6 +31,6 @@ jobs:
         run: yarn run-s build format
 
       - name: Apply autofix.ci
-        uses: autofix-ci/action@2891949f3779a1cafafae1523058501de3d4e944 # v1
+        uses: autofix-ci/action@635ffb0c9798bd160680f18fd73371e355b85f27 # v1.3.2
         with:
           fail-fast: false
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -14,7 +14,6 @@ jobs:
     strategy:
       matrix:
         node:
-          - 18
           - 20
           - 22
           - 24
diff --git a/package.json b/package.json
@@ -33,30 +33,31 @@
   },
   "devDependencies": {
     "@1stg/browserslist-config": "^2.1.4",
-    "@1stg/common-config": "^14.0.0",
+    "@1stg/common-config": "^14.2.0",
     "@1stg/postcss-config": "^6.1.0",
     "@changesets/changelog-github": "^0.5.1",
-    "@changesets/cli": "^2.29.4",
+    "@changesets/cli": "^2.29.5",
     "@commitlint/cli": "^19.8.1",
     "@mdx-js/rollup": "^3.1.0",
     "@pkgr/rollup": "^7.0.0",
-    "@shikijs/rehype": "^3.5.0",
-    "@stylistic/eslint-plugin": "^4.4.1",
-    "@types/node": "^22.15.29",
-    "@types/react": "^19.1.6",
+    "@shikijs/rehype": "^3.7.0",
+    "@stylistic/eslint-plugin": "^5.0.0",
+    "@types/node": "^22.15.33",
+    "@types/react": "^19.1.8",
     "@types/react-dom": "^19.1.6",
-    "@types/web": "^0.0.239",
-    "@vitejs/plugin-react-swc": "^3.10.1",
-    "@vitest/coverage-istanbul": "^3.2.1",
-    "@vitest/eslint-plugin": "^1.2.1",
+    "@types/serialize-javascript": "^5.0.4",
+    "@types/web": "^0.0.243",
+    "@vitejs/plugin-react-swc": "^3.10.2",
+    "@vitest/coverage-istanbul": "^3.2.4",
+    "@vitest/eslint-plugin": "^1.2.7",
     "clean-pkg-json": "^1.3.0",
-    "eslint": "^9.28.0",
+    "eslint": "^9.29.0",
     "eslint-plugin-tsdoc": "^0.4.0",
     "github-markdown-css": "^5.8.1",
     "linguist-languages": "^8.0.0",
     "nano-staged": "^0.8.0",
     "npm-run-all2": "^8.0.4",
-    "prettier": "^3.5.3",
+    "prettier": "^3.6.1",
     "prettier-plugin-autocorrect": "workspace:*",
     "prettier-plugin-pkg": "workspace:*",
     "prettier-plugin-sh": "workspace:*",
@@ -68,24 +69,26 @@
     "rehype-slug": "^6.0.0",
     "remark-gfm": "^4.0.1",
     "rimraf": "^6.0.1",
+    "serialize-javascript": "^6.0.2",
     "simple-git-hooks": "^2.13.0",
     "sirv-cli": "^3.0.1",
     "size-limit": "^11.2.0",
     "size-limit-preset-node-lib": "^0.4.0",
-    "tsx": "^4.19.4",
+    "tsx": "^4.20.3",
     "type-coverage": "^2.29.7",
     "typescript": "^5.8.3",
-    "vite": "^6.3.5",
-    "vitest": "^3.2.1",
+    "vite": "^7.0.0",
+    "vitest": "^3.2.4",
     "yarn-berry-deduplicate": "^6.1.3"
   },
   "resolutions": {
-    "prettier": "^3.5.3",
+    "prettier": "^3.6.1",
     "prettier-plugin-autocorrect": "workspace:*",
     "prettier-plugin-pkg": "workspace:*",
     "prettier-plugin-sh": "workspace:*",
     "prettier-plugin-sql": "workspace:*",
-    "prettier-plugin-toml": "workspace:*"
+    "prettier-plugin-toml": "workspace:*",
+    "vite": "npm:rolldown-vite@^7.0.1"
   },
   "browserslist": [
     "extends @1stg/browserslist-config/modern"
diff --git a/packages/sh/package.json b/packages/sh/package.json
@@ -43,7 +43,7 @@
     "prepack": "clean-pkg-json"
   },
   "peerDependencies": {
-    "prettier": "^3.0.3"
+    "prettier": "^3.6.0"
   },
   "dependencies": {
     "@reteps/dockerfmt": "^0.3.6",
diff --git a/packages/sh/test/__snapshots__/fixtures.spec.ts.snap b/packages/sh/test/__snapshots__/fixtures.spec.ts.snap
@@ -11,6 +11,17 @@ node_modules
 "
 `;
 
+exports[`parser and printer > should format .env.development fixture correctly 1`] = `
+"VITE_API_BASE_URL= /api
+"
+`;
+
+exports[`parser and printer > should format .husky/precommit fixture correctly 1`] = `
+"yarn \\
+  lint
+"
+`;
+
 exports[`parser and printer > should format .nvmrc fixture correctly 1`] = `
 "v1.2.3
 "
diff --git a/packages/sh/test/fixtures.spec.ts b/packages/sh/test/fixtures.spec.ts
@@ -16,14 +16,25 @@ const PARSER_OPTIONS: Partial<
 describe('parser and printer', () => {
   const fixtures = path.resolve(import.meta.dirname, 'fixtures')
 
-  for (const relativeFilepath of fs.readdirSync(fixtures)) {
-    const filepath = path.resolve(fixtures, relativeFilepath)
+  for (const dirent of fs.readdirSync(fixtures, {
+    recursive: true,
+    withFileTypes: true,
+  })) {
+    if (dirent.isDirectory()) {
+      continue
+    }
+
+    const filepath = path.resolve(dirent.parentPath, dirent.name)
+
+    const relativeFilepath = path
+      .relative(fixtures, filepath)
+      .replaceAll(path.win32.sep, path.posix.sep)
+
     const input = fs.readFileSync(filepath, 'utf8')
 
-    const caseName = relativeFilepath.slice(
-      0,
-      relativeFilepath.lastIndexOf('.'),
-    )
+    const caseName = dirent.name.includes('.')
+      ? relativeFilepath.slice(0, relativeFilepath.lastIndexOf('.'))
+      : relativeFilepath
 
     const overrideOptions = PARSER_OPTIONS[caseName]
 
diff --git a/packages/sh/test/fixtures/.env.development b/packages/sh/test/fixtures/.env.development
@@ -0,0 +1 @@
+VITE_API_BASE_URL=      /api
diff --git a/packages/sh/test/fixtures/.husky/precommit b/packages/sh/test/fixtures/.husky/precommit
@@ -0,0 +1,2 @@
+yarn    \
+  lint
diff --git a/packages/sql/package.json b/packages/sql/package.json
@@ -51,8 +51,8 @@
   },
   "dependencies": {
     "jsox": "^1.2.123",
-    "node-sql-parser": "^5.3.9",
-    "sql-formatter": "^15.6.2",
+    "node-sql-parser": "^5.3.10",
+    "sql-formatter": "^15.6.5",
     "tslib": "^2.8.1"
   },
   "publishConfig": {
diff --git a/packages/sql/test/__snapshots__/fixtures.spec.ts.snap b/packages/sql/test/__snapshots__/fixtures.spec.ts.snap
diff --git a/scripts/languages.ts b/scripts/languages.ts
@@ -1,35 +1,44 @@
 import fs from 'node:fs'
+import path from 'node:path'
 
 import * as linguistLanguages from 'linguist-languages'
 import type { SupportLanguage } from 'prettier'
+import serializeJavascript from 'serialize-javascript'
 
 const EXTRA_SH_LANGUAGES: SupportLanguage[] = [
   {
     name: 'JvmOptions',
-    since: '0.1.0',
     parsers: ['sh'],
     extensions: ['.vmoptions'],
     filenames: ['jvm.options'],
     vscodeLanguageIds: ['jvmoptions'],
   },
   {
     name: 'hosts',
-    since: '0.1.0',
     parsers: ['sh'],
     filenames: ['hosts'],
     vscodeLanguageIds: ['hosts'],
   },
   {
     name: 'dotenv',
-    since: '0.1.0',
     parsers: ['sh'],
     extensions: ['.env'],
-    filenames: ['.env.*'],
     vscodeLanguageIds: ['dotenv'],
+    isSupported({ filepath }) {
+      const basename = path.basename(filepath)
+      return basename === '.env' || basename.startsWith('.env.')
+    },
+  },
+  {
+    name: 'husky',
+    parsers: ['sh'],
+    isSupported({ filepath }) {
+      const dirname = path.dirname(filepath)
+      return path.basename(dirname) === '.husky'
+    },
   },
   {
     name: 'nvmrc',
-    since: '0.14.0',
     parsers: ['sh'],
     extensions: ['.node-version', '.nvmrc'],
     filenames: ['.node-version', '.nvmrc'],
@@ -59,7 +68,6 @@ const getSupportedLanguages = (
       acc.push({
         name,
         aceMode,
-        since: '0.1.0',
         parsers: [parser],
         linguistLanguageId,
         vscodeLanguageIds: [aceMode === 'sh' ? 'shellscript' : aceMode],
@@ -70,63 +78,58 @@ const getSupportedLanguages = (
     [],
   )
 
+const serialize = (input: unknown) =>
+  serializeJavascript(input, { space: 2, unsafe: true })
+
 fs.writeFileSync(
   'packages/autocorrect/src/languages.ts',
   `import type { SupportLanguage } from 'prettier'
 
-export const languages = ${JSON.stringify(
+export const languages = ${serialize(
     getSupportedLanguages('autocorrect', ['all']),
-    null,
-    2,
   )} as SupportLanguage[]`,
 )
 
 fs.writeFileSync(
   'packages/sh/src/languages.ts',
-  `import type { SupportLanguage } from 'prettier'
+  `import path from 'node:path'
+
+  import type { SupportLanguage } from 'prettier'
 
-export const languages = ${JSON.stringify(
-    [
-      ...getSupportedLanguages('dockerfile'),
-      ...getSupportedLanguages(
-        'sh',
-        ['gitignore', 'properties', 'sh'],
-        [
-          /**
-           * `ShellSession` includes both commands and output. We can't reliably
-           * format the latter, so we exclude this language entirely.
-           */
-          'ShellSession',
-        ],
-      ),
-      ...EXTRA_SH_LANGUAGES,
-    ],
-    null,
-    2,
-  )} as SupportLanguage[]
+export const languages = ${serialize([
+    ...getSupportedLanguages('dockerfile'),
+    ...getSupportedLanguages(
+      'sh',
+      ['gitignore', 'properties', 'sh'],
+      [
+        /**
+         * `ShellSession` includes both commands and output. We can't reliably
+         * format the latter, so we exclude this language entirely.
+         */
+        'ShellSession',
+      ],
+    ),
+    ...EXTRA_SH_LANGUAGES,
+  ])} as SupportLanguage[]
 `,
 )
 
 fs.writeFileSync(
   'packages/sql/src/languages.ts',
   `import type { SupportLanguage } from 'prettier'
 
-export const languages = ${JSON.stringify(
-    [...getSupportedLanguages('sql', ['sql', 'pgsql'])],
-    null,
-    2,
-  )} as SupportLanguage[]
+export const languages = ${serialize([
+    ...getSupportedLanguages('sql', ['sql', 'pgsql']),
+  ])} as SupportLanguage[]
 `,
 )
 
 fs.writeFileSync(
   'packages/toml/src/languages.ts',
   `import type { SupportLanguage } from 'prettier'
 
-export const languages = ${JSON.stringify(
-    [...getSupportedLanguages('toml')],
-    null,
-    2,
-  )} as SupportLanguage[]
+export const languages = ${serialize([
+    ...getSupportedLanguages('toml'),
+  ])} as SupportLanguage[]
 `,
 )
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"prettier-plugin-sh": minor
 +---
++
 +feat: better support for `dotenv` and `husky` files out of box