Lint configuration files

These are files used across our projects to lint our files.

They help you to get familiar with our coding style–guides. They also help to get feedback about common pitfalls earlier in the coding process, instead of when you submit a PR.

Install

Globally

If you’re installing this repository as a way to lint your files across all our projects, just run the following command in the folder containing your juwai repositories. Linters should then use these files by default if no file is present in a specific repository.

$ npm install juwai/juwai-lint-cfg

Within a specific project

1. Make sure node.js is installed in your environment.
2. cd to the root of your project’s repository.
3. Run $ npm install juwai/juwai-lint-cfg --save-dev to install the module from git and save it to the configuration of the project.
4. Files should be now copied to the root of your repository, ready to lint your code!

Usage

These files are used by Travis-CI when opening a Pull Request, and you can also use them in your editor.

Sublime-Text

You can install the following plugins to have live linting in Sublime–Text. Their installation is usually really similar, so please refer to their documentation if something is not working, or ask around with your specific problem.

1. SublimeLinter: https://packagecontrol.io/packages/SublimeLinter

2. Essential for all projects:

   • .editorconfig: https://packagecontrol.io/packages/EditorConfig

3. JavaScript:

   • .jscsrc (coding standards): https://packagecontrol.io/packages/SublimeLinter-jscs
   • .jshintrc (common errors): https://packagecontrol.io/packages/SublimeLinter-jshint

4. CSS:

   • .stylelintrc: https://packagecontrol.io/packages/SublimeLinter-contrib-stylelint
   • .csslintrc: https://packagecontrol.io/packages/SublimeLinter-csslint (deprecated, but still in use in some project)

You can also install tools to assist you with style-guides:

• SublimeLinter-annotations will highlight all TODO, README, FIXME, etc.
• JSCS Formatter will format your code based on the rules we’re using to lint the code. This package is huge time saver.