fix(*): drop shx and replace it with Node.js native script (#402)

This pull request refactors the handling of file permissions across
three packages (`clang-format-git-python`, `clang-format-git`, and
`clang-format-node`) by replacing the use of the `shx` dependency with
custom `chmod.js` scripts. These scripts ensure that the necessary files
and binaries have the correct execution permissions. Additionally, the
`postinstall` and `postbuild` scripts are updated to use these new
`chmod.js` files, and the `shx` dependency is removed.

### File Permission Handling Updates:
*
[`packages/clang-format-git-python/chmod.js`](diffhunk://#diff-27b69f71118a60e9a2ad54a11e79e10b8485e6080af45ec037ee193fd598c77cR1-R26):
Added a script to set execution permissions for the `git-clang-format`
script using `chmodSync`.
*
[`packages/clang-format-git/chmod.js`](diffhunk://#diff-337db8b3485bbb276d0c1b16655b094b11cf7605b7adc8e52a4b3f06d0e9edabR1-R33):
Added a script to set execution permissions for binaries in the `bin`
directory, filtering for files containing `git-clang-format`.
*
[`packages/clang-format-node/chmod.js`](diffhunk://#diff-36fbb1ea12298f23d64d479606f6b239ed8a2ca3373684dbd49b5037f16bbfe6R1-R36):
Added a script to set execution permissions for binaries in the `bin`
directory, filtering for files containing `clang-format`.

### Package Configuration Updates:
*
[`packages/clang-format-git-python/package.json`](diffhunk://#diff-fb0eb5dba5b2656b3fdea4322c2ed2a691973f2e9ea536ce20b36c347ab1267eR9):
Added `chmod.js` to the `files` array, replaced `npm run chmod` with
`node chmod.js` in the `postinstall` script, and removed the `shx`
dependency.
[[1]](diffhunk://#diff-fb0eb5dba5b2656b3fdea4322c2ed2a691973f2e9ea536ce20b36c347ab1267eR9)
[[2]](diffhunk://#diff-fb0eb5dba5b2656b3fdea4322c2ed2a691973f2e9ea536ce20b36c347ab1267eL52-R61)
*
[`packages/clang-format-git/package.json`](diffhunk://#diff-d85dcfb0934f579cff896723ab5eeb9a52668d2bb322338dddd93bc1241aa4f1R9):
Added `chmod.js` to the `files` array, replaced `npm run chmod` with
`node chmod.js` in the `postinstall` script, and removed the `shx`
dependency.
[[1]](diffhunk://#diff-d85dcfb0934f579cff896723ab5eeb9a52668d2bb322338dddd93bc1241aa4f1R9)
[[2]](diffhunk://#diff-d85dcfb0934f579cff896723ab5eeb9a52668d2bb322338dddd93bc1241aa4f1L51-R60)
*
[`packages/clang-format-node/package.json`](diffhunk://#diff-6e04d643c57b851ab02ad78e41531387d2cc01caf6c4cfbaa536aadd37346a30R9):
Added `chmod.js` to the `files` array, replaced `npm run chmod` with
`node chmod.js` in the `postinstall` script, and removed the `shx`
dependency.
[[1]](diffhunk://#diff-6e04d643c57b851ab02ad78e41531387d2cc01caf6c4cfbaa536aadd37346a30R9)
[[2]](diffhunk://#diff-6e04d643c57b851ab02ad78e41531387d2cc01caf6c4cfbaa536aadd37346a30L50-L60)

Author: lumirlumir

package-lock.json

@@ -0,0 +1,26 @@
+/**
+ * @fileoverview Script to change permissions of a script.
+ */
+
+/* eslint-disable n/prefer-node-protocol -- DO NOT USE `node:` namespace for backward compatibility */
+
+// --------------------------------------------------------------------------------
+// Require
+// --------------------------------------------------------------------------------
+
+const { resolve } = require('path');
+const { chmodSync } = require('fs');
+
+// --------------------------------------------------------------------------------
+// Execution
+// --------------------------------------------------------------------------------
+
+const scriptPath = resolve(__dirname, 'script', 'git-clang-format');
+
+try {
+  chmodSync(scriptPath, 0o755);
+} catch (error) {
+  // eslint-disable-next-line no-console
+  console.error(`Error changing permissions for ${scriptPath}:`, error.message);
+  throw error;
+}

packages/clang-format-git-python/chmod.js

@@ -6,6 +6,7 @@
   "files": [
     "build",
     "script",
+    "chmod.js",
     "LICENSE.md",
     "README.md"
   ],
@@ -49,17 +50,14 @@
     "provenance": true
   },
   "scripts": {
-    "postinstall": "npm run chmod",
+    "postinstall": "node chmod.js || exit 0",
     "prepublishOnly": "npm run build",
     "build": "npx babel src -d build && npx tsc && node ../../scripts/cp.mjs ../../LICENSE.md LICENSE.md ../../README.md README.md",
-    "postbuild": "npm run chmod",
     "test": "node --test",
-    "chmod": "shx chmod 755 ./script/**/* || exit 0",
     "dev": "node src/cli.js",
     "start": "node build/cli.js"
   },
   "dependencies": {
-    "clang-format-node": "^1.3.4",
-    "shx": "^0.4.0"
+    "clang-format-node": "^1.3.4"
   }
 }

packages/clang-format-git-python/package.json

@@ -0,0 +1,33 @@
+/**
+ * @fileoverview Script to change permissions of binaries.
+ */
+
+/* eslint-disable n/prefer-node-protocol -- DO NOT USE `node:` namespace for backward compatibility */
+
+// --------------------------------------------------------------------------------
+// Require
+// --------------------------------------------------------------------------------
+
+const { resolve } = require('path');
+const { chmodSync, readdirSync } = require('fs');
+
+// --------------------------------------------------------------------------------
+// Execution
+// --------------------------------------------------------------------------------
+
+const binPath = resolve(__dirname, 'bin');
+const clangFormatGitPaths = readdirSync(binPath, {
+  recursive: true,
+})
+  .filter(path => path.includes('git-clang-format'))
+  .map(path => resolve(binPath, path));
+
+clangFormatGitPaths.forEach(clangFormatGitPath => {
+  try {
+    chmodSync(clangFormatGitPath, 0o755);
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.error(`Error changing permissions for ${clangFormatGitPath}:`, error.message);
+    throw error;
+  }
+});

packages/clang-format-git/chmod.js

@@ -6,6 +6,7 @@
   "files": [
     "bin",
     "build",
+    "chmod.js",
     "LICENSE.md",
     "README.md"
   ],
@@ -48,17 +49,14 @@
     "provenance": true
   },
   "scripts": {
-    "postinstall": "npm run chmod",
+    "postinstall": "node chmod.js || exit 0",
     "prepublishOnly": "npm run build",
     "build": "npx babel src -d build && npx tsc && node ../../scripts/cp.mjs ../../LICENSE.md LICENSE.md ../../README.md README.md",
-    "postbuild": "npm run chmod",
     "test": "node --test",
-    "chmod": "shx chmod 755 ./bin/**/* || exit 0",
     "dev": "node src/cli.js",
     "start": "node build/cli.js"
   },
   "dependencies": {
-    "clang-format-node": "^1.3.4",
-    "shx": "^0.4.0"
+    "clang-format-node": "^1.3.4"
   }
 }

packages/clang-format-git/package.json

@@ -0,0 +1,36 @@
+/**
+ * @fileoverview Script to change permissions of binaries.
+ */
+
+/* eslint-disable n/prefer-node-protocol -- DO NOT USE `node:` namespace for backward compatibility */
+
+// --------------------------------------------------------------------------------
+// Require
+// --------------------------------------------------------------------------------
+
+const { resolve } = require('path');
+const { chmodSync, readdirSync } = require('fs');
+
+// --------------------------------------------------------------------------------
+// Execution
+// --------------------------------------------------------------------------------
+
+const binPath = resolve(__dirname, 'bin');
+const clangFormatNodePaths = readdirSync(binPath, {
+  recursive: true,
+})
+  .filter(path => path.includes('clang-format'))
+  .map(path => resolve(binPath, path));
+
+clangFormatNodePaths.forEach(clangFormatNodePath => {
+  try {
+    chmodSync(clangFormatNodePath, 0o755);
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.error(
+      `Error changing permissions for ${clangFormatNodePath}:`,
+      error.message,
+    );
+    throw error;
+  }
+});

packages/clang-format-node/chmod.js

@@ -6,6 +6,7 @@
   "files": [
     "bin",
     "build",
+    "chmod.js",
     "LICENSE.md",
     "README.md"
   ],
@@ -47,16 +48,11 @@
     "provenance": true
   },
   "scripts": {
-    "postinstall": "npm run chmod",
+    "postinstall": "node chmod.js || exit 0",
     "prepublishOnly": "npm run build",
     "build": "npx babel src -d build && npx tsc && node ../../scripts/cp.mjs ../../LICENSE.md LICENSE.md ../../README.md README.md",
-    "postbuild": "npm run chmod",
     "test": "node --test",
-    "chmod": "shx chmod 755 ./bin/**/* || exit 0",
     "dev": "node src/cli.js",
     "start": "node build/cli.js"
-  },
-  "dependencies": {
-    "shx": "^0.4.0"
   }
 }

packages/clang-format-node/package.json

@@ -32,8 +32,8 @@ features:
     linkText: Migration Guide
 
   - icon: '<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 448 512" height="32px" width="32px" xmlns="http://www.w3.org/2000/svg"><path d="M224 508c-6.7 0-13.5-1.8-19.4-5.2l-61.7-36.5c-9.2-5.2-4.7-7-1.7-8 12.3-4.3 14.8-5.2 27.9-12.7 1.4-.8 3.2-.5 4.6.4l47.4 28.1c1.7 1 4.1 1 5.7 0l184.7-106.6c1.7-1 2.8-3 2.8-5V149.3c0-2.1-1.1-4-2.9-5.1L226.8 37.7c-1.7-1-4-1-5.7 0L36.6 144.3c-1.8 1-2.9 3-2.9 5.1v213.1c0 2 1.1 4 2.9 4.9l50.6 29.2c27.5 13.7 44.3-2.4 44.3-18.7V167.5c0-3 2.4-5.3 5.4-5.3h23.4c2.9 0 5.4 2.3 5.4 5.3V378c0 36.6-20 57.6-54.7 57.6-10.7 0-19.1 0-42.5-11.6l-48.4-27.9C8.1 389.2.7 376.3.7 362.4V149.3c0-13.8 7.4-26.8 19.4-33.7L204.6 9c11.7-6.6 27.2-6.6 38.8 0l184.7 106.7c12 6.9 19.4 19.8 19.4 33.7v213.1c0 13.8-7.4 26.7-19.4 33.7L243.4 502.8c-5.9 3.4-12.6 5.2-19.4 5.2zm149.1-210.1c0-39.9-27-50.5-83.7-58-57.4-7.6-63.2-11.5-63.2-24.9 0-11.1 4.9-25.9 47.4-25.9 37.9 0 51.9 8.2 57.7 33.8.5 2.4 2.7 4.2 5.2 4.2h24c1.5 0 2.9-.6 3.9-1.7s1.5-2.6 1.4-4.1c-3.7-44.1-33-64.6-92.2-64.6-52.7 0-84.1 22.2-84.1 59.5 0 40.4 31.3 51.6 81.8 56.6 60.5 5.9 65.2 14.8 65.2 26.7 0 20.6-16.6 29.4-55.5 29.4-48.9 0-59.6-12.3-63.2-36.6-.4-2.6-2.6-4.5-5.3-4.5h-23.9c-3 0-5.3 2.4-5.3 5.3 0 31.1 16.9 68.2 97.8 68.2 58.4-.1 92-23.2 92-63.4z"></path></svg>'
-    title: Use only Node.js, no other dependencies needed
-    details: No need for Python or C++. Just use Node.js with no additional dependencies required.
+    title: Zero dependencies
+    details: No need for Python, C++, or any npm sub-dependencies. Just use Node.js alone, with no extra dependencies.
     link: /docs/get-started/installation
     linkText: Installation