eslint-config-metarhia

eslint-config-metarhia

Opinionated ESLint config and de-facto JavaScript styleguide for Metarhia projects.

Usage

1. Install ESLint, this config and required plugins:

   npm i -D eslint eslint-plugin-import eslint-config-metarhia
   

2. Add "extends": "metarhia" to your .eslintrc.

Contributing

Please adhere to Conventional Commits styleguide for commit messages (npm install creates a Git hook that lints your commit messages, and they are also checked on CI, but please write them properly beforehand so that they don't get rejected. If that happens locally while committing, though, don't worry, your commit message isn't lost, you can still find it in .git/COMMIT_EDITMSG).

Releasing

Collaborators can release new versions using

npm run release
git push origin master --follow-tags
npm publish

This will update the version in package.json and package-lock.json according to semantic versioning using commit messages to determine whether it is a patch, minor or major release, update the changelog, tag the new version in Git, and publish it to npm registry.

License

MIT. See the LICENSE file for details.

Changelog

6.0.0 (2018-10-22)

Features

• rules: add no-extra-parens rule (#21) (226fc9c)
• rules: add no-return-assign rule (#19) (e8838ed)
• rules: remove implicit-arrow-linebreak rule (#20) (d4f68d9)

BREAKING CHANGES

• rules: with this change it is allowed to use parentheses only where they are necessary, except for arrow conditionals (to avoid conflicts with no-confusing-arrow rule), return assignments (to avoid conflicts with no-return-assign rule) and nested binary expressions (where parentheses can be used for clarity).

Before:

a = (b * c);

typeof (a);

const fn = () => (
  doSomething()
);

After:

a = b * c;

typeof a;

const fn = () => doSomething();

• rules: before, it was possible to use assignment operators in a return statement without using parentheses, which could lead to some mistakes, where assignment operators are used in place of the comparison operators.

Before:

function doSomething() {
  return foo = bar + 2;
}

After:

function doSomething() {
  return foo === bar + 2;
}

// or

function doSomething() {
  return (foo = bar + 2);
}

<a name="5.0.0"></a>