Beemo - 开发配置模块

官方类型Script只包含“ 电池” Beemo 配置模块 提供了预装配置 Babel,ESLint,Jest,Prettier,以及TypeScript驱动器和开发工具.

yarn install --dev @beemo/dev

所需资源

• 源文件在一个名为 src。 。 。 .
• 测试文件在一个名为 tests 相对于来源,或 __tests__ 在源码内.
• 声明/类型文件在一个名为 types 相对来源.
• 自定义类型脚本路径应该从 : 改为 @ 为避免 国家预防机制供应链攻击。 。 。 .

设置

创建一个 .config/beemo.ts 在工程的根中配置文件 @beemo/dev 作为 配置模块. 确保启用所有驱动器和任何设置 .

// .config/beemo.ts
export default {
    module: '@beemo/dev',
    drivers: ['babel', 'eslint', 'jest', 'prettier', 'typescript'],
    settings: {},
};

设置

以下的比莫 settings 可以定义,并将传递给适用的驱动程序.

• decorators (单位:千美元)boolean) - 为 Babel 和 TypeScript 驱动程序启用装饰器. 默认为 false。 。 。 .
• esm (单位:千美元)boolean) - 启用ECMAScript模块"mode"用于支持它的工具(Babel,Jest等).
• node (单位:千美元)boolean) - 当前项目将瞄准Node.js而不是浏览器. 默认为 false。 。 。 .
• projects (单位:千美元)boolean | string[]——启用Jest项目. 若为 true 将会解决 使用工作空间,否则需要一系列明确的字符串. 默认为 false。 。 。 .
• react (单位:千美元)boolean | classic | automatic- 为所有司机启用反应和JSX支持。 默认 改为 false。 。 。 .

覆盖

如果您想要覆盖驱动程序配置, 请创建 .config/beemo/<driver>.ts 根中的文件 (b) 执行项目. 查看官方的 Beemo 文件以获取更多信息。 。 。 .

// .config/beemo/eslint.ts
export default {
    rules: {
        'no-param-reassign': 'off',
    },
};

司机

在此配置模块中直接支持以下驱动程序, 并自动通过 运行时常见命令行选项.

• 宝贝
  • 总是通过 --copy-files。 。 。 .
  • 设定 --extensions 对所有联合来文/技术服务延期.
  • 如果未提供退出,则默认为 src/ --out-dir lib/。 。 。 .
• ESLint 语录
  • 总是通过 --cache --color --fix。 。 。 .
  • 设定 --extensions 对所有联合来文/技术服务延期.
  • 如果未提供目标, 默认会关闭 src/ tests/。 。 。 .
  • 如果使用工作空间,将在每个软件包中针对以上内容.
  • 启用时生成 Pretier 和 TypeScript 配置 .
• 欢乐
  • 总是通过 --colors --logHeapUsage。 。 。 .
  • 设定 NODE_ENV=test 财务报告和审定财务报表 TZ=UTC。 。 。 .
  • 启用时生成 Babel 配置 .
  • 支助项目 projects 设置.
• 高级
  • 如果没有提供参数,则默认为 --write .。 。 。 .
  • 提供默认忽略常见文件列表 .
• 类型脚本
  • 现代/后续ECMAScript支持.
  • 只检查类型 .

请查阅文件,了解如何配置每个文件.

脚手架

一旦您的项目被配置为使用 Beemo, 您可以使用我们 内建模板.

项目/点文件

将脚手架常见的点文件像 .gitignore。 。 。 .

beemo scaffold project dotfiles

项目/基图布

将脚手架 GitHub 仓库工作流程文件到 .github。支持下列工作流程:

• build - 构建、测试、用意和类型检查每个牵引请求和主机合并的项目. 还验证 软件包 包装和包装 多龙 建筑通行证.
• deploy - 部署a 多克龙网站 每个 师承. 要求数 GH_USER 财务报告和审定财务报表 GH_PAGES_DEPLOY 秘密,我们有秘密.
• pr - 使用 常规变换日志-比莫 预设.

beemo scaffold project github

项目/包装

将字段附加到根 package.json。 。 。 .

• 添加数 scripts 共同行动 大楼,倒接,测试等.
• 当通过时 --workspaces组合 private 财务报告和审定财务报表 workspaces 改为 packages/*。 。 。 .

beemo scaffold project package

工作空间/包装

将脚手架将一个新包装入一个 packages 工作空间。 创建 CHANGELOG.md, (中文(简体) ), README.md, (中文(简体) ), LICENSE,以及 package.json 文档.

beemo scaffold workspace package --owner milesj --repo aesthetic framework