Skip to content

beardon/code-style

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Beardon's Code Style Guidelines

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.

Usage

Place the .editorconfig file in the root of your project and install the relevant plugin.

ESLint

ESLint is a pluggable linting utility for JavaScript and JSX to enforce consistent/custom styles/rules across a codebase.

Usage

  1. npm i eslint eslint-config-beardon -D
  2. add "extends": "beardon" to your .eslintrc in the root of your project

For es6 support, extend "beardon/es6" instead.

If you have any complaints with any of the rules used, open an issue and the other developers will discuss/vote.

List of all rules and their meanings.

Releases

No releases published

Packages

No packages published