eslint-config-fyfirman
ESLint rules for all of my personal projects. Feel free to use these conventions :-)
!Build Statusbuild-badgebuild !versionversion-badgepackage !downloadsdownloads-badgenpmtrends !MIT Licenselicense-badgelicense !All Contributorsall-contributors-badge !PRs Welcomeprs-badgeprs !Code of Conductcoc-badgecoc
Table of Contents
- 🐛 Bugs - 💡 Feature Requests
Installation
This module is distributed via npmnpm which is bundled with nodenode and should be installed as one of your project'sdevDependencies
:npm install --save-dev eslint-config-fyfirman
This library has a required
peerDependencies
listing for eslint
eslintYou 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 Issuegood-first-issue label.🐛 Bugs
Please file an issue for bugs, missing documentation, or unexpected behavior.See Bugsbugs
💡 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
This project follows the all-contributorsall-contributors specification. Contributions of any kind welcome!