npm package: @shinlms404/eslint-config
Description: My ESLint config preset
Author: Charlie Chan
Latest version: 1.0.1

# @shinlms404/eslint-config

[![npm version](https://badge.fury.io/js/%40shinlms404%2Feslint-config.svg)](https://badge.fury.io/js/%40shinlms404%2Feslint-config)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

> **Tip:** For an enhanced development experience, it's recommended to use this package with [@shinlms404/prettier-config](https://www.npmjs.com/package/@shinlms404/prettier-config). Check out the [prettier-config repository](https://github.com/shinlms404/prettier-config) 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

```bash
npm install --save-dev @shinlms404/eslint-config
```

## Usage

To use this ESLint configuration, add the following to your project's `eslint.config.js` file:

```js
import eslintConfigs from '@shinlms404/eslint-config'

export default eslintConfigs()
```

## Configuration

This ESLint configuration includes the following plugins and dependencies:

- [@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)
- [@typescript-eslint/parser](https://www.npmjs.com/package/@typescript-eslint/parser)
- [eslint-config-prettier](https://www.npmjs.com/package/eslint-config-prettier)
- [eslint-plugin-eslint-comments](https://www.npmjs.com/package/eslint-plugin-eslint-comments)
- [eslint-plugin-jsonc](https://www.npmjs.com/package/eslint-plugin-jsonc)
- [eslint-plugin-prettier](https://www.npmjs.com/package/eslint-plugin-prettier)
- [eslint-plugin-sort-keys](https://www.npmjs.com/package/eslint-plugin-sort-keys)
- [eslint-plugin-unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn)
- [eslint-plugin-unused-imports](https://www.npmjs.com/package/eslint-plugin-unused-imports)
- [eslint-plugin-vue](https://www.npmjs.com/package/eslint-plugin-vue)
- [eslint-processor-vue-blocks](https://www.npmjs.com/package/eslint-processor-vue-blocks)
- [jsonc-eslint-parser](https://www.npmjs.com/package/jsonc-eslint-parser)
- [vue-eslint-parser](https://www.npmjs.com/package/vue-eslint-parser)

## Scripts

- `npm run build`: Build project for ESM/CJS formats with type definitions
- `npm run lint`: Run ESLint to lint your code
- `npm run lint:fix`: Automatically fix fixable ESLint issues
- `npm run prepack`: Auto-run build before packaging (npm lifecycle hook)
- `npm run prepare`: Setup git hooks with simple-git-hooks
- `npm run release`: Bump version and publish to npm
- `npm run stub`: Quick build without cleanup/type definitions
- `npm test`: Run tests with Vitest
- `npm run typecheck`: Run TypeScript type checking
- `npm run watch`: Watch files and rebuild on changes

## Contributing

Feel free to open issues and pull requests.

## License

This project is licensed under the [MIT License](LICENSE).

## Links

- [GitHub Repository](https://github.com/shinlms404/eslint-config)
- [npm Package](https://www.npmjs.com/package/@shinlms404/eslint-config)

## Fork by

- [@antfu/eslint-config](https://github.com/antfu/eslint-config)
- [@sxzz/eslint-config](https://github.com/sxzz/eslint-config)

---

Adjust the sections and content based on your specific needs and preferences.