@icebreakers/eslint-config 0.0.3 → 0.2.0

package/README.md

@@ -0,0 +1,34 @@
+# @icebreakers/eslint-config
+
+> extend [@antfu/eslint-config](https://www.npmjs.com/package/@antfu/eslint-config) and add `prettier` support!
+
+## Usage
+
+```bash
+pnpm i -D eslint @icebreakers/eslint-config
+```
+
+```ts
+// eslint.config.mjs
+import { icebreaker } from '@icebreakers/eslint-config'
+
+export default icebreaker()
+```
+
+or use with `prettier`:
+
+```ts
+// eslint.config.mjs
+import { icebreaker } from '@icebreakers/eslint-config'
+
+export default icebreaker({
+  prettier: true,
+  stylistic: false,
+})
+```
+
+## VS Code support
+
+Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+
+Version: `^3.0.5` ( >=`3.0.5`)

package/dist/antfu.cjs

@@ -0,0 +1,9 @@
+'use strict';
+
+const eslintConfig = require('@antfu/eslint-config');
+
+
+
+Object.keys(eslintConfig).forEach(function (k) {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) exports[k] = eslintConfig[k];
+});

package/dist/antfu.d.cts

@@ -0,0 +1 @@
+export * from '@antfu/eslint-config';

package/dist/antfu.d.mts

@@ -0,0 +1 @@
+export * from '@antfu/eslint-config';

package/dist/antfu.d.ts

@@ -0,0 +1 @@
+export * from '@antfu/eslint-config';

package/dist/antfu.mjs

@@ -0,0 +1 @@
+export * from '@antfu/eslint-config';

package/dist/index.cjs

@@ -1,22 +1,36 @@
 'use strict';
 
-const eslintConfig = require('@sxzz/eslint-config');
-const eslintConfig$1 = require('@antfu/eslint-config');
+const eslintPluginPrettierRecommended = require('eslint-plugin-prettier/recommended');
+const eslintrc = require('@eslint/eslintrc');
+const localPkg = require('local-pkg');
+const eslintConfig = require('@antfu/eslint-config');
 
-function icebreakerWithPrettier(config, rules) {
-  return eslintConfig.sxzz(rules, config);
-}
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const eslintPluginPrettierRecommended__default = /*#__PURE__*/_interopDefaultCompat(eslintPluginPrettierRecommended);
 
-function icebreaker(options, ...userConfigs) {
-  return eslintConfig$1.antfu(options, {
-    rules: {
-      "curly": ["error", "all"],
-      "no-console": ["warn"],
-      "ts/prefer-ts-expect-error": "off",
-      "ts/ban-ts-comment": "off"
+const compat = new eslintrc.FlatCompat();
+function icebreaker(options = {}, ...userConfigs) {
+  const { prettier, tailwindcss: enableTailwindcss = localPkg.isPackageExists("tailwindcss"), ...opts } = options;
+  const presets = [
+    {
+      rules: {
+        "curly": ["error", "all"],
+        "no-console": ["warn"],
+        "ts/prefer-ts-expect-error": "off",
+        "ts/ban-ts-comment": "off"
+      }
     }
-  }, ...userConfigs);
+  ];
+  if (options?.prettier) {
+    presets.push(eslintPluginPrettierRecommended__default);
+  }
+  if (enableTailwindcss) {
+    presets.push(...compat.config({
+      extends: ["plugin:tailwindcss/recommended"]
+    }));
+  }
+  return eslintConfig.antfu(opts, ...presets, ...userConfigs);
 }
 
 exports.icebreaker = icebreaker;
-exports.icebreakerWithPrettier = icebreakerWithPrettier;

package/dist/index.d.cts

@@ -1,12 +1,13 @@
-import { sxzz } from '@sxzz/eslint-config';
-import { FlatESLintConfigItem } from 'eslint-define-config';
-import { Linter } from 'eslint';
 import { OptionsConfig, TypedFlatConfigItem, Awaitable, ConfigNames } from '@antfu/eslint-config';
 import { FlatConfigComposer } from 'eslint-flat-config-utils';
+import { Linter } from 'eslint';
 
-type UserDefinedConfig = Parameters<typeof sxzz>[1];
-declare function icebreakerWithPrettier(config?: UserDefinedConfig, rules?: FlatESLintConfigItem | FlatESLintConfigItem[]): FlatESLintConfigItem[];
+type UserDefinedOptions = OptionsConfig & TypedFlatConfigItem & {
+    prettier?: boolean;
+    tailwindcss?: boolean;
+};
+type UserConfigItem = Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[] | FlatConfigComposer<any, any> | Linter.FlatConfig[]>;
 
-declare function icebreaker(options?: OptionsConfig & TypedFlatConfigItem, ...userConfigs: Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[] | FlatConfigComposer<any, any> | Linter.FlatConfig[]>[]): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
+declare function icebreaker(options?: UserDefinedOptions, ...userConfigs: UserConfigItem[]): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
 
-export { icebreaker, icebreakerWithPrettier };
+export { type UserConfigItem, type UserDefinedOptions, icebreaker };

package/dist/index.d.mts

@@ -1,12 +1,13 @@
-import { sxzz } from '@sxzz/eslint-config';
-import { FlatESLintConfigItem } from 'eslint-define-config';
-import { Linter } from 'eslint';
 import { OptionsConfig, TypedFlatConfigItem, Awaitable, ConfigNames } from '@antfu/eslint-config';
 import { FlatConfigComposer } from 'eslint-flat-config-utils';
+import { Linter } from 'eslint';
 
-type UserDefinedConfig = Parameters<typeof sxzz>[1];
-declare function icebreakerWithPrettier(config?: UserDefinedConfig, rules?: FlatESLintConfigItem | FlatESLintConfigItem[]): FlatESLintConfigItem[];
+type UserDefinedOptions = OptionsConfig & TypedFlatConfigItem & {
+    prettier?: boolean;
+    tailwindcss?: boolean;
+};
+type UserConfigItem = Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[] | FlatConfigComposer<any, any> | Linter.FlatConfig[]>;
 
-declare function icebreaker(options?: OptionsConfig & TypedFlatConfigItem, ...userConfigs: Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[] | FlatConfigComposer<any, any> | Linter.FlatConfig[]>[]): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
+declare function icebreaker(options?: UserDefinedOptions, ...userConfigs: UserConfigItem[]): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
 
-export { icebreaker, icebreakerWithPrettier };
+export { type UserConfigItem, type UserDefinedOptions, icebreaker };

package/dist/index.d.ts

@@ -1,12 +1,13 @@
-import { sxzz } from '@sxzz/eslint-config';
-import { FlatESLintConfigItem } from 'eslint-define-config';
-import { Linter } from 'eslint';
 import { OptionsConfig, TypedFlatConfigItem, Awaitable, ConfigNames } from '@antfu/eslint-config';
 import { FlatConfigComposer } from 'eslint-flat-config-utils';
+import { Linter } from 'eslint';
 
-type UserDefinedConfig = Parameters<typeof sxzz>[1];
-declare function icebreakerWithPrettier(config?: UserDefinedConfig, rules?: FlatESLintConfigItem | FlatESLintConfigItem[]): FlatESLintConfigItem[];
+type UserDefinedOptions = OptionsConfig & TypedFlatConfigItem & {
+    prettier?: boolean;
+    tailwindcss?: boolean;
+};
+type UserConfigItem = Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[] | FlatConfigComposer<any, any> | Linter.FlatConfig[]>;
 
-declare function icebreaker(options?: OptionsConfig & TypedFlatConfigItem, ...userConfigs: Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[] | FlatConfigComposer<any, any> | Linter.FlatConfig[]>[]): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
+declare function icebreaker(options?: UserDefinedOptions, ...userConfigs: UserConfigItem[]): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
 
-export { icebreaker, icebreakerWithPrettier };
+export { type UserConfigItem, type UserDefinedOptions, icebreaker };

package/dist/index.mjs

@@ -1,19 +1,30 @@
-import { sxzz } from '@sxzz/eslint-config';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import { FlatCompat } from '@eslint/eslintrc';
+import { isPackageExists } from 'local-pkg';
 import { antfu } from '@antfu/eslint-config';
 
-function icebreakerWithPrettier(config, rules) {
-  return sxzz(rules, config);
-}
-
-function icebreaker(options, ...userConfigs) {
-  return antfu(options, {
-    rules: {
-      "curly": ["error", "all"],
-      "no-console": ["warn"],
-      "ts/prefer-ts-expect-error": "off",
-      "ts/ban-ts-comment": "off"
+const compat = new FlatCompat();
+function icebreaker(options = {}, ...userConfigs) {
+  const { prettier, tailwindcss: enableTailwindcss = isPackageExists("tailwindcss"), ...opts } = options;
+  const presets = [
+    {
+      rules: {
+        "curly": ["error", "all"],
+        "no-console": ["warn"],
+        "ts/prefer-ts-expect-error": "off",
+        "ts/ban-ts-comment": "off"
+      }
     }
-  }, ...userConfigs);
+  ];
+  if (options?.prettier) {
+    presets.push(eslintPluginPrettierRecommended);
+  }
+  if (enableTailwindcss) {
+    presets.push(...compat.config({
+      extends: ["plugin:tailwindcss/recommended"]
+    }));
+  }
+  return antfu(opts, ...presets, ...userConfigs);
 }
 
-export { icebreaker, icebreakerWithPrettier };
+export { icebreaker };

package/package.json

@@ -1,17 +1,26 @@
 {
   "name": "@icebreakers/eslint-config",
-  "version": "0.0.3",
+  "version": "0.2.0",
   "description": "icebreakers's eslint config",
-  "keywords": [],
+  "keywords": [
+    "eslint-config",
+    "prettier"
+  ],
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
-    }
+    },
+    "./antfu": {
+      "types": "./dist/antfu.d.ts",
+      "import": "./dist/antfu.mjs",
+      "require": "./dist/antfu.cjs"
+    },
+    "./*": "./*"
   },
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -19,11 +28,25 @@
   "files": [
     "dist"
   ],
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/*",
+        "./dist/index.d.ts"
+      ]
+    }
+  },
   "dependencies": {
-    "@antfu/eslint-config": "2.17.0",
-    "@sxzz/eslint-config": "3.11.0"
+    "@antfu/eslint-config": "2.18.0",
+    "@eslint/eslintrc": "^3.0.2",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-tailwindcss": "^3.15.1",
+    "local-pkg": "^0.5.0"
+  },
+  "devDependencies": {
+    "eslint": "^9.2.0"
   },
-  "devDependencies": {},
   "scripts": {
     "dev": "unbuild --sourcemap",
     "build": "unbuild",