@xiping/node-utils 0.0.30

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023-present, xiping.wang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/lib/index.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Represents a node in a directory tree structure
+ * @interface Tree
+ * @property {string} id - Unique identifier for the node (full path)
+ * @property {string} label - Display name of the file or directory
+ * @property {Tree[]} [children] - Optional array of child nodes for directories
+ */
+export interface Tree {
+    id: string;
+    label: string;
+    children?: Tree[];
+}
+/**
+ * Recursively builds a tree structure from a directory
+ * @param {string} dirPath - The absolute path to the directory to process
+ * @param {string} [basePath] - The base path for generating relative paths (defaults to dirPath)
+ * @returns {Tree} A tree structure representing the directory hierarchy
+ * @throws Will throw an error if directory access fails
+ *
+ * @example
+ * // Create a tree from a directory
+ * const tree = buildDirectoryTree('/path/to/directory');
+ *
+ * // Structure of returned tree:
+ * // {
+ * //   id: '/path/to/directory',
+ * //   label: 'directory',
+ * //   children: [
+ * //     { id: '/path/to/directory/file.txt', label: 'file.txt' },
+ * //     { id: '/path/to/directory/subdir', label: 'subdir', children: [...] }
+ * //   ]
+ * // }
+ */
+export declare function buildDirectoryTree(dirPath: string, basePath?: string): Tree;
+/**
+ * Gets the parent directory path of a given directory path
+ * Cross-platform compatible (Windows, macOS, Linux)
+ * @param {string} dirPath - The path to get the parent directory from
+ * @returns {string} The parent directory path
+ *
+ * @example
+ * // On Unix-like systems (Mac/Linux)
+ * getParentDirectory('/Users/documents/folder') // returns '/Users/documents'
+ *
+ * // On Windows
+ * getParentDirectory('C:\\Users\\Documents\\folder') // returns 'C:\\Users\\Documents'
+ *
+ * // Works with both forward and backward slashes
+ * getParentDirectory('C:/Users/Documents/folder') // returns 'C:/Users/Documents'
+ */
+export declare function getParentDirectory(dirPath: string): string;

package/lib/index.js

@@ -0,0 +1,83 @@
+import { readdirSync, statSync } from "node:fs";
+import { join, dirname, normalize } from "node:path";
+/**
+ * Recursively builds a tree structure from a directory
+ * @param {string} dirPath - The absolute path to the directory to process
+ * @param {string} [basePath] - The base path for generating relative paths (defaults to dirPath)
+ * @returns {Tree} A tree structure representing the directory hierarchy
+ * @throws Will throw an error if directory access fails
+ *
+ * @example
+ * // Create a tree from a directory
+ * const tree = buildDirectoryTree('/path/to/directory');
+ *
+ * // Structure of returned tree:
+ * // {
+ * //   id: '/path/to/directory',
+ * //   label: 'directory',
+ * //   children: [
+ * //     { id: '/path/to/directory/file.txt', label: 'file.txt' },
+ * //     { id: '/path/to/directory/subdir', label: 'subdir', children: [...] }
+ * //   ]
+ * // }
+ */
+export function buildDirectoryTree(dirPath, basePath = dirPath) {
+    const stats = statSync(dirPath);
+    const relativePath = dirPath.replace(basePath, "").replace(/^\//, "") || "/";
+    const fileName = dirPath.split("/").pop() || "/";
+    const tree = {
+        id: dirPath,
+        label: fileName,
+    };
+    if (stats.isDirectory()) {
+        try {
+            const items = readdirSync(dirPath);
+            if (items.length > 0) {
+                tree.children = items
+                    .map((item) => {
+                    const itemPath = join(dirPath, item);
+                    try {
+                        return buildDirectoryTree(itemPath, basePath);
+                    }
+                    catch (error) {
+                        console.error(`Error processing ${itemPath}:`, error);
+                        return null;
+                    }
+                })
+                    .filter((item) => item !== null);
+            }
+        }
+        catch (error) {
+            console.error(`Error reading directory ${dirPath}:`, error);
+        }
+    }
+    console.log("tree=", tree);
+    return tree;
+}
+// buildDirectoryTree(
+//   "/Users/xipingwang/Documents/EF-code/e1-ai-assistant-it-web/src",
+// );
+/**
+ * Gets the parent directory path of a given directory path
+ * Cross-platform compatible (Windows, macOS, Linux)
+ * @param {string} dirPath - The path to get the parent directory from
+ * @returns {string} The parent directory path
+ *
+ * @example
+ * // On Unix-like systems (Mac/Linux)
+ * getParentDirectory('/Users/documents/folder') // returns '/Users/documents'
+ *
+ * // On Windows
+ * getParentDirectory('C:\\Users\\Documents\\folder') // returns 'C:\\Users\\Documents'
+ *
+ * // Works with both forward and backward slashes
+ * getParentDirectory('C:/Users/Documents/folder') // returns 'C:/Users/Documents'
+ */
+export function getParentDirectory(dirPath) {
+    // Normalize the path to handle different path formats
+    const normalizedPath = normalize(dirPath);
+    // Get the parent directory using dirname
+    const parentPath = dirname(normalizedPath);
+    // If we're already at the root, return the normalized root
+    return normalizedPath === parentPath ? parentPath : parentPath;
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@xiping/node-utils",
+  "version": "0.0.30",
+  "description": "node-utils",
+  "author": "The-End-Hero <527409987@qq.com>",
+  "homepage": "https://github.com/The-End-Hero/xiping#readme",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "directories": {
+    "lib": "lib",
+    "test": "__tests__"
+  },
+  "files": [
+    "lib"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/The-End-Hero/wang-ping.git"
+  },
+  "scripts": {
+    "test": "echo \"Error: run tests from root\" && exit 1",
+    "build": "tsc"
+  },
+  "bugs": {
+    "url": "https://github.com/The-End-Hero/wang-ping/issues"
+  },
+  "gitHead": "80bce04180eb3e840bba53584d44b988e3ef8fda",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.1",
+    "tslib": "^2.8.1",
+    "typescript": "^5.7.2"
+  }
+}