Source Code

ESLint is hosted at GitHub and uses Git for source control. In order to obtain the source code, you must first install Git on your system. Instructions for installing and setting up Git can be found at http://help.github.com/set-up-git-redirect.

ESLint 托管在 GitHub,使用 Git 作为版本控制工具。 你必须先在操作系统中安装 Git ,才能获取到源码。 你可以在 http://help.github.com/set-up-git-redirect 找到关于如何安装和配置 Git 的教程。

If you simply want to create a local copy of the source to play with, you can clone the main repository using this command:

如果仅仅想拷贝源码到本地,可以使用这个命令克隆主仓库:

git clone git://github.com/eslint/eslint.git

If you’re planning on contributing to ESLint, then it’s a good idea to fork the repository. You can find instructions for forking a repository at http://help.github.com/fork-a-repo/. After forking the ESLint repository, you’ll want to create a local copy of your fork.

如果计划向 ESLint 贡献代码,那么 fork 这个仓库是一个好的选择。 你可以在 http://help.github.com/fork-a-repo/ 找到关于如何 fork 仓库的教程。 当你 fork ESLint 仓库后,可以拷贝你的 fork 到本地。

Start Developing

Before you can get started developing, you’ll need to have a couple of things installed:

在你开始开发之前,你需要安装以下工具:

Once you have a local copy and have Node.JS and npm installed, you’ll need to install the ESLint dependencies:

当你已经将代码拷贝到本地并安装了 Node.JS 和 npm,你需要安装 ESLint 的相关依赖:

cd eslint
npm install

Now when you run eslint, it will be running your local copy and showing your changes.

现在运行 eslint 命令,将会运行本地的拷贝并可以显示你对它的修改。

Note: It’s a good idea to re-rerun npm install whenever you pull from the main repository to ensure you have the latest development dependencies.

注意:当你从主仓库上 pull 代码后,最好重新运行 npm install 命令,以确保安装了最新的开发依赖。

Directory structure

The ESLint directory and file structure is as follows:

ESLint 的目录和文件结构如下: