natds-commons
包含 Natura Design System 多平台包的单一代码仓库。
入门
请确保已安装 node
和 yarn
。
安装
在根目录下运行 yarn install
所有包可用的命令
以下命令可由
yarn <command>
test
:运行包的测试
test:watch
:运行包的测试并监控更改
lint
:使用 @naturacosmeticos/eslint-config-natura
规则运行 eslint
commit
:打开一个交互式界面,帮助您按照 conventional commits
编写提交
build
:运行包的构建任务
release
:分析提交,增加包版本并制作适当版本发布
prerelease
:分析提交,增加包版本并制作适当预发布版本
start
:运行包的 start
任务,通常用于打开浏览器可视化
添加新的包
创建新包
在
packages
文件夹内创建一个新的文件夹,并运行以下命令。yarn init
并填写包信息。
创建包脚本
之后,在包的
package.json
文件中创建以上脚本。这使我们能够从根目录运行所有包命令。
注册新包
在根目录的
package.json
工作空间数组中添加创建的包{
"workspaces": [
"packages/natds-themes",
"packages/<your-new-package>"
]
}
添加依赖到包
从根目录
npx lerna add <package-I-want-to-add> --scope @naturacosmeticos/<my-package> -D
将共享依赖添加到所有包
从根目录(仅限开发依赖。如果是依赖项,应使用上述命令添加并列入包的
package.json
中)yarn add <package-I-want-to-add> -D -W
开始黑客攻击!
提交代码
我们正在使用 常规提交
指南来自动化我们的版本和更改日志创建过程。
您可以在 这里 阅读更多。
如果您不确定如何遵循提交指南,我们有一个交互式指南可以帮助您。请参阅上面的 commit
命令。
所有提交都必须包含以
DSY-
开头的问题编号。如果您在提交过程中遇到问题(引用错误),很可能是您忘记了这一点!使用commit
命令,您可以在详细描述字段中包含此信息