@oriflame/config-eslint 4.3.0 → 5.0.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 ORIFLAME SOFTWARE
+Copyright (c) 2021 ORIFLAME SOFTWARE
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,82 +1,3 @@
-# ESLint Config
+# @oriflame/config-eslint
 
-Factory functions for creating preset [ESLint](https://eslint.org) configurations. Primarily used in
-union with the [Lumos](https://www.npmjs.com/package/@oriflame/lumos) CLI.
-
-## Extending config
-
-**Update package.json:**
-
-```json
-{
-  "lumos": {
-    "eslint": {
-      "rules": {
-        "react-hooks/exhaustive-deps": "off"
-      }
-    }
-  }
-}
-```
-
-**Create file in configs folder:**
-
-`configs/eslint.js`
-
-```js
-module.exports = {
-  rules: {
-    'react-hooks/exhaustive-deps': 'off',
-  },
-};
-```
-
-## Settings
-
-### Main settings
-
-```ts
-export interface ESLintOptions {
-  future?: boolean;
-  node?: boolean;
-  typescript?: boolean;
-  nextjs?: boolean;
-  prettier?: boolean;
-}
-```
-
-### Default values
-
-```ts
-{
-  future = false,
-  node = false,
-  typescript = false,
-  nextjs = false,
-  prettier = false,
-}
-```
-
-### Settings
-
-- future
-  - Enables rules for new es features
-- node
-  - Enables rules for node js development
-- typescript
-  - Enables typescript rules
-- nextjs
-  - Enables Next.js rules
-- prettier
-  - Enables integration with prettier
-
-### CLI Options
-
-- `--fix`
-  - Try to fix autofixable problems.
-
-**Example:**
-
-```bash
-lumos eslint --fix
-```
+Documentation was moved to [Lumos package](https://github.com/Oriflame/lumos/tree/master/packages/lumos)

package/dts/index.d.ts

@@ -0,0 +1,10 @@
+import type { ESLintConfig } from '@beemo/driver-eslint';
+export interface ESLintOptions {
+    future?: boolean;
+    node?: boolean;
+    typescript?: boolean;
+    nextjs?: boolean;
+    prettier?: boolean;
+}
+export declare function getConfig({ future, node, typescript, nextjs, prettier, }: ESLintOptions): ESLintConfig;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -1,41 +1,46 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIgnoreList = exports.getExtendsList = void 0;
-const core_1 = require("@beemo/core");
-const lumos_common_1 = require("@oriflame/lumos-common");
-function fromHere(filePath) {
-    return `./${new core_1.Path(process.cwd())
-        .relativeTo(new core_1.Path(__dirname, '../lib', filePath).resolve())
-        .toString()}`;
+'use strict';
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+});
+
+const lumosCommon = require('@oriflame/lumos-common');
+
+function getConfig({
+  future = false,
+  node = false,
+  typescript = false,
+  nextjs = false,
+  prettier = false
+}) {
+  const presets = ['oriflame'];
+
+  if (future) {
+    presets.push('oriflame/future');
+  }
+
+  if (node) {
+    presets.push('oriflame/node');
+  }
+
+  if (typescript) {
+    presets.push('oriflame/typescript');
+  }
+
+  if (nextjs) {
+    presets.push('oriflame/nextjs');
+  }
+
+  if (prettier) {
+    presets.push('oriflame/prettier');
+  }
+
+  return {
+    root: true,
+    extends: presets,
+    ignore: [...lumosCommon.IGNORE_PATHS, 'jest.config.js', 'babel.config.js', 'webpack.config.js', 'build*/', '\\.eslintrc.js']
+  };
 }
-function getExtendsList({ future = false, node = false, typescript = false, nextjs = false, prettier = false, }) {
-    const paths = [fromHere('./presets/base')];
-    if (future) {
-        paths.push(fromHere('./presets/future'));
-    }
-    if (node) {
-        paths.push(fromHere('./presets/node'));
-    }
-    if (typescript) {
-        paths.push(fromHere('./presets/typescript'));
-    }
-    if (nextjs) {
-        paths.push(fromHere('./presets/nextjs'));
-    }
-    if (prettier) {
-        paths.push(fromHere('./presets/prettier'));
-    }
-    return paths;
-}
-exports.getExtendsList = getExtendsList;
-function getIgnoreList() {
-    return [
-        ...lumos_common_1.IGNORE_PATHS,
-        'jest.config.js',
-        'babel.config.js',
-        'webpack.config.js',
-        'build*/',
-        '\\.eslintrc.js',
-    ];
-}
-exports.getIgnoreList = getIgnoreList;
+
+exports.getConfig = getConfig;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":null,"names":["getConfig","future","node","typescript","nextjs","prettier","presets","push","root","extends","ignore","IGNORE_PATHS"],"mappings":";;;;;;AAWO,SAASA,SAAT,CAAmB;AACxBC,EAAAA,MAAM,GAAG,KADe;AAExBC,EAAAA,IAAI,GAAG,KAFiB;AAGxBC,EAAAA,UAAU,GAAG,KAHW;AAIxBC,EAAAA,MAAM,GAAG,KAJe;AAKxBC,EAAAA,QAAQ,GAAG;AALa,CAAnB,EAMyB;AAC9B,QAAMC,OAAO,GAAG,CAAC,UAAD,CAAhB;;AAEA,MAAIL,MAAJ,EAAY;AACVK,IAAAA,OAAO,CAACC,IAAR,CAAa,iBAAb;AACD;;AAED,MAAIL,IAAJ,EAAU;AACRI,IAAAA,OAAO,CAACC,IAAR,CAAa,eAAb;AACD;;AAED,MAAIJ,UAAJ,EAAgB;AACdG,IAAAA,OAAO,CAACC,IAAR,CAAa,qBAAb;AACD;;AAED,MAAIH,MAAJ,EAAY;AACVE,IAAAA,OAAO,CAACC,IAAR,CAAa,iBAAb;AACD;;AAED,MAAIF,QAAJ,EAAc;AACZC,IAAAA,OAAO,CAACC,IAAR,CAAa,mBAAb;AACD;;AAED,SAAO;AACLC,IAAAA,IAAI,EAAE,IADD;AAELC,IAAAA,OAAO,EAAEH,OAFJ;AAGLI,IAAAA,MAAM,EAAE,CACN,GAAGC,wBADG,EAEN,gBAFM,EAGN,iBAHM,EAIN,mBAJM,EAKN,SALM,EAMN,gBANM;AAHH,GAAP;AAYD;;;;"}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@oriflame/config-eslint",
-  "version": "4.3.0",
+  "version": "5.0.3",
   "description": "Reusable ESLint config.",
   "keywords": [
     "lumos",
     "config",
     "eslint"
   ],
-  "main": "lib/index.js",
+  "main": "./lib/index.js",
+  "types": "./dts/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git@github.com:Oriflame/lumos.git"
@@ -17,39 +18,45 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "check-rules": "ts-node tools/check-rules/index.ts"
-  },
   "engines": {
-    "node": ">=10.16.0"
+    "node": ">=12.17.0",
+    "npm": ">=6.13.0"
   },
+  "files": [
+    "dts/**/*.d.ts",
+    "lib/**/*.{js,map,d.ts}",
+    "lib/**/*.{js,map}",
+    "src/**/*.{ts,tsx,json}"
+  ],
   "dependencies": {
-    "@beemo/core": "^1.1.8",
-    "@beemo/driver-eslint": "^1.2.3",
-    "@next/eslint-plugin-next": "^12.0.2",
-    "@oriflame/lumos-common": "^4.3.0",
-    "@typescript-eslint/eslint-plugin": "^5.2.0",
-    "@typescript-eslint/parser": "^5.2.0",
-    "babel-eslint": "^10.1.0",
-    "confusing-browser-globals": "^1.0.10",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-import-resolver-typescript": "^2.5.0",
-    "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-import": "^2.25.2",
-    "eslint-plugin-jest": "^25.2.2",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-promise": "^5.1.1",
-    "eslint-plugin-react": "^7.26.1",
-    "eslint-plugin-react-hooks": "^4.2.0",
-    "eslint-plugin-testing-library": "^5.0.0",
-    "eslint-plugin-unicorn": "^37.0.1"
+    "@oriflame/lumos-common": "^5.0.3",
+    "eslint-config-oriflame": "^5.0.3"
   },
   "devDependencies": {
-    "@types/confusing-browser-globals": "^1.0.0",
+    "@beemo/core": "^2.1.3",
+    "@beemo/driver-eslint": "^2.0.4",
+    "@types/node": "^16.11.14",
+    "eslint": "^8.5.0",
     "ts-node": "^10.4.0"
   },
-  "gitHead": "82c127cb45ef16c0937f17e5f9bb03d53fba155a"
+  "peerDependencies": {
+    "@beemo/core": "^2.1.2",
+    "@beemo/driver-eslint": "^2.0.3",
+    "eslint": "^8.4.1",
+    "prettier": "^2.5.1",
+    "typescript": ">=4.5"
+  },
+  "peerDependenciesMeta": {
+    "prettier": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  },
+  "packemon": {
+    "format": "lib",
+    "platform": "node"
+  },
+  "gitHead": "6df4ab463f076eb30e6a138278530e5da464f2bb"
 }

package/src/index.ts

@@ -1,4 +1,4 @@
-import { Path } from '@beemo/core';
+import type { ESLintConfig } from '@beemo/driver-eslint';
 import { IGNORE_PATHS } from '@oriflame/lumos-common';
 
 export interface ESLintOptions {
@@ -9,51 +9,45 @@ export interface ESLintOptions {
   prettier?: boolean;
 }
 
-function fromHere(filePath: string): string {
-  return `./${new Path(process.cwd())
-    .relativeTo(new Path(__dirname, '../lib', filePath).resolve())
-    .toString()}`;
-}
-
-export function getExtendsList({
+export function getConfig({
   future = false,
   node = false,
   typescript = false,
   nextjs = false,
   prettier = false,
-}: ESLintOptions): string[] {
-  const paths = [fromHere('./presets/base')];
+}: ESLintOptions): ESLintConfig {
+  const presets = ['oriflame'];
 
   if (future) {
-    paths.push(fromHere('./presets/future'));
+    presets.push('oriflame/future');
   }
 
   if (node) {
-    paths.push(fromHere('./presets/node'));
+    presets.push('oriflame/node');
   }
 
   if (typescript) {
-    paths.push(fromHere('./presets/typescript'));
+    presets.push('oriflame/typescript');
   }
 
   if (nextjs) {
-    paths.push(fromHere('./presets/nextjs'));
+    presets.push('oriflame/nextjs');
   }
 
   if (prettier) {
-    paths.push(fromHere('./presets/prettier'));
+    presets.push('oriflame/prettier');
   }
 
-  return paths;
-}
-
-export function getIgnoreList(): string[] {
-  return [
-    ...IGNORE_PATHS,
-    'jest.config.js',
-    'babel.config.js',
-    'webpack.config.js',
-    'build*/',
-    '\\.eslintrc.js',
-  ];
+  return {
+    root: true,
+    extends: presets,
+    ignore: [
+      ...IGNORE_PATHS,
+      'jest.config.js',
+      'babel.config.js',
+      'webpack.config.js',
+      'build*/',
+      '\\.eslintrc.js',
+    ],
+  };
 }