eslint-config-ricveal

ESLint rules according to ricveal's personal preference

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
eslint-config-ricveal
1.2.0a year ago3 years agoMinified + gzip package size for eslint-config-ricveal in KB

Readme

eslint-config-ricveal

ESLint rules for all of my personal projects. Feel free to use these conventions :-)


!Build Statusbuild-badgebuild !versionversion-badgepackage !downloadsdownloads-badgenpmtrends !PRs Welcomeprs-badgeprs

Table of Contents


- Other configs - Things to know - 🐛 Bugs - 💡 Feature Requests

Installation

This module is distributed via npmnpm which is bundled with nodenode and should be installed as one of your project's devDependencies:
npm install --save-dev eslint-config-ricveal

This library has a required peerDependencies listing for eslinteslint

Usage

Then add the extends to your .eslintrc.js:
module.exports = {
  extends: 'ricveal',
  rules: {
    // your overrides
  },
}

Other configs

This config also exposes a few other configs that I use often and pull in as needed.
You can use them standalone:
module.exports = {
  extends: 'ricveal/<config-name>',
}

Or in combination with the base config (recommended)
module.exports = {
  extends: ['ricveal', 'ricveal/<config-name>'],
}

Things to know

  • All plugins needed for rules used by these configs are dependencies of this
module so you don't have to install anything on your own.
  • The default config actually is composed of several configurations and you can
use those individually. You can use each of these configs yourself if you want to leave my own personal style out of it.

Example of customized config

module.exports = {
  extends: ['ricveal/import', 'ricveal/jest'],
  rules: {
    /* custom rules */
  },
}

Issues

Looking to contribute? Look for the Good First Issuegood-first-issue label.

🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.
See Bugs
bugs

💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.
See Feature Requestsrequests

Contributors ✨

Contributions of any kind welcome!

LICENSE

MIT