@lntvow/eslint-config 9.2.5 → 9.2.6

package/README.en.md

@@ -0,0 +1,39 @@
+# @lntvow/eslint-config
+
+[中文](README.md) | [English](README.en.md)
+
+## Usage
+
+install @lntvow/eslint-config
+
+```bash
+pnpm install -D @lntvow/eslint-config
+```
+
+create `eslint.config.mjs` in your project root
+
+```js
+// eslint.config.mjs
+import lntvow from '@lntvow/eslint-config'
+
+export default lntvow()
+```
+
+## Plugins
+
+Since flat config requires us to explicitly provide the plugin names (instead of the mandatory convention from npm package name), we renamed some plugins to make the overall scope more consistent and easier to write.
+
+| New Prefix     | Original Prefix        | Source Plugin                                                                              |
+| -------------- | ---------------------- | ------------------------------------------------------------------------------------------ |
+| `typescript/*` | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
+| `vue/*`        | `@vue/*`               | [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue)                            |
+| `import/*`     | `import-x/*`           | [eslint-plugin-import-x](https://github.com/un-es/eslint-plugin-import-x)                  |
+| `style/*`      | `@stylistic/*`         | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic)           |
+
+## Kind Reminder
+
+- If the project is installed via `npm` or `yarn`, you can skip this reminder.
+- If you do not want to manually install `eslint` and other dependencies, and choose to use `pnpm` for installation, please note the following points:
+  - Due to the symbolic link feature of `pnpm` conflicting with the functionality of `eslint`, some packages must be hoisted to the root of `node_modules`.
+  - Create a `.npmrc` file in the root directory of the project and write `shamefully-hoist=true`. This command is used to hoist dependencies to the root of `node_modules`, then you can reinstall the dependencies.
+- Alternatively, you can also choose to manually install `eslint` and other dependencies to the root of `node_modules`.

package/README.md

@@ -1,29 +1,39 @@
 # @lntvow/eslint-config
 
-## Usage
+[English](README.en.md) | [中文](README.md)
 
-install @lntvow/eslint-config
+## 使用
+
+安装 @lntvow/eslint-config
 
 ```bash
 pnpm install -D @lntvow/eslint-config
 ```
 
-create `eslint.config.mjs` in your project root
+创建项目根目录下的 `eslint.config.js`
 
 ```js
-// eslint.config.mjs
+// eslint.config.js
 import lntvow from '@lntvow/eslint-config'
 
 export default lntvow()
 ```
 
-## Plugins
+## 插件
 
-Since flat config requires us to explicitly provide the plugin names (instead of the mandatory convention from npm package name), we renamed some plugins to make the overall scope more consistent and easier to write.
+由于平面配置要求我们显式提供插件名称（而不是 npm 包名称的强制约定），因此我们重命名了一些插件，以使整体范围更加一致且更易于编写。
 
-| New Prefix     | Original Prefix        | Source Plugin                                                                              |
+| 新前缀         | 旧前缀                 | 插件厂库                                                                                   |
 | -------------- | ---------------------- | ------------------------------------------------------------------------------------------ |
 | `typescript/*` | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
 | `vue/*`        | `@vue/*`               | [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue)                            |
 | `import/*`     | `import-x/*`           | [eslint-plugin-import-x](https://github.com/un-es/eslint-plugin-import-x)                  |
 | `style/*`      | `@stylistic/*`         | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic)           |
+
+## 温馨提示
+
+- 如果项目是通过 `npm` 或者 `yarn` 安装的，可以跳过本提示。
+- 如果你不想手动安装 `eslint` 及其他依赖包，选择使用 `pnpm` 进行安装需要注意以下几点：
+  - 由于 `pnpm` 的软链和 `eslint` 的功能存在冲突，所以部分包必须平铺在 `node_modules` 的根目录下。
+  - 在项目的根目录下新建 `.npmrc` 文件，并写入 `shamefully-hoist=true`。这个指令的作用是将依赖平铺到 `node_modules` 的根目录，然后重新安装依赖即可。
+- 另外，你也可以选择手动安装 `eslint` 及其他依赖包至 `node_modules` 的根目录。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lntvow/eslint-config",
-  "version": "9.2.5",
+  "version": "9.2.6",
   "author": "lntvow",
   "description": "eslint-config",
   "type": "module",