shinlms404 / eslint-config

My ESLint config preset

@shinlms404/eslint-config

Tip: For an enhanced development experience, it's recommended to use this package with @shinlms404/prettier-config. Check out the prettier-config repository for more details.

Description

This is a custom ESLint configuration preset designed by Charlie Chan. It provides a set of rules and configurations for ESLint to ensure consistent code quality.

Installation

npm install --save-dev @shinlms404/eslint-config

Usage

To use this ESLint configuration, add the following to your project's eslint.config.js file:

import eslintConfigs from '@shinlms404/eslint-config'

export default eslintConfigs()

Configuration

This ESLint configuration includes the following plugins and dependencies:

• @typescript-eslint/eslint-plugin
• @typescript-eslint/parser
• eslint-config-prettier
• eslint-plugin-eslint-comments
• eslint-plugin-jsonc
• eslint-plugin-prettier
• eslint-plugin-sort-keys
• eslint-plugin-unicorn
• eslint-plugin-unused-imports
• eslint-plugin-vue
• eslint-processor-vue-blocks
• jsonc-eslint-parser
• vue-eslint-parser

Scripts

• npm run lint: Run ESLint to lint your code.
• npm run lint:fix: Run ESLint and automatically fix fixable issues.
• npm test: Run tests using Vitest.
• npm run typecheck: Run TypeScript type checking.
• npm run watch: Watch for changes and run ESLint accordingly.

Contributing

Feel free to open issues and pull requests.

License

This project is licensed under the MIT License.

Links

• GitHub Repository
• npm Package

Fork by

• @antfu/eslint-config
• @sxzz/eslint-config

---

Adjust the sections and content based on your specific needs and preferences.