Skip to content

leosuncin/eslint-config-typescript

Repository files navigation

eslint config for typescript projects 👋

Version Documentation Maintenance License: MIT Twitter: jl_suncin

A set of recommended eslint rules for typescript projects

Install

npm install --dev @suncin/eslint-config-typescript

Then extends your eslint file (edit .eslintrc.json)

{
  "extends": ["@suncin/typescript"]
}

Other configs

{
  "extends": [
    "@suncin/typescript",
    "@suncin/typescript/security",
    "@suncin/typescript/jest"
    "@suncin/typescript/all"
  ]
}

Note: @suncin/typescript/all include @suncin/typescript/security and @suncin/typescript/jest configs.

Example configuration

{
  "extends": ["@suncin/typescript/all"],
  "plugins": ["filenames"],
  "env": {
    "node": true
  },
  "rules": {
    "filenames/no-index": "error",
    "filenames/match-exported": ["error", "kebab"]
  }
}

Run tests

npm test

Author

👤 Jaime Leonardo Suncin Cruz

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

Buy Me A Coffee

📝 License

Copyright © 2020 Jaime Leonardo Suncin Cruz.
This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator