@mykyta-isai/eslint-config
v1.0.3
Published
My shared ESLint configuration
Maintainers
Readme
@mykyta-isai/eslint-config
This is my custom ESLint configuration for TypeScript projects, designed to ensure a clean and consistent code style. It includes TypeScript support, import order rules, and various best practices.
🚀 Installation
To use this ESLint configuration in your project, install it along with the required peer dependencies:
npm install --save-dev @mykyta-isai/eslint-config eslint @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-importor if you use Yarn:
yarn add --dev @mykyta-isai/eslint-config eslint @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-import🛠️ Usage To enable this ESLint configuration in your project, create an eslint.config.js file in the root of your project and extend the config from this package.
✅ ESM Projects If your project uses "type": "module" in package.json, use this:
// eslint.config.js
import eslintConfig from "@mykyta-isai/eslint-config";
export default eslintConfig;✅ CommonJS Projects If your project uses the default CommonJS format (no "type": "module" in package.json), use this instead:
// eslint.config.js
const eslintConfig = require("@mykyta-isai/eslint-config");
module.exports = eslintConfig.default;🧪 Example Lint Script
You can add this to your package.json:
"scripts": {
"lint": "eslint . --ext .ts"
}Then run:
yarn lint