README.md

Eslint Plugin Rimac

Architecture

• When creating a new rule put it in the src/rules folder
  • Name the file the same as the rule itself
  • For example rimac/import-declaration-newline should be called import-declaration-newline.ts
• Any shared utils/functions/variables should be put into src/utils folder

Resources

• Typescript Eslint Docs
• Writing Custom Rules Guide
• Example Plugin
• Playground

Notes

• ASTree line properties are 1 based

Acknowledgments

• Some of the rules have been taken and modified/updated from the following repos
  • https://github.com/gmsorrow/eslint-plugin-modules-newline