bloq / eslint-config-bloq

Bloq's ESLint shareable config

eslint-config-bloq

This is Bloq's ESLint shareable config.

It is based on the ESLint recommended rules and other well-known plugins and configs.

Install

npm install --save-dev eslint eslint-config-bloq

Configuration

Add this to the ESLint configuration file:

{
  "extends": ["bloq"]
}

Additional rule sets are available: bloq/node, bloq/next and bloq/mocha.

Note on code formatting

This package is focused on identifying code patterns that are or lead to common errors. It is not intended to deal with code formatting and coding styles (even when a few rules may still be enabled).

License

MIT

eslint-config-bloq's Issues

Move the publishing pipeline to GitHub Actions

Current publishing script is set to run in Travis CI but it is not working as the account has no more credits. Let's migrate the publishing pipeline to GitHub Actions instead.

Update publishing script

The current script triggers on tag builds but tags may be applied before merging the changes to master.

Add eslint-plugin-html configuration

We've used eslint-plugin-html in some of our projects, it would be useful to add it here

Migrate JSDoc rules to plugin after deprecation

Enable sort-keys rule

See this eslint rule which should allow us to show a warn when properties are not sorted

Add missing peer dependencies to docs

Full list of dependencies required:

eslint, eslint-config-bloq, eslint-config-prettier, eslint-config-standard, eslint-plugin-import, eslint-plugin-jsdoc, eslint-plugin-mocha, eslint-plugin-node, eslint-plugin-prefer-arrow, eslint-plugin-prettier, eslint-plugin-promise, eslint-plugin-require-path-exists, eslint-plugin-standard, prettier

Prettier configuration:

{
  "singleQuote": true,
  "semi": false
}

Add eslint plugin for package.json

This eslint-plugin should allow us to lint the package.json files and have the scripts and dependencies in order

Improve community standards

Check what is missing:

https://github.com/bloq/eslint-config-bloq/community

Update rules to incorporate Prettier

Current config file required much more than just extending bloq:

{
  "extends": ["bloq", "plugin:prettier/recommended"],
  "rules": {
    "jsdoc/require-jsdoc": "off",
    "semi": ["error", "never"],
    "quotes": ["error", "single"]
  }
}

Those should be incorporated to the base.js config file.

Add typescript configuration

Two plugins that could be useful for us

"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended",