Skip to content

Latest commit

 

History

History
90 lines (60 loc) · 3.99 KB

README-zh.md

File metadata and controls

90 lines (60 loc) · 3.99 KB

Udacity 前端工程师纳米学位样式指南 - JavaScript

本仓库可以自动化执行 Udacity Frontend Nanodegree Style Guide 要求的样式检查。无论你是需要提交纳米学位项目,或是帮忙 review 项目,你都可以使用这个仓库来做样式方面的自动化检查。

如何使用

readme-instructors

软件需求

  • 确保你有一个全局的 Node/NPM 或 yarn。如果没有,你可以在 官网 下载安装,或通过 nvm 安装管理 node;若 NPM 已经安装,可使用 npm i -g yarn 安装 yarn
  • 确保你的项目根目录下有一个 package.json 文件。如果没有,可使用 npm init 初始化一个

如何使用

安装以下依赖:

npm install --save-dev eslint eslint-config-udacity eslint-plugin-import

yarn add --dev eslint eslint-config-udacity eslint-plugin-import

依赖安装完成后,手动在根目录下添加一个 .eslintrc.json 文件,并写入以下内容:

{
  "extends": "udacity"
}

你也可使用 echo '{ "extends": "udacity" }' > .eslintrc.json 完成上述写入操作。

package.json 文件的 scripts 段中添加以下一行:

{
  ...
  "scripts": {
    "lint": "eslint ./**/*.js",
    ...
  }
}

其中,./**/*.js 可替换为你的项目下需要 lint 的文件路径,比如 app/**/*.jssrc/*.jsapp/*.js src/*.js 等。

运行 npm run lint 命令即可。

其他事项

⚠ 这份配置仍不是100%自动化、完善的。

目前,有一些规则还没有办法覆盖到,它们是以下4个规则,其中1个是必须的检查,3个是建议事项,并且也有些是代码逻辑上的问题(比如 DOM 操作与闭包),样式检查工具无法触及,仍然需要人工 review。

如何贡献

  1. fork 仓库,并在新的分支上提交代码
  2. 如果你添加了新的规则/特性,请确保你为这部分代码也添加了测试覆盖;或者,你需要提供没有测试覆盖的理由
  3. 提交 PR 前,请确保你的 构建 是全绿通过的
  4. 提交 PR

TODOLIST

请见 TODOLIST.md

License

MIT。