Codeverse Linter Configuration

:white_check_mark: An ESLint Shareable Config for Americademy

Don't be afraid to open an Issue about anything that annoys you; this is here to support us, not get in our way.

Install

This package is a transitive dependency of our usual @codeverse/gulp-registry package; so if you've a Gulpfile, you probably don't need to install this manually. Otherwise,

npm install --save-dev @codeverse/eslint-config

Usage

Shareable configs are designed to work with the extends feature of .eslintrc files. You can learn more about Shareable Configs on the official ESLint website.

Add this to your .eslintrc.json (or equivalent) file:

{
  "extends": "@codeverse"
}

Note: We omitted the eslint-config suffix here since it is automatically assumed by ESLint. You can override settings from this shareable config by adding them directly into your .eslintrc.json file.

Next, add a .prettierrc.js:

module.exports = require('@codeverse/eslint-config/prettierrc');

Learn more

For the full listing of rules visit ESLint.org. Avoid stylistic rules that may conflict with Prettier; we only use ESLint for its semantic rules.

License

MIT. Copyright (c) Americademy, Inc.