代码规范

[](https://fantastic-mobile.hurui.me/guide/ready.html#%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83)

为保证代码风格统一，请使用做为开发 IDE ，框架源码里已提供相关配置文件，可直接测试效果：在保存代码时，会自动对当前文件进行代码格式化操作。

IDE 配置

配置文件为 .editorconfig ，通常情况下无需做任何修改。

ESLint 配置

配置文件为 eslint.config.js ，框架使用做为基础规范，如果你对默认的规则有异议，可以查阅官网规则并在 eslint.config.js 文件中进行覆盖。

当你对规则进行修改后，原有的代码可能会因为规则的变动导致编辑器大量提示错误，你可以通过运行 pnpm run lint:eslint 进行一次格式校验，如果规则支持自动修复，则会将不符合规则的代码自动进行格式化。

````

StyleLint 配置

配置文件为 stylelint.config.js ，如果你对默认的规则有异议，可以查阅官网规则并在 stylelint.config.js 文件中进行修改。

当你对规则进行修改后，原有的代码可能会因为规则的变动导致编辑器大量提示错误，你可以通过运行 pnpm run lint:stylelint 进行一次格式校验，如果规则支持自动修复，则会将不符合规则的代码自动进行格式化。

````

simple-git-hooks 和 lint-staged

由于 IDE 能做的事比较有限，只能对代码的书写规范进行格式化，对于一些无法自动修复的错误代码，如果没有改正到就被推送到 git 仓库，在多人协作开发时，可能会影响到别人的开发体验。所以框架集成了和这两个依赖来解决这一问题。

在提交代码时， simple-git-hooks 会通过 lint-staged 对本次提交变更的文件进行分别进行 eslint 和 stylelint 检测，如果有报错，则会阻止本次代码提交，直到开发者修改完所有错误代码后，才允许提交到 git 仓库，这样可以确保 git 仓库里的代码不会有不规范的代码。

````````````````

plain

"simple-git-hooks": {
  "pre-commit": "cd ./fantastic-mobile/ && pnpm lint-staged",
  "preserveUnused": true
}

移除

如果不想在 git 提交时强制进行代码规范校验，可以在 package.json 中移除 simple-git-hooks 配置：

plain

{
  "scripts": {
    "postinstall": "simple-git-hooks", 
  },
  "simple-git-hooks": { 
    "pre-commit": "pnpm lint-staged", 
    "preserveUnused": true
  }, 
}

然后手动删除 .git/hooks/pre-commit 文件即可。

代码规范 ​

IDE 配置 ​

ESLint 配置 ​

StyleLint 配置 ​

simple-git-hooks 和 lint-staged ​

移除 ​

代码规范

IDE 配置

ESLint 配置

StyleLint 配置

simple-git-hooks 和 lint-staged

移除