huan-file-tool 1.0.0

package/.eslintignore

@@ -0,0 +1,30 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+dist-*
+dist-development
+dist-production
+dist-dev
+dist-prod
+docs
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

package/.eslintrc.cjs

@@ -0,0 +1,127 @@
+/*!
+ * https://eslint.bootcss.com/docs/rules/
+ * https://eslint.vuejs.org/rules/
+ */
+
+module.exports = {
+  root: true,
+  env: {
+    browser: true,
+    node: true,
+    es6: true
+  },
+  parserOptions: {
+    sourceType: 'module'
+  },
+  extends: ['prettier', 'eslint:recommended', 'plugin:prettier/recommended'],
+  plugins: ['prettier'],
+  rules: {
+    'no-undef': 'off',
+    'prettier/prettier': 'warn',
+    'no-unused-vars': 'warn',
+    // 禁用debugger
+    'no-debugger': 'warn',
+    // 禁止出现重复的 case 标签
+    'no-duplicate-case': 'warn',
+    // 禁止出现空语句块
+    // 'no-empty': 'warn',
+    // 禁止不必要的括号
+    'no-extra-parens': 'off',
+    // 禁止对 function 声明重新赋值
+    'no-func-assign': 'warn',
+    // 禁止在 return、throw、continue 和 break 语句之后出现不可达代码
+    'no-unreachable': 'warn',
+    // 强制所有控制语句使用一致的括号风格
+    curly: 'warn',
+    // 要求 switch 语句中有 default 分支
+    'default-case': 'warn',
+    // 强制尽可能地使用点号
+    'dot-notation': 'warn',
+    // 要求使用 === 和 !==
+    // eqeqeq: 'warn',
+    // 禁止 if 语句中 return 语句之后有 else 块
+    'no-else-return': 'warn',
+    // 禁止出现空函数
+    // 'no-empty-function': 'warn',
+    // 禁用不必要的嵌套块
+    'no-lone-blocks': 'warn',
+    // 禁止使用多个空格
+    'no-multi-spaces': 'warn',
+    // 禁止多次声明同一变量
+    'no-redeclare': 'warn',
+    // 禁止在 return 语句中使用赋值语句
+    'no-return-assign': 'warn',
+    // 禁用不必要的 return await
+    'no-return-await': 'warn',
+    // 禁止自我赋值
+    'no-self-assign': 'warn',
+    // 禁止自身比较
+    'no-self-compare': 'warn',
+    // 禁止不必要的 catch 子句
+    'no-useless-catch': 'warn',
+    // 禁止多余的 return 语句
+    'no-useless-return': 'warn',
+    // 禁止变量声明与外层作用域的变量同名
+    'no-shadow': 'off',
+    // 允许delete变量
+    'no-delete-var': 'off',
+    // 强制数组方括号中使用一致的空格
+    'array-bracket-spacing': 'warn',
+    // 强制在代码块中使用一致的大括号风格
+    'brace-style': 'warn',
+    // 强制使用骆驼拼写法命名约定
+    // camelcase: 'warn',
+    // 强制使用一致的缩进
+    indent: 'off',
+    // 强制在 JSX 属性中一致地使用双引号或单引号
+    // 'jsx-quotes': 'warn',
+    // 强制可嵌套的块的最大深度4
+    'max-depth': 'warn',
+    // 强制最大行数 300
+    // "max-lines": ["warn", { "max": 1200 }],
+    // 强制函数最大代码行数 50
+    // 'max-lines-per-function': ['warn', { max: 70 }],
+    // 强制函数块最多允许的的语句数量20
+    'max-statements': ['warn', 100],
+    // 强制回调函数最大嵌套深度
+    'max-nested-callbacks': ['warn', 5],
+    // 强制每一行中所允许的最大语句数量
+    'max-statements-per-line': ['warn', { max: 1 }],
+    // 要求方法链中每个调用都有一个换行符
+    'newline-per-chained-call': ['warn', { ignoreChainWithDepth: 3 }],
+    // 禁止 if 作为唯一的语句出现在 else 语句中
+    'no-lonely-if': 'warn',
+    // 禁止空格和 tab 的混合缩进
+    'no-mixed-spaces-and-tabs': 'warn',
+    // 禁止出现多行空行
+    'no-multiple-empty-lines': 'warn',
+    // 禁止出现;
+    semi: ['warn', 'never'],
+    // 强制在块之前使用一致的空格
+    'space-before-blocks': 'warn',
+    // 强制在 function的左括号之前使用一致的空格
+    // 'space-before-function-paren': ['warn', 'never'],
+    // 强制在圆括号内使用一致的空格
+    'space-in-parens': 'warn',
+    // 要求操作符周围有空格
+    'space-infix-ops': 'warn',
+    // 强制在一元操作符前后使用一致的空格
+    'space-unary-ops': 'warn',
+    // 强制在注释中 // 或 /* 使用一致的空格
+    // "spaced-comment": "warn",
+    // 强制在 switch 的冒号左右有空格
+    'switch-colon-spacing': 'warn',
+    // 强制箭头函数的箭头前后使用一致的空格
+    'arrow-spacing': 'warn',
+    'no-var': 'warn',
+    'prefer-const': 'warn',
+    'prefer-rest-params': 'warn',
+    'no-useless-escape': 'warn',
+    'no-irregular-whitespace': 'warn',
+    'no-prototype-builtins': 'warn',
+    'no-fallthrough': 'warn',
+    'no-extra-boolean-cast': 'warn',
+    'no-case-declarations': 'warn',
+    'no-async-promise-executor': 'warn'
+  }
+}

package/.npmignore

@@ -0,0 +1,67 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# Node
+node_modules
+.npmrc
+
+# Build
+dist
+dist-*
+dist-ssr
+dist-dev
+dist-prod
+
+# Git
+.git
+.gitignore
+
+# Github
+github-page
+docs
+.github
+
+# Local
+*.local
+
+# Hidden
+.*
+!.prettierrc.cjs
+!.npmignore
+!.eslintignore
+!.eslintrc.cjs
+!public/.__ignore__
+
+# IDE
+.vscode
+.idea
+
+# System
+.DS_Store
+desktop.ini
+thumbs.db
+iconcache.db
+IconCache.db
+ntuser.dat
+ntuser.dat.log
+hiberfil.sys
+pagefile.sys
+$Recycle.Bin
+Recycle Bin
+
+# Other
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+*.bak
+
+# Pack
+huan-*.tgz

package/.prettierrc.cjs

@@ -0,0 +1,14 @@
+module.exports = {
+    printWidth: 120, // 换行字符串阈值
+    tabWidth: 2, // 设置工具每一个水平缩进的空格数
+    useTabs: false,
+    semi: false, // 句末是否加分号
+    vueIndentScriptAndStyle: true,
+    singleQuote: true, // 用单引号
+    trailingComma: 'none', // 最后一个对象元素符加逗号
+    bracketSpacing: true,
+    jsxBracketSameLine: true, // jsx > 是否另取一行
+    arrowParens: 'always', // 不需要写文件开头的 @prettier
+    insertPragma: false, // 不需要自动在文件开头加入 @prettier
+    endOfLine: 'lf' // 换行符使用
+}

package/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2025 宋子桓（Song Zihuan）
+
+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/README.md

@@ -0,0 +1,25 @@
+# 简易文件处理程序（Huan-File-Tool）
+
+这是一个使用JavaScript编写的建议文件处理程序，使用`ES Module`模式。
+
+目前，所有导出函数位于：`src/main.cjs`和`src/main.mjs`文件中，此文件也是本项目的入口文件。
+
+注意：本项目同时支持`CommonJS`和`ESModule`两种模式。
+
+## 作者信息
+作者：宋子桓（Song Zihuan）
+
+作者 Github：[github.com/SongZihuan](https://github.com/SongZihuan)
+
+作者主页：[song-zh.com](https://song-zh.com)
+
+作者邮箱：songzihuan@song-zh.com
+
+## 项目信息
+项目托管地址：[github.com/SongZihuan/js-file-tool](https://github.com/SongZihuan/js-file-tool)
+GitHub托管地址：[github.com/SongZihuan/js-file-tool](https://github.com/SongZihuan/js-file-tool)
+
+最后更新时间：2025年1月22日。
+
+## 特别注意
+备注：以上README为作者原文。

package/REEPORT

@@ -0,0 +1,15 @@
+如何报告 JavaScript-File-Tool
+
+作者：宋子桓（Song Zihuan）
+作者 Github：https://github.com/SongZihuan
+作者主页：https://song-zh.com
+作者邮箱：songzihuan@song-zh.com
+
+Github：https://github.com/SongZihuan/js-file-tool
+Github Issues：https://github.com/SongZihuan/js-file-tool/issues
+
+报告：您可以通过 Github Issues 或作者邮箱报告问题并联系作者。
+质量保证：如果您仅拥有此项目根目录下的 LICENSE 文件中的许可证，您将无法获得任何质量保证。但作者很乐意为您解决问题，除非此项目已存档为只读。
+其他 Fork 版本：请联系 Fork 版本的作者寻求帮助。
+
+备注：以上REPORT为作者原文。

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "huan-file-tool",
+  "version": "1.0.0",
+  "description": "简单的文件处理工具",
+  "private": false,
+  "keywords": [
+    "javaascript",
+    "commonjs",
+    "esmodule",
+    "nodejs",
+    "file-tool",
+    "web-demo"
+  ],
+  "main": "./src/main.cjs",
+  "module": "./src/main.mjs",
+  "exports": {
+    ".": {
+      "require": "./src/main.cjs",
+      "import": "./src/main.mjs",
+      "default": "./src/main.mjs"
+    }
+  },
+  "author": "宋子桓（Song Zihuan）",
+  "license": "MIT LICENSE",
+  "repository": "https://github.com/SongZihuan/js-file-tool",
+  "bug": "https://github.com/SongZihuan/js-file-tool/issues",
+  "homepage": "https://github.com/SongZihuan/js-file-tool",
+  "engines": {
+    "node": ">=18",
+    "pnpm": ">=8"
+  },
+  "devDependencies": {
+    "eslint": "^8.38.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "prettier": "^2.8.7"
+  },
+  "dependencies": {},
+  "scripts": {
+    "init": "npx pnpm install",
+    "lint": "eslint --ext .js,.mjs,.cjs,.ts --fix .",
+    "lint:debug": "eslint --ext .js,.mjs,.cjs,.ts --debug --fix .",
+    "pack": "npx pnpm run init && npx pnpm run lint && npx pnpm pack",
+    "login": "npx pnpm login --registry=https://registry.npmjs.org"
+  }
+}

package/src/internal/commonjs/filewalk.cjs

@@ -0,0 +1,45 @@
+const path = require('path')
+const fs = require('fs')
+
+function getAllFilePaths(dir) {
+  return _getAllFilePaths(dir, './', 5)
+}
+
+function _getAllFilePaths(filePath, localpath, deep) {
+  if (deep === 0) {
+    return [], []
+  }
+
+  let filePathResult = []
+  let localPathResult = []
+
+  // 读取目录中的所有文件和子目录
+  fs.readdirSync(filePath).forEach(function (file) {
+    const newFilePath = path.join(filePath, file)
+    const newLocalPath = path.join(localpath, file)
+
+    // 如果是目录，则递归读取该目录下的文件
+    if (fs.statSync(newFilePath).isDirectory()) {
+      const { filePathResult: _filrPath, localPathResult: _localPath } = _getAllFilePaths(
+        newFilePath,
+        newLocalPath,
+        deep - 1
+      )
+      filePathResult = filePathResult.concat(_filrPath)
+      localPathResult = localPathResult.concat(_localPath)
+    } else {
+      // 如果是文件，则直接加入结果数组
+      filePathResult.push(newFilePath)
+      localPathResult.push(newLocalPath)
+    }
+  })
+
+  return {
+    filePathResult,
+    localPathResult
+  }
+}
+
+module.exports = {
+  getAllFilePaths
+}

package/src/internal/esmodule/filewalk.mjs

@@ -0,0 +1,45 @@
+import path from 'path'
+import fs from 'fs'
+
+export default {
+  getAllFilePaths
+}
+
+export function getAllFilePaths(dir) {
+  return _getAllFilePaths(dir, './', 5)
+}
+
+function _getAllFilePaths(filePath, localpath, deep) {
+  if (deep === 0) {
+    return [], []
+  }
+
+  let filePathResult = []
+  let localPathResult = []
+
+  // 读取目录中的所有文件和子目录
+  fs.readdirSync(filePath).forEach(function (file) {
+    const newFilePath = path.join(filePath, file)
+    const newLocalPath = path.join(localpath, file)
+
+    // 如果是目录，则递归读取该目录下的文件
+    if (fs.statSync(newFilePath).isDirectory()) {
+      const { filePathResult: _filrPath, localPathResult: _localPath } = _getAllFilePaths(
+        newFilePath,
+        newLocalPath,
+        deep - 1
+      )
+      filePathResult = filePathResult.concat(_filrPath)
+      localPathResult = localPathResult.concat(_localPath)
+    } else {
+      // 如果是文件，则直接加入结果数组
+      filePathResult.push(newFilePath)
+      localPathResult.push(newLocalPath)
+    }
+  })
+
+  return {
+    filePathResult,
+    localPathResult
+  }
+}

package/src/main.cjs

@@ -0,0 +1,5 @@
+const filewalk = require('./internal/commonjs/filewalk.js')
+
+module.exports = {
+  filewalk
+}

package/src/main.mjs

@@ -0,0 +1,5 @@
+import filewaalk from './internal/esmodule/filewalk.mjs'
+
+export default {
+  filewaalk
+}