这座城市多了十只伤心的鸽——代码规范

这个作业属于哪个课程	2021春软件工程实践|W班 (福州大学)
这个作业要求在哪里	团队作业六——beta冲刺+事后诸葛亮
团队	[这座城市多了十只伤心的鸽] (https://www.cnblogs.com/rgsjteam12/)
这个作业的目标	Beta冲刺的博客汇总
参考文献	构建之法

前端代码规范

代码规范

前端代码规范主要用了以下的 npm 库文件制定的规范。

1. eslint-plugin-standard https://www.npmjs.com/package/eslint-plugin-standard
2. eslint-plugin-import https://www.npmjs.com/package/eslint-plugin-import
3. eslint-plugin-node https://www.npmjs.com/package/eslint-plugin-node
4. eslint-plugin-promise https://www.npmjs.com/package/eslint-plugin-promise
5. eslint-plugin-vue https://www.npmjs.com/package/eslint-plugin-vue
6. @vue/eslint-config-standard https://www.npmjs.com/package/@vue/eslint-config-standard
7. @vue/eslint-config-typescript https://www.npmjs.com/package/@vue/eslint-config-typescript
8. @typescript-eslint/eslint-plugin https://www.npmjs.com/package/@typescript-eslint/eslint-plugin

除此之外也有在上述库的基础上定制了一些代码规范

  rules: {
    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
    '@typescript-eslint/explicit-module-boundary-types': 'off',
    '@typescript-eslint/no-explicit-any': 'off',
  },

代码规范约束工具

eslint

主要使用 eslint 进行代码规范校验，配合 vscode-eslint 对代码不满足规范的地方进行检查。

git-hooks

  "gitHooks": {
    "pre-commit": "lint-staged"
  },

并配置了 gitHooks 对代码规范进行校验，如果不满足校验，则无法提交本次的文件修改。保证提交的代码均能满足 eslint 规范

后端代码规范参考（go）