@voxframeworks/linetools 1.0.2 → 1.0.5

package/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "liveServer.settings.port": 5501
+}

package/main.js

@@ -4,11 +4,13 @@ const touch = require('./tools/touch.js');
 const mv = require('./tools/mv.js');
 const tar = require('./tools/tar.js');
 const rmdir = require('./tools/rmdir.js');
+const chmod = require('./tools/chmod.js');
 module.exports = {
     mkdir : mkdir,
     cp : cp,
     touch : touch,
     mv : mv,
     rmdir : rmdir,
-    tar : tar
+    tar : tar,
+    chmod : chmod
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voxframeworks/linetools",
-  "version": "1.0.2",
+  "version": "1.0.5",
   "description": "command line tools for js",
   "main": "main.js",
   "scripts": {

package/readme.md

@@ -29,6 +29,11 @@ TestOut = Directory for the zip to be put in
 rezip = zip
 unzip = unzip
 ------------------
+Chmod tips:
+7 = read, write, execute
+5 = read, execute
+0 = none
+------------------
 We will be adding more soon!
 
 By VoxFrameworks

package/test.js

@@ -1,2 +1,3 @@
 const linetools = require('linetools');
 linetools.tar('testOUT', 'testDir', 'rezip')
+linetools.chmod('testDir', '755')

package/tools/chmod.js

@@ -0,0 +1,122 @@
+// lib/chmod.js
+/**
+ * Change the permissions of a file or directory.
+ *
+ * @param {string} targetPath               – Path to file or directory.
+ * @param {string|number} mode              – Permission bits.
+ *                                            * If a string: interpreted as octal (e.g. '755')
+ *                                            * If a number: used directly (e.g. 0o755)
+ * @param {object} [options]                – Optional flags.
+ * @param {boolean} [options.recursive]    – If true and target is a directory,
+ *                                            change permissions of every descendant.
+ *
+ * @returns {Promise<void>}
+ *
+ * @example
+ * // change a single file
+ * await chmod('tmp/foo.txt', '644');
+ *
+ * // change a folder recursively
+ * await chmod('tmp/myDir', 0o755, { recursive: true });
+ */
+const { promises: fs } = require('fs');
+const path = require('path');
+
+/**
+ * Convert a user‑provided mode to a proper numeric value.
+ * Accepts:
+ *   • string like "755", "0644", "0o777"
+ *   • number (already a mode)
+ */
+function normalizeMode(mode) {
+  if (typeof mode === 'number') return mode; // already numeric
+  if (typeof mode !== 'string')
+    throw new TypeError('Mode must be a string or a number');
+
+  // Strip common prefixes (0o, 0, etc.) and parse as octal.
+  const clean = mode.replace(/^0o?/, '');
+  const parsed = parseInt(clean, 8);
+  if (Number.isNaN(parsed))
+    throw new Error(`Invalid permission mode: "${mode}"`);
+  return parsed;
+}
+
+/**
+ * Recursively walk a directory tree and collect *all* entries (files + dirs).
+ * Returns an array of absolute paths.
+ */
+async function walkRecursively(dir) {
+  const result = [];
+
+  async function walk(current) {
+    const entries = await fs.readdir(current, { withFileTypes: true });
+    for (const entry of entries) {
+      const full = path.join(current, entry.name);
+      result.push(full);
+      if (entry.isDirectory()) await walk(full);
+    }
+  }
+
+  await walk(dir);
+  return result;
+}
+
+/**
+ * The public API – async function.
+ */
+async function chmod(targetPath, mode, options = {}) {
+  const normalizedMode = normalizeMode(mode);
+  const { recursive = false } = options;
+
+  // Verify the target exists first – otherwise `fs.chmod` would throw a less‑friendly ENOENT.
+  let stats;
+  try {
+    stats = await fs.lstat(targetPath);
+  } catch (err) {
+    throw new Error(`Path does not exist: ${targetPath}`);
+  }
+
+  // --------------------------------------------------------------
+  // 1️⃣  Non‑recursive case (file OR directory)
+  // --------------------------------------------------------------
+  if (!recursive) {
+    await fs.chmod(targetPath, normalizedMode);
+    return;
+  }
+
+  // --------------------------------------------------------------
+  // 2️⃣  Recursive case – target must be a directory
+  // --------------------------------------------------------------
+  if (!stats.isDirectory())
+    throw new Error(
+      `Recursive chmod can only be used on directories. "${targetPath}" is not a directory.`
+    );
+
+  // Change the *directory* itself first (so it matches the children afterwards)
+  await fs.chmod(targetPath, normalizedMode);
+
+  // Walk the tree and chmod everything we find.
+  const allPaths = await walkRecursively(targetPath);
+
+  // Use `Promise.all` but limit concurrency a bit to avoid overwhelming the FS on huge trees.
+  const MAX_CONCURRENT = 100;
+  const queue = [...allPaths];
+  const workers = Array.from({ length: MAX_CONCURRENT }, async () => {
+    while (queue.length) {
+      const p = queue.pop();
+      try {
+        await fs.chmod(p, normalizedMode);
+      } catch (e) {
+        // We *continue* on errors so the rest of the tree still gets processed.
+        console.warn(`⚠️  Could not chmod "${p}": ${e.message}`);
+      }
+    }
+  });
+
+  await Promise.all(workers);
+}
+
+/* ------------------------------------------------------------------ */
+/* Export for the public API                                            */
+/* ------------------------------------------------------------------ */
+module.exports = chmod;