Lint Shred is a powerful command-line tool designed to help projects that have struggled with ESLint compliance. If your JavaScript and TypeScript codebase is facing a pileup of linting issues due to inconsistent or improper ESLint usage, Lint Shred is here to save the day! This tool enables you to effectively manage ESLint rules and lint your staged files, ensuring that your code remains clean and maintainable while tackling existing issues.
- Automated ESLint Checks: Automatically run ESLint on your staged files.
- Customizable Output: Save linting results to a specified file in JSON format.
- Simple Integration: Easy to integrate into your existing development workflow.
- Error Handling: Graceful error handling with detailed feedback.
# With Yarn
yarn add lint-shred
# With NPM
npm install lint-shredFirst you need to take a snapshot of all current eslint errors within the project. Start by running this in the root directory:
# Generate /eslintbaseline.json
yarn lint-shred generateThis will take some time depending on the project O(N). Be Patient. You only need to run this once
After this has completed you will see a file called eslintbaseline.json In this same DIR, run the following command:
# Compare with staged files
yarn lint-shred compareThis will compare the current staged only files. Any changes introduce will cause this to exit with code 1.
We welcome contributions! If you have suggestions for improvements, feel free to fork the repository and submit a pull request.
Steps to Contribute
- Fork the Repository: Click on the "Fork" button at the top-right corner of this page.
- Create Your Feature Branch
git checkout -b feature/YourFeature- Commit Your Changes
git commit -m "Add some feature"- Push to the Branch
git push origin feature/YourFeature- Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
For inquiries, please contact mayfairr on discord mayfairr.