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

Author: JounQin

.changeset/large-bananas-tease.md

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

.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

.github/workflows/ci.yml

@@ -14,7 +14,6 @@ jobs:
     strategy:
       matrix:
         node:
-          - 18
           - 20
           - 22
           - 24

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"

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",

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
 "

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]
 

packages/sh/test/fixtures/.env.development

@@ -0,0 +1 @@
+VITE_API_BASE_URL=      /api

packages/sh/test/fixtures/.husky/precommit

@@ -0,0 +1,2 @@
+yarn    \
+  lint

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": {