Table of Contents

• Table of Contents
• Installation
• Usage
• Issues
  • 🐛 Bugs
  • 💡 Feature Requests

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's devDependencies:

npm install --save-dev eslint-config-fyfirman

This library has a required peerDependencies listing for eslint

You should also install those library to resolve Typescript import:

npm install --save-dev eslint-import-resolver-typescript

Usage

Then add the extends to your .eslintrc.js:

module.exports = {
  extends: 'fyfirman',
  rules: {
    // your overrides
  },
}

It is recommended to put the command in your package.json:

{
  "scripts": {
    "lint": "eslint \"**/*.{ts,tsx}\" --no-error-on-unmatched-pattern",
    "lint:fix": "eslint \"**/*.{ts,tsx}\" --no-error-on-unmatched-pattern --fix"
  },
}

Issues

Looking to contribute? Look for the Good First Issue label.

🐛 Bugs

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

See 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 Requests

This project follows the all-contributors specification. Contributions of any kind welcome!