diff --git a/README.md b/README.md index a689f7e..0f4c83c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ -# eslint-plugin-optimize +# eslint-plugin-depend -This is an ESLint plugin to suggest various optimizations in your -sources. +This is an ESLint plugin to help suggest alternatives to various dependencies. Primarily, it will help detect dependency tree bloat and redundant polyfills. @@ -9,7 +8,7 @@ polyfills. ## Install ```sh -npm i -D eslint-plugin-optimize +npm i -D eslint-plugin-depend ``` ## Usage @@ -19,7 +18,7 @@ Add to your `.eslintrc.json`: ```json { "extends": [ - "plugin:optimize/recommended" + "plugin:depend/recommended" ] } ``` @@ -27,7 +26,7 @@ Add to your `.eslintrc.json`: Or if you're using (flat) config files, add to your `eslint.config.js`: ```ts -import {configs} from 'eslint-plugin-optimize'; +import {configs} from 'eslint-plugin-depend'; export default [ configs.recommended, @@ -42,8 +41,8 @@ export default [ ## Rules -- [`optimize/redundant-polyfills`](./docs/rules/redundant-polyfills.md) -- [`optimize/avoid-micro-utilities`](./docs/rules/avoid-micro-utilities.md) +- [`depend/redundant-polyfills`](./docs/rules/redundant-polyfills.md) +- [`depend/avoid-micro-utilities`](./docs/rules/avoid-micro-utilities.md) ## License diff --git a/package-lock.json b/package-lock.json index 89b02ca..3cd62aa 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "eslint-plugin-optimize", + "name": "eslint-plugin-depend", "version": "0.0.1", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "eslint-plugin-optimize", + "name": "eslint-plugin-depend", "version": "0.0.1", "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index e273d1a..ea36829 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "eslint-plugin-optimize", + "name": "eslint-plugin-depend", "version": "0.0.1", "description": "An ESLint plugin to suggest optimized dependencies, native alternatives and more", "main": "lib/main.js", @@ -19,7 +19,7 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/es-tooling/eslint-plugin-optimize.git" + "url": "git+https://github.com/es-tooling/eslint-plugin-depend.git" }, "keywords": [ "eslint", @@ -32,9 +32,9 @@ "author": "James Garbutt (https://github.com/43081j)", "license": "MIT", "bugs": { - "url": "https://github.com/es-tooling/eslint-plugin-optimize/issues" + "url": "https://github.com/es-tooling/eslint-plugin-depend/issues" }, - "homepage": "https://github.com/es-tooling/eslint-plugin-optimize#readme", + "homepage": "https://github.com/es-tooling/eslint-plugin-depend#readme", "devDependencies": { "@eslint/js": "^8.56.0", "@types/eslint": "^8.56.5", diff --git a/src/configs/recommended.ts b/src/configs/recommended.ts index 81de56c..4e12105 100644 --- a/src/configs/recommended.ts +++ b/src/configs/recommended.ts @@ -1,4 +1,4 @@ export const recommended = { - plugins: ['optimize'], + plugins: ['depend'], rules: {} }; diff --git a/test/fixtures/no-engines/package.json b/test/fixtures/no-engines/package.json index e430a89..0b40158 100644 --- a/test/fixtures/no-engines/package.json +++ b/test/fixtures/no-engines/package.json @@ -2,6 +2,5 @@ "name": "no-engines", "private": true, "version": "0.0.1", - "description": "An ESLint plugin to suggest optimized dependencies, native alternatives and more", "main": "lib/main.js" }