@fullstacksjs/eslint-config 11.1.18 → 11.1.19

package/README.md

@@ -20,12 +20,22 @@ $ npm install --save-dev @fullstacksjs/eslint-config eslint prettier
 
 To use the configuration all you need is exporting generated config by `init` function. The configuration reads the metadata from your root `package.json` file and automatically adds the rules and plugins that are needed.
 
+### ESM
+
 ```js
 import { init } from '@fullstacksjs/eslint-config';
 
 export default init();
 ```
 
+### CJS
+
+```js
+const { init } = require('@fullstacksjs/eslint-config');
+
+module.exports = init();
+```
+
 ## Modules API
 
 You can fine tune module detection by overriding it, `init` function accepts options as its first argument to control enabled modules.
@@ -70,7 +80,13 @@ import { init } from '@fullstacksjs/eslint-config';
 export default init(
   {
     typescript: true,
-  }, {
+    // You can pass extends here
+    rules {
+      'no-console': 'error'
+    }
+  },
+  // And any number of extra configurations
+  {
     files: ['**/*.ts'],
     rules: {},
   }, {

package/cjs/index.js

@@ -9,6 +9,7 @@ var _localPkg = require("local-pkg");
 var _base = _interopRequireDefault(require("./modules/base.js"));
 var _cypress = _interopRequireDefault(require("./modules/cypress.js"));
 var _functional = _interopRequireDefault(require("./modules/functional.js"));
+var _ignore = _interopRequireDefault(require("./modules/ignore.js"));
 var _imports = _interopRequireDefault(require("./modules/imports.js"));
 var _jest = _interopRequireDefault(require("./modules/jest.js"));
 var _next = _interopRequireDefault(require("./modules/next.js"));
@@ -22,11 +23,15 @@ var _tailwind = _interopRequireDefault(require("./modules/tailwind.js"));
 var _tests = _interopRequireDefault(require("./modules/tests.js"));
 var _typescript = _interopRequireDefault(require("./modules/typescript.js"));
 var _vitest = _interopRequireDefault(require("./modules/vitest.js"));
-var _compose = require("./utils/compose.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const testPackages = ['jest', 'vitest', 'cypress', 'playwright'];
 
-/** @type {import('./option.d.ts').Options} */
+/**
+ * @typedef {import('eslint').Linter.Config} Config
+ * @typedef {import('./option.d.ts').Options} Options
+ * /
+
+/** @type {Options} */
 const defaultOptions = {
   cypress: (0, _localPkg.isPackageExists)('cypress'),
   disableExpensiveRules: false,
@@ -48,18 +53,16 @@ const defaultOptions = {
   typescript: (0, _localPkg.isPackageExists)('typescript') ? {
     projects: true
   } : false,
-  unocss: (0, _localPkg.isPackageExists)('unocss'),
   vitest: (0, _localPkg.isPackageExists)('vitest')
 };
 
 /**
  * Initialize eslint config
- *
- * @param {import('./option.d.ts').Options} initOptions
- * @param {...(import('eslint').Linter.Config)} extend
- * @returns {import('eslint').Linter.Config[]}
+ * @param {Options} initOptions
+ * @param {...Config} extend
+ * @returns {Config[]}
  */
-function init(initOptions, ...extend) {
+function init(initOptions = {}, ...extend) {
   const options = (0, _deepmerge.default)(defaultOptions, initOptions);
   if (options.typescript === true) {
     options.typescript = {};
@@ -67,21 +70,45 @@ function init(initOptions, ...extend) {
   if (options.import === true) {
     options.import = {};
   }
-  const rules = [(0, _compose.compose)(_base.default, options)];
-  if (options.fp) rules.push((0, _compose.compose)(_functional.default, options));
-  if (options.sort) rules.push((0, _compose.compose)(_perfectionist.default, options));
-  if (options.import) rules.push((0, _compose.compose)(_imports.default, options));
-  if (options.tailwind) rules.push((0, _compose.compose)(_tailwind.default, options));
-  if (options.test) rules.push((0, _compose.compose)(_tests.default, options));
-  if (options.node) rules.push((0, _compose.compose)(_node.default, options));
-  if (options.jest) rules.push((0, _compose.compose)(_jest.default, options));
-  if (options.vitest) rules.push((0, _compose.compose)(_vitest.default, options));
-  if (options.cypress) rules.push((0, _compose.compose)(_cypress.default, options));
-  if (options.react) rules.push((0, _compose.compose)(_react.default, options));
-  if (options.storybook) rules.push((0, _compose.compose)(_storybook.default, options));
-  if (options.typescript) rules.push((0, _compose.compose)(_typescript.default, options));
-  if (options.playwright) rules.push((0, _compose.compose)(_playwright.default, options));
-  if (options.next && options.next) rules.push((0, _compose.compose)(_next.default, options));
-  if (options.prettier) rules.push((0, _compose.compose)(_prettier.default, options));
-  return rules.concat(extend);
+  const {
+    sort: enableSort,
+    cypress: enableCypress,
+    disableExpensiveRules,
+    esm: enableEsm,
+    fp: enableFp,
+    ignores: enableIgnores,
+    import: enableImport,
+    jest: enableJest,
+    next: enableNext,
+    node: enableNode,
+    playwright: enablePlaywright,
+    prettier: enablePrettier,
+    react: enableReact,
+    storybook: enableStorybook,
+    strict: enableStrict,
+    tailwind: enableTailwind,
+    test: enableTest,
+    typescript: enableTypescript,
+    vitest: enableVitest,
+    ...eslintOptions
+  } = options;
+  const rules = [(0, _ignore.default)(options), (0, _base.default)(options)];
+  if (enableFp) rules.push((0, _functional.default)(options));
+  if (enableSort) rules.push((0, _perfectionist.default)(options));
+  if (enableImport) rules.push((0, _imports.default)(options));
+  if (enableTailwind) rules.push((0, _tailwind.default)(options));
+  if (enableTest) rules.push((0, _tests.default)(options));
+  if (enableNode) rules.push((0, _node.default)(options));
+  if (enableJest) rules.push((0, _jest.default)(options));
+  if (enableVitest) rules.push((0, _vitest.default)(options));
+  if (enableCypress) rules.push((0, _cypress.default)(options));
+  if (enableReact) rules.push((0, _react.default)(options));
+  if (enableStorybook) rules.push((0, _storybook.default)(options));
+  if (enableTypescript) rules.push((0, _typescript.default)(options));
+  if (enablePlaywright) rules.push((0, _playwright.default)(options));
+  if (enableNext && enableNext) rules.push((0, _next.default)(options));
+  if (enablePrettier) rules.push((0, _prettier.default)(options));
+  if (Object.keys(eslintOptions).length > 0) rules.push(eslintOptions);
+  if (extend) Array.prototype.push.apply(rules, extend);
+  return rules;
 }

package/cjs/modules/ignore.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _globs = require("../utils/globs.js");
+/**
+ * @param { import('../option').Options } options
+ * @return { import('eslint').Linter.Config }
+ */
+function ignores(options = {}) {
+  return {
+    ignores: [..._globs.ignoreGlobs, ...(options.ignores ?? [])]
+  };
+}
+module.exports = ignores;

package/cjs/option.d.ts

@@ -1,4 +1,6 @@
-export interface Options {
+import type { Linter } from 'eslint';
+
+export interface Options extends Linter.Config {
   react?: boolean;
   sort?: boolean;
   next?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstacksjs/eslint-config",
-  "version": "11.1.18",
+  "version": "11.1.19",
   "license": "MIT",
   "author": "fullstacks <fullstacksjs@gmail.com>",
   "description": "fullstacks eslint config",
@@ -28,8 +28,8 @@
   "module": "./src/index.js",
   "exports": {
     ".": {
-      "import": "./cjs/index.js",
-      "require": "./src/index.js"
+      "import": "./src/index.js",
+      "require": "./cjs/index.js"
     }
   },
   "type": "module",

package/src/index.js

@@ -4,6 +4,7 @@ import { isPackageExists } from 'local-pkg';
 import base from './modules/base.js';
 import cypress from './modules/cypress.js';
 import fp from './modules/functional.js';
+import ignores from './modules/ignore.js';
 import imports from './modules/imports.js';
 import jest from './modules/jest.js';
 import next from './modules/next.js';
@@ -17,11 +18,15 @@ import tailwind from './modules/tailwind.js';
 import tests from './modules/tests.js';
 import typescript from './modules/typescript.js';
 import vitest from './modules/vitest.js';
-import { compose } from './utils/compose.js';
 
 const testPackages = ['jest', 'vitest', 'cypress', 'playwright'];
 
-/** @type {import('./option.d.ts').Options} */
+/**
+ * @typedef {import('eslint').Linter.Config} Config
+ * @typedef {import('./option.d.ts').Options} Options
+ * /
+
+/** @type {Options} */
 const defaultOptions = {
   cypress: isPackageExists('cypress'),
   disableExpensiveRules: false,
@@ -41,18 +46,16 @@ const defaultOptions = {
   tailwind: isPackageExists('tailwindcss'),
   test: testPackages.some(p => isPackageExists(p)),
   typescript: isPackageExists('typescript') ? { projects: true } : false,
-  unocss: isPackageExists('unocss'),
   vitest: isPackageExists('vitest'),
 };
 
 /**
  * Initialize eslint config
- *
- * @param {import('./option.d.ts').Options} initOptions
- * @param {...(import('eslint').Linter.Config)} extend
- * @returns {import('eslint').Linter.Config[]}
+ * @param {Options} initOptions
+ * @param {...Config} extend
+ * @returns {Config[]}
  */
-export function init(initOptions, ...extend) {
+export function init(initOptions = {}, ...extend) {
   const options = merge(defaultOptions, initOptions);
   if (options.typescript === true) {
     options.typescript = {};
@@ -61,24 +64,49 @@ export function init(initOptions, ...extend) {
     options.import = {};
   }
 
-  const rules = [compose(base, options)];
+  const {
+    sort: enableSort,
+    cypress: enableCypress,
+    disableExpensiveRules,
+    esm: enableEsm,
+    fp: enableFp,
+    ignores: enableIgnores,
+    import: enableImport,
+    jest: enableJest,
+    next: enableNext,
+    node: enableNode,
+    playwright: enablePlaywright,
+    prettier: enablePrettier,
+    react: enableReact,
+    storybook: enableStorybook,
+    strict: enableStrict,
+    tailwind: enableTailwind,
+    test: enableTest,
+    typescript: enableTypescript,
+    vitest: enableVitest,
+    ...eslintOptions
+  } = options;
+
+  const rules = [ignores(options), base(options)];
 
-  if (options.fp) rules.push(compose(fp, options));
-  if (options.sort) rules.push(compose(perfectionist, options));
-  if (options.import) rules.push(compose(imports, options));
-  if (options.tailwind) rules.push(compose(tailwind, options));
-  if (options.test) rules.push(compose(tests, options));
-  if (options.node) rules.push(compose(node, options));
-  if (options.jest) rules.push(compose(jest, options));
-  if (options.vitest) rules.push(compose(vitest, options));
-  if (options.cypress) rules.push(compose(cypress, options));
-  if (options.react) rules.push(compose(react, options));
-  if (options.storybook) rules.push(compose(storybook, options));
-  if (options.typescript) rules.push(compose(typescript, options));
-  if (options.playwright) rules.push(compose(playwright, options));
-  if (options.next && options.next) rules.push(compose(next, options));
+  if (enableFp) rules.push(fp(options));
+  if (enableSort) rules.push(perfectionist(options));
+  if (enableImport) rules.push(imports(options));
+  if (enableTailwind) rules.push(tailwind(options));
+  if (enableTest) rules.push(tests(options));
+  if (enableNode) rules.push(node(options));
+  if (enableJest) rules.push(jest(options));
+  if (enableVitest) rules.push(vitest(options));
+  if (enableCypress) rules.push(cypress(options));
+  if (enableReact) rules.push(react(options));
+  if (enableStorybook) rules.push(storybook(options));
+  if (enableTypescript) rules.push(typescript(options));
+  if (enablePlaywright) rules.push(playwright(options));
+  if (enableNext && enableNext) rules.push(next(options));
+  if (enablePrettier) rules.push(prettier(options));
 
-  if (options.prettier) rules.push(compose(prettier, options));
+  if (Object.keys(eslintOptions).length > 0) rules.push(eslintOptions);
+  if (extend) Array.prototype.push.apply(rules, extend);
 
-  return rules.concat(extend);
+  return rules;
 }

package/src/modules/ignore.js

@@ -0,0 +1,12 @@
+import { ignoreGlobs } from '../utils/globs.js';
+/**
+ * @param { import('../option').Options } options
+ * @return { import('eslint').Linter.Config }
+ */
+function ignores(options = {}) {
+  return {
+    ignores: [...ignoreGlobs, ...(options.ignores ?? [])],
+  };
+}
+
+export default ignores;

package/src/option.d.ts

@@ -1,4 +1,6 @@
-export interface Options {
+import type { Linter } from 'eslint';
+
+export interface Options extends Linter.Config {
   react?: boolean;
   sort?: boolean;
   next?: boolean;

package/cjs/utils/compose.js

@@ -1,17 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.compose = compose;
-var _globs = require("./globs.js");
-/**
- * @param { (options: import('eslint').Linter.Config) => import('eslint').Linter.Config } module
- * @param { import('../option').Options } options
- * @return { import('eslint').Linter.Config }
- */
-function compose(module, options) {
-  const config = module(options);
-  config.ignores = [...(config.ignores ?? []), ...(options.ignores ?? []), ...(_globs.ignoreGlobs ?? [])];
-  return config;
-}

package/src/utils/compose.js

@@ -1,12 +0,0 @@
-import { ignoreGlobs } from './globs.js';
-
-/**
- * @param { (options: import('eslint').Linter.Config) => import('eslint').Linter.Config } module
- * @param { import('../option').Options } options
- * @return { import('eslint').Linter.Config }
- */
-export function compose(module, options) {
-  const config = module(options);
-  config.ignores = [...(config.ignores ?? []), ...(options.ignores ?? []), ...(ignoreGlobs ?? [])];
-  return config;
-}