需要审计的前端
用于审计需要前端套件的套件,用于需要特定配置和准则,并提出一个解决方案.
开始
neeto-audit-frontend 进行5项检查,以确保遵循有关准则:
- 检查软件包是否使用来自
neeto-commons-frontend。 。 。 . - 检查软件包是否使用常见的更漂亮和尾风配置 .
- 检查套件是否使用同一套胡斯基预承诺和预推钩.
- 检查软件包是否使用指定的节点版本
.node-version财务报告和审定财务报表.nvmrc文档. - 检查包是否使用常见 npm 包的推荐版本,包括其它 neto 包.
在neto中有不同类型的前端包:纳米,部件,扩展和前端包.neeto-audit-frontend 维护一个常见配置的本地副本,如果任何类型的软件包遵循不同的配置,则维护一个不同的本地副本。 例如,ESlint配置对于纳米,部件和扩展不同. 每份都保存一份当地副本。 包中的文件根据这些版本进行测试,看看它们是否匹配. 如果任何检查失败,它将提供一个命令,用户可以在执行之前运行以修正该特定检查.
安装
yarn add -D "@bigbinary/neeto-audit-frontend@latest"
运行审计
yarn neeto-audit-frontend # report what is not compliant, change nothing
yarn neeto-audit-frontend -a # fix everything that can be fixed automatically
yarn neeto-audit-frontend -a <targets> # fix only the listed targets
yarn neeto-audit-frontend <targets> # report only the listed targets, change nothing
yarn neeto-audit-frontend -l # print the targets available in this repo, then run
<targets> 是一个逗号分隔列表。 没有它,审计行为就跟往常一样
已经,所以CI检查和预推钩没有受到影响。 有了它,只有列出的目标
运行,它使一个常规版本被压缩到一个可复读的 diff 而不是同时重写
更漂亮 尾风和ESLint配置.
yarn neeto-audit-frontend -a @bigbinary/neeto-commons-frontend, @bigbinary/neeto-icons
yarn neeto-audit-frontend -a eslint, prettier
目标
任何软件包名称都是有效的目标, 无论它是在
https://ops.neetotower.com/api/v1/public/nanos 互联网档案馆的存檔,存档日期2013-12-11 或建议第三方之一
依赖性,例如 axios 或者说 prettier除软件包名称外,这些目标还包括:
已接受:
| 目标 | 它会做什么 |
|---|---|
packages | 弹出对其推荐版本的依赖性 |
node-version | 更新 .node-version 财务报告和审定财务报表 .nvmrc |
husky | 重新同步 husky 钩子及其助手脚本 |
prettier | 重新同步更美和尾风配置 |
eslint | 重新同步 ESLint 配置 |
目标可能通过逗号,白空,或两者兼而有之,所以 -a eslint,prettier, (中文(简体) ),
-a eslint, prettier 财务报告和审定财务报表 -a "eslint prettier" 都一样.
指定支票 总是全数运行 所以
-a packages, @bigbinary/neeto-icons 页:1 packages 检查碰碰每个依赖者
不只是那个名字.
无法识别的目标会打印出最接近匹配的警告, 并显示运行
继续实现公认的目标. -l 是修饰符而不是模式 :
打印目标表格,然后按命令的其他内容进行
为.
添加 CI 检查
在 neetoCI YAML 文件中添加以下行 .
setup:
- yarn install
jobs:
- name: CiChecks
commands:
- yarn neeto-audit-frontend
改变配置
如果正在检查的配置文件有任何更改 neeto-audit-frontend,审计检查会失败。 如果有必要作出这一修改,我们应对当地保存的文本作同样的修改 neeto-audit-frontend 以确保检查会通过.
发展指示
neeto-audit-frontend 用途 pnpm 作为软件包管理器。 建立发展环境 pnpm install 在复制仓库后。 在对核查器进行修改后,我们可以通过使用 yalc. 遵循其中提及的步骤 测试前端软件包 测试变化.
如果,出于任何原因, yarn neeto-audit-frontend 命令在按下修改后失败 yalc运行 yarn install --check-files。 。 。 .
建筑和放行
这个 @bigbinary/neeto-audit-frontend 当我们把公关与 patch, (中文(简体) ), minor 或者说 major 标记到主分支。 这个 patch 标签用于错误修正, minor 标签用于新特性和 major 标签用于断开更改。 你可以去检查 Create and publish releases gitHub Actions中的工作流程获取实时更新. 请注意,在发布软件包之前,您需要验证本地使用的一些 neto 网页应用程序中的功能 yalc 软件包管理器.