esprint 项目教程

esprint 项目教程

esprintFast eslint runner项目地址:https://gitcode.com/gh_mirrors/es/esprint

1. 项目的目录结构及介绍

esprint 项目的目录结构如下：

esprint/
├── bin/
├── dist/
├── docs/
├── examples/
├── src/
├── test/
├── .babelrc
├── .eslintignore
├── .eslintrc
├── .flowconfig
├── .gitignore
├── .npmignore
├── .prettierrc
├── CONTRIBUTING.md
├── esprintrc.example
├── LICENSE
├── package.json
├── README.md
└── yarn.lock

• bin/: 包含可执行文件。
• dist/: 编译后的文件。
• docs/: 项目文档。
• examples/: 示例代码。
• src/: 源代码。
• test/: 测试文件。
• .babelrc: Babel 配置文件。
• .eslintignore: ESLint 忽略文件。
• .eslintrc: ESLint 配置文件。
• .flowconfig: Flow 配置文件。
• .gitignore: Git 忽略文件。
• .npmignore: npm 忽略文件。
• .prettierrc: Prettier 配置文件。
• CONTRIBUTING.md: 贡献指南。
• esprintrc.example: 示例配置文件。
• LICENSE: 许可证文件。
• package.json: npm 包配置文件。
• README.md: 项目说明文档。
• yarn.lock: Yarn 锁定文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，主要包含以下文件：

• esprint: 项目的可执行文件，用于启动 esprint 服务。

启动 esprint 服务的命令如下：

./bin/esprint

3. 项目的配置文件介绍

项目的配置文件为 esprintrc，示例如下：

{
  "paths": ["foo/*js", "bar/**/*js"],
  "ignored": ["**/node_modules/**/*"],
  "port": 5004
}

• paths: 需要进行 lint 的文件路径，支持 glob 模式。
• ignored: 需要忽略的文件路径，支持 glob 模式。
• port: 启动后台服务器的端口号（可选）。

配置文件应放置在项目的根目录下。

esprintFast eslint runner项目地址:https://gitcode.com/gh_mirrors/es/esprint