Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

前端规范 #23

Open
kok-s0s opened this issue Jun 18, 2022 · 2 comments
Open

前端规范 #23

kok-s0s opened this issue Jun 18, 2022 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@kok-s0s
Copy link
Contributor

kok-s0s commented Jun 18, 2022

我是如何带领团队从零到一建立前端规范的?

参照上述文章实现该项目的前端规范。

每次修改代码要提交时会触发以下代码:

yarn lint
yarn stylelint
npx lint-staged

其中前两个用于检查项目是否有文件不规范,抛出error的话就无法提交成功,需做检查并改正;

yarn lint:fixyarn stylelint:fix 可修复绝大多数;

最后一个指令用于修复所提交的代码,确保所提交代码符合规范;


同时我调整了项目的目录结构,资源文件命名为 assets,专门弄 routerstore 的文件夹用于存放相关信息;


scss 中全部采用小驼峰的方式来命名;
默认用的是 stylelint 中的 stylelint-config-standard-scss 插件包中提供的规则,有不同想法在下面提出,可自定义规则。


增加了 prettier 包用于格式化一些代码,执行 yarn format 命令即可;


BUG

我初次使用遇到 husky 的问题是关于 CRLFLF 的.

那个脚本 pre-commit 必须是 LF 格式才能正常执行,否则会有这个报错 env: node\r: No such file or directory

解决链接:env: node\r: No such file or directorypyenv/pyenv#1725

我的电脑是执行 git config --global core.autocrlf false 就不会默认帮我把文件弄成 CRLF 了。

@kok-s0s kok-s0s added the documentation Improvements or additions to documentation label Jun 18, 2022
@clean99
Copy link
Member

clean99 commented Jun 18, 2022

可否顺便增加一个yarn test命令在lint之后,该项目后面应该会写一部分test,可以顺便在提交的时候进行test,确保代码没有regression

@kok-s0s
Copy link
Contributor Author

kok-s0s commented Jun 19, 2022

可否顺便增加一个yarn test命令在lint之后,该项目后面应该会写一部分test,可以顺便在提交的时候进行test,确保代码没有regression

现在那个 package.json 里有 create react app 自带的测试脚本命令 "test": "react-scripts test" , 现在你们还没写测试,先不加, 要不然会报 error ,提交就会失败了。等测试完善再加。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants