isabella232 / linting-and-editorconfig

Reference repo for eslint (and other linters) as well as editorconfig settings and info

Linting and Editorconfig

Reference repo for eslint (and other linters) as well as editorconfig settings and info

Contains:

• an example .editorconfig with some reasonable defaults
• example of "pure" AirBnB JavaScript eslint setup (complete with React)
• example of a "customised" AirBnB set up based on the above
• an example .scss-lint.yml with some reasonable defaults for scss-lint
• an example .stylintrc with some reasonable defaults for stylint
• an example .markdownlintrc file to configure markdownlint node/ruby

The whys and wherefores

Although we don't want to enforce any kind of "one true way" to code, we would like for any given project to be able to enforce its own coding style choices (tabs, spaces, single quotes, etc).

Linting can also encourage best practices (function names, etc) and even catch some errors nice and early (typos).

Linting and a Suggested JavaScript Baseline

I am proposing AirBnB JavaScript using ESLint as the baseline standard. It is an extensive set of reasonable standards and even covers React and JSX.

Moreover, unlike something like standard or semistandard which are meant to be all-or-nothing bikeshed breakers, AirBnB is just an eslint config that can have any individual rule overridden at a project level.

Examples of "pure" AirBnB and customised AirBnB are in the linting repo.

@garthdb has also added in linting configs for styles and markdown, currently in use by the site.

Editorconfig

EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs. The EditorConfig project consists of a file format for defining coding styles and a collection of text editor plugins that enable editors to read the file format and adhere to defined styles. EditorConfig files are easily readable and they work nicely with version control systems.

Most of the major editors and IDEs can respect editorconfig files that specify things like tabs over spaces, how many spaces, etc. There is also an example of one of these in the repo. Setting one of these up will help others to respect the choices you make wrt these styles.

Git Collaboration Workflow

Also included is a simple CONTRIBUTING.md file with basic collaboration / contribution information.