@aliexme/eslint-config 0.4.3 → 1.0.0

package/README.md

@@ -4,95 +4,75 @@ Rule set for ESLint
 
 ## Installation
 
-```
-npm i --save-dev eslint @aliexme/eslint-config eslint-plugin-import
+```sh
+npm i --save-dev eslint @aliexme/eslint-config
 ```
 
 ## Usage
 
 Extend your ESLint config file:
 
-```
-{
-  "extends": [
-    "@aliexme/eslint-config",
-  ],
-}
-```
-
-### Typescript
-
-To check ts-files, install additional packages:
-
-```
-npm i --save-dev @typescript-eslint/parser @typescript-eslint/eslint-plugin
-```
-
-And add the following lines to your ESLint config file:
+```js
+import eslintConfigRecommended from '@aliexme/eslint-config'
 
-```
-{
-  "extends": [
-    "@aliexme/eslint-config",
-    "@aliexme/eslint-config/typescript",
-  ],
-}
+export default [
+  ...eslintConfigRecommended, // <--
+]
 ```
 
 ### React
 
 Install additional packages:
 
-```
+```sh
 npm i --save-dev eslint-plugin-react eslint-plugin-react-hooks
 ```
 
 And add the following lines to your ESLint config file:
 
-```
-{
-  "extends": [
-    "@aliexme/eslint-config",
-    "@aliexme/eslint-config/react",
-    "plugin:react-hooks/recommended",
-  ],
-}
+```js
+import eslintConfigReact from '@aliexme/eslint-config/react'
+
+export default [
+  ...eslintConfigRecommended,
+  ...eslintConfigReact, // <--
+]
 ```
 
 ### React Native
 
 Install additional packages:
 
-```
+```sh
 npm i --save-dev eslint-plugin-react-native
 ```
 
 And add the following lines to your ESLint config file:
 
-```
-{
-  "extends": [
-    "@aliexme/eslint-config",
-    "@aliexme/eslint-config/react-native",
-  ],
-}
+```js
+import eslintConfigReactNative from '@aliexme/eslint-config/react-native'
+
+export default [
+  ...eslintConfigRecommended,
+  ...eslintConfigReactNative, // <--
+]
 ```
 
 ### Prettier
 
 Install additional packages:
 
-```
+```sh
 npm i --save-dev prettier eslint-plugin-prettier eslint-config-prettier
 ```
 
 And add the following lines to your ESLint config file:
 
-```
-{
-  "extends": [
-    "@aliexme/eslint-config",
-    "@aliexme/eslint-config/prettier",
-  ],
-}
+```js
+import eslintConfigPrettier from '@aliexme/eslint-config/prettier'
+
+export default [
+  ...eslintConfigRecommended,
+  ...eslintConfigPrettier, // <--
+]
 ```

package/dist/compat.d.ts

@@ -0,0 +1,3 @@
+import { FlatCompat } from '@eslint/eslintrc';
+export declare const compat: FlatCompat;
+export declare const legacyPlugin: (name: string, alias?: string) => import("eslint").ESLint.Plugin;

package/dist/compat.js

@@ -0,0 +1,11 @@
+import { FlatCompat } from '@eslint/eslintrc';
+import { fixupPluginRules } from '@eslint/compat';
+export const compat = new FlatCompat();
+export const legacyPlugin = (name, alias = name) => {
+    const plugin = compat.plugins(name)[0]?.plugins?.[alias];
+    if (!plugin) {
+        throw new Error(`Unable to resolve plugin ${name} and/or alias ${alias}`);
+    }
+    return fixupPluginRules(plugin);
+};
+//# sourceMappingURL=compat.js.map

package/dist/compat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compat.js","sourceRoot":"","sources":["../src/compat.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAEjD,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAA;AAEtC,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,KAAK,GAAG,IAAI,EAAE,EAAE;IACzD,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,CAAA;IAExD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,iBAAiB,KAAK,EAAE,CAAC,CAAA;IAC3E,CAAC;IAED,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAA;AACjC,CAAC,CAAA"}