Skip to content

Commit

Permalink
chore: rename to depend
Browse files Browse the repository at this point in the history
  • Loading branch information
43081j committed Mar 9, 2024
1 parent 260f685 commit 2b79e54
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 16 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# 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.

## Install

```sh
npm i -D eslint-plugin-optimize
npm i -D eslint-plugin-depend
```

## Usage
Expand All @@ -19,15 +18,15 @@ Add to your `.eslintrc.json`:
```json
{
"extends": [
"plugin:optimize/recommended"
"plugin:depend/recommended"
]
}
```

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,
Expand All @@ -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

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion src/configs/recommended.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export const recommended = {
plugins: ['optimize'],
plugins: ['depend'],
rules: {}
};
1 change: 0 additions & 1 deletion test/fixtures/no-engines/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}

0 comments on commit 2b79e54

Please sign in to comment.