@appthreat/atom-common

中文文档
1.1.0发布于 2025/12/29MITES Module零依赖构建来源已验证近 30 天下载 124万

@appreatures/ atom 项目的共同库 .

中文使用文档
文档目录9 节
  1. 安装
  2. 使用量
  3. API 参考
  4. 文件系统公用事业
  5. 运行时间检测工具
  6. 配置
  7. 文件忽略
  8. 自定义二进制路径
  9. 许可证

原子常见

一个轻量级的Node.js通用库提供文件系统 traversal 帮助器和运行时环境探测器.

安装

npm install @appthreat/atom-common
# or
yarn add @appthreat/atom-common

使用量

import { getAllFiles, detectJava, detectRuby } from "@appthreat/atom-common";

// 1. Recursively get all .js files in a directory
const jsFiles = getAllFiles("./src", ".js");
console.log(jsFiles);

// 2. Check if runtimes are available
if (detectJava()) {
  console.log("Java is installed!");
}

if (detectRuby("3.4.x")) {
  console.log("Ruby 3.4.x is installed!");
}

API 参考

文件系统公用事业

getAllFiles(dir, extn, ...args)

递归扫描带有特定扩展名的文件目录. 它会自动忽略 node_modules,点文件(隐藏文件),以及配置中定义的特定目录.

  • 目录 (string): 开始扫描的根目录.
  • 扩展 (string):要查找的文件扩展名(例如, .js, (中文(简体) ), .ts) (中文(简体) ).
  • 忽略( node 模块) (boolean)默认为 true。 。 。 .

回返情况: 一系列文件路径 .

运行时间检测工具

这些函数催生出一个子进程来检查版本旗. 他们回来了 true 如果找到运行时间并成功退出, 否则 false。 。 。 .

  • detectJava(): 检查 java。 。 。 .
  • detectPhp(): 检查 php。 。 。 .
  • detectScala(): 检查 scala。 。 。 .
  • detectScalac(): 检查斯卡拉编译器 scalac。 。 。 .
  • detectRuby(versionNeeded): 检查 ruby。 。 。 .
    • 需要的版本 (可选):一个字符串(例如, "3.4.7", (中文(简体) ), "3.4.x", (中文(简体) ), "4.0.x") (中文(简体) ). 如果提供,则验证已安装的版本匹配 .

配置

您可以使用环境变量来配置公用事业的行为 .

文件忽略

变量说明默认
ASTGEN_IGNORE_DIRS扫描时要忽略目录名称的 CSV 串 .venv, docs, e2e, cypress, node_modules (和其他情况)
ASTGEN_IGNORE_FILE_PATTERN文件忽略的 Regex 字符串 .(three|\.d)\.(js|ts|jsx|tsx)$

自定义二进制路径

如果您的二进制不在全局系统 PATH 中, 您可以覆盖用于检测的命令 :

变量说明默认
JAVA_CMD运行 Java 的命令java
PHP_CMD运行 PHP 的命令php
RUBY_CMD运行 Ruby 的命令ruby
SCALA_CMD运行 Scala 的命令scala
SCALAC_CMD运行 Scalac 的命令scalac

许可证

麻省理工学院

版本与发布记录

@appthreat/atom-common 共发布 17 个版本,首次发布于 2025/05/13;过去 12 个月发布了 5 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.1.0latest2025/12/2910 个月前
1.0.162025/12/1810 个月前
1.0.142025/12/1710 个月前
1.0.132025/12/0411 个月前
1.0.122025/11/1811 个月前
1.0.112025/09/231.1 年前

关于 @appthreat/atom-common 的常见问题

@appthreat/atom-common 是什么?

@appreatures/ atom 项目的共同库 .

如何安装 @appthreat/atom-common?

在项目目录运行 npm install @appthreat/atom-common,或使用 pnpm add / yarn add / bun add。

@appthreat/atom-common 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/appthreat__atom-common 是否存在。

@appthreat/atom-common 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@appthreat/atom-common 可以商用吗?

@appthreat/atom-common 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@appthreat/atom-common 的下载量有多少?

根据 npm 官方下载统计,@appthreat/atom-common 在 2026/10/07 – 2026/11/05 这 30 天内被下载 1,239,977 次,日均约 41,333 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@appthreat/atom-common 还在维护吗?

最新版本 1.1.0 发布于 2025/12/29(10 个月前);至今共发布 17 个版本,其中过去 12 个月发布了 5 个;首次发布于 2025/05/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。