@feature-sliced/cli

中文文档
1.0.0发布于 2024/01/15ISCES Module近 30 天下载 4788

能够快速地从Feature-Sliced Design中生成地层,切片和片段.

中文使用文档
文档目录4 节
  1. 安装
  2. 使用量
  3. 贷项
  4. 许可证

@ feature- sliced/ cli (英语)

npm version Static checks and tests

从中快速生成地层、切片和片段的工具 特色设计。 。 。 .

安装

npm add -g @feature-sliced/cli

这将创建一个全局二进制 fsd。也可以在本地安装此 CLI,但您需要使用 npx 运行它.

使用量

生成实体层 client 包含索引文件和两个片段的切片, ui 财务报告和审定财务报表 api数字 :

fsd entities client --segments ui api

或者,简而言之:

fsd e client -s ui,api

如果您的工程中至少有一块, CLI 将会知道在哪里生成 。 否则,它将会在当前文件夹中生成,或者您可以指定自己与该文件夹的位置 --root 或者说 -r 选项.

其他例子
  • 用一个 bottom-bar 具有索引文件和片段的切片 ui 财务报告和审定财务报表 api 输入 src/ 文件夹 :

    fsd w bottom-bar -s ui api -r src
    fsd widget bottom-bar -s ui,api -r src
    fsd widgets bottom-bar --segments ui,api -r src
    

    生产:

    • src/widgets/bottom-bar/index.(js|ts) (取决于您的项目)
    • src/widgets/bottom-bar/ui/
    • src/widgets/bottom-bar/api/
  • 用切片生成地物层 employee/employee-record 在切片组内 employee数字 :

    fsd f employee/employee-record
    fsd feat employee/employee-record
    

    在检测到的 FSD root [^1] 或当前文件夹中,生成:

    • features/employee/employee-record/index.(js|ts) (取决于您的项目)
  • 生成实体层 user 切入内侧 src/lib 文件夹,必要时创建文件夹 :

    fsd e user -r ./src/lib
    fsd entity user --root ./src/lib
    

    生产:

    • src/lib/entities/user/index.(js|ts) (取决于您的项目)
  • 用切片生成页面层 edit-note 财务报告和审定财务报表 note-list,每个部分 ui 财务报告和审定财务报表 api数字 :

    fsd p edit-note note-list -s ui, api
    fsd page edit-note, note-list -s ui api
    

    在检测到的 FSD root [^1] 或当前文件夹中,生成:

    • pages/edit-note/index.(js|ts) (取决于您的项目)
    • pages/edit-note/ui/
    • pages/edit-note/api/
    • pages/note-list/index.(js|ts)
    • pages/note-list/ui/
    • pages/note-list/api/
  • 生成带有片段的共享层 ui 财务报告和审定财务报表 api 和每个部分的索引文件 :

    fsd s ui api
    fsd s -s ui api
    fsd shared ui -s api
    

    在检测到的 FSD root [^1] 或当前文件夹中,生成:

    • shared/ui/index.(js|ts)
    • shared/api/index.(js|ts)

贷项

感谢一个社区成员 Agent_RBY_ 用于执行大多数生成和检测逻辑.

许可证

该项目的源代码根据ISC许可证的规定来分配. 这就像麻省理工,但更好. 点击这里 来学习这意味着什么.

[^1]:一个FSD根是Feature-Sliced Design中包含切片的文件夹. 在一个项目中可以有几个独立的根.

版本与发布记录

@feature-sliced/cli 共发布 3 个版本,首次发布于 2023/12/03;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.0latest2024/01/152 年前
1.0.0-beta.22023/12/032 年前
1.0.0-beta.12023/12/032 年前

关于 @feature-sliced/cli 的常见问题

@feature-sliced/cli 是什么?

能够快速地从Feature-Sliced Design中生成地层,切片和片段.

如何安装 @feature-sliced/cli?

在项目目录运行 npm install @feature-sliced/cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 fsd,可以用 npx fsd 直接运行。

@feature-sliced/cli 支持 TypeScript 吗?

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

@feature-sliced/cli 支持 ESM 还是 CommonJS?

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

@feature-sliced/cli 可以商用吗?

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

@feature-sliced/cli 的下载量有多少?

根据 npm 官方下载统计,@feature-sliced/cli 在 2026/10/15 – 2026/11/13 这 30 天内被下载 4,788 次,日均约 160 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@feature-sliced/cli 还在维护吗?

最新版本 1.0.0 发布于 2024/01/15(2 年前);至今共发布 3 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/12/03。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。