fix(plugin): renaming the plugin to eslint-plugin-readme

readmeio · Oct 31, 2023 · ec48ada · ec48ada
1 parent 8639126
commit ec48ada
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 13 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/eslint-config/esm.js b/packages/eslint-config/esm.js
@@ -1,7 +1,7 @@
 /** @type {import("eslint-define-config").ESLintConfig} */
 const config = {
-  extends: ['plugin:require-extensions/recommended', 'plugin:@readme/esm'],
-  plugins: ['require-extensions', 'unicorn', '@readme'],
+  extends: ['plugin:require-extensions/recommended', 'plugin:readme/esm'],
+  plugins: ['require-extensions', 'unicorn', 'readme'],
   rules: {
     // see here for more rules to possibly enable in the future:
     // https://gist.github.com/Jaid/164668c0151ae09d2bc81be78a203dd5

diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -21,7 +21,6 @@
     "test": "tsc"
   },
   "dependencies": {
-    "@readme/eslint-plugin": "file:../eslint-plugin",
     "@typescript-eslint/eslint-plugin": "^6.2.1",
     "@typescript-eslint/parser": "^6.2.1",
     "eslint-config-airbnb-base": "^15.0.0",
@@ -37,6 +36,7 @@
     "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-react": "^7.33.1",
     "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-readme": "file:../eslint-plugin",
     "eslint-plugin-require-extensions": "^0.1.3",
     "eslint-plugin-testing-library": "^6.0.1",
     "eslint-plugin-typescript-sort-keys": "^3.0.0",

diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md
@@ -4,15 +4,15 @@ Custom ESLint plugin for some ReadMe engineering guidelines and gotchas.
 
 [![](https://raw.githubusercontent.com/readmeio/.github/main/oss-header.png)](https://readme.io)
 
-[![npm](https://img.shields.io/npm/v/@readme/eslint-plugin)](https://npm.im/@readme/eslint-plugin) [![Build](https://github.com/readmeio/standards/workflows/CI/badge.svg)](https://github.com/readmeio/standards)
+[![npm](https://img.shields.io/npm/v/eslint-plugin-readme)](https://npm.im/eslint-plugin-readme) [![Build](https://github.com/readmeio/standards/workflows/CI/badge.svg)](https://github.com/readmeio/standards)
 
 ## Usage
 
 In `.eslintrc` file add the following line:
 
 ```js
-extends: ['plugin:@readme/<config>'],
-plugins: ['@readme'],
+extends: ['plugin:readme/<config>'],
+plugins: ['readme'],
 ```
 
 ## 🔖 Available Configs

diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@readme/eslint-plugin",
+  "name": "eslint-plugin-readme",
   "version": "1.1.0",
   "description": "ESLint plugin providing custom rules for ReadMe's coding standards",
   "main": "index.js",