@qlik/eslint-config 0.0.1

package/LICENSE

@@ -0,0 +1,17 @@
+ISC License
+
+Copyright (c) 2023 Qlik
+
+Permission to use, copy, modify, and/or distribute this software
+for any purpose with or without fee is hereby granted, provided
+that the above copyright notice and this permission notice appear
+in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
+CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,67 @@
+# @qlik/eslint-config
+
+ESlint config for pure javascript/typescript environments. Based on airbnb-base/prettier config with some modifications.
+
+## usage
+
+Simplest approach is to add one of the following field in `package.json`:
+
+For a pure javascript environment use:
+
+```json
+"eslintConfig": {
+    "extends": [
+      "@qlik/eslint-config"
+    ],
+    "root": true
+  },
+```
+
+To enable linting on typescript (.ts, .tsx):
+
+```json
+"eslintConfig": {
+    "extends": [
+      "@qlik/eslint-config/typescript"
+    ],
+    "root": true
+  },
+```
+
+For a node environment with commonjs modules use:
+
+```json
+"eslintConfig": {
+    "extends": [
+      "@qlik/eslint-config/node"
+    ],
+    "root": true
+  },
+```
+
+For a node environment with ES modules use:
+
+```json
+"eslintConfig": {
+    "extends": [
+      "@qlik/eslint-config/node-esm"
+    ],
+    "root": true
+  },
+```
+
+Additional configs that can be used in conjunction with the above:
+
+```json
+"eslintConfig": {
+    "extends": [
+      "...",
+      "@qlik/eslint-config/jest" // adds linting on jest test and config files
+      // OR
+      "@qlik/eslint-config/vitest" // adds linting on vitest test and config files
+      // AND/OR
+      "@qlik/eslint-config/playwright" // adds linting on playwright test and config files
+    ],
+    "root": true
+  },
+```

package/index.js

@@ -0,0 +1,6 @@
+module.exports = {
+  parserOptions: {
+    ecmaVersion: 2020,
+  },
+  extends: ["airbnb-base", "@qlik/eslint-config-base", "prettier"],
+};

package/jest.js

@@ -0,0 +1,3 @@
+const jest = require("@qlik/eslint-config-base/jest");
+
+module.exports = jest;

package/node-esm.js

@@ -0,0 +1,14 @@
+module.exports = {
+  parserOptions: {
+    ecmaVersion: 2020,
+  },
+  env: {
+    node: true,
+    browser: false,
+  },
+  extends: ["airbnb-base", "@qlik/eslint-config-base", "prettier"],
+  rules: {
+    "no-console": "off",
+    "import/extensions": ["error", "ignorePackages"],
+  },
+};

package/node.js

@@ -0,0 +1,13 @@
+module.exports = {
+  parserOptions: {
+    ecmaVersion: 2020,
+  },
+  env: {
+    node: true,
+    browser: false,
+  },
+  extends: ["airbnb-base", "@qlik/eslint-config-base", "prettier"],
+  rules: {
+    "no-console": "off",
+  },
+};

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@qlik/eslint-config",
+  "version": "0.0.1",
+  "description": "Qlik's ESLint config",
+  "repository": "git@github.com:qlik-oss/dev-tools-js.git",
+  "license": "ISC",
+  "main": "index.js",
+  "files": [
+    "node.js",
+    "node-esm.js",
+    "jest.js",
+    "playwright.js",
+    "typescript.js",
+    "vitest.js"
+  ],
+  "prettier": "@qlik/prettier-config",
+  "eslintConfig": {
+    "extends": "./node.js"
+  },
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "5.55.0",
+    "@typescript-eslint/parser": "5.55.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-config-airbnb-typescript": "17.0.0",
+    "eslint-config-prettier": "8.7.0",
+    "eslint-plugin-import": "2.27.5",
+    "@qlik/eslint-config-base": "0.0.1"
+  },
+  "devDependencies": {
+    "eslint": "8.36.0",
+    "prettier": "2.8.6",
+    "@qlik/prettier-config": "0.0.1"
+  },
+  "peerDependencies": {
+    "eslint": "*"
+  },
+  "optionalDependencies": {
+    "typescript": "*"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "format:check": "prettier --check '**' --ignore-unknown",
+    "format:write": "prettier --write '**' --ignore-unknown",
+    "lint": "eslint ."
+  }
+}

package/playwright.js

@@ -0,0 +1,3 @@
+const playwright = require("@qlik/eslint-config-base/playwright");
+
+module.exports = playwright;

package/typescript.js

@@ -0,0 +1,9 @@
+module.exports = {
+  extends: ["./index.js"],
+  overrides: [
+    {
+      files: ["**/*.ts", "**/*.tsx"],
+      extends: ["airbnb-base", "airbnb-typescript/base", "@qlik/eslint-config-base/typescript", "prettier"],
+    },
+  ],
+};

package/vitest.js

@@ -0,0 +1,3 @@
+const vitest = require("@qlik/eslint-config-base/vitest");
+
+module.exports = vitest;