@qlover/fe-standard 0.0.2

package/README.md

@@ -0,0 +1,6 @@
+# fe-config
+
+1. eslint config
+
+- base.json
+- bate.ts.json

package/config/jest.esm.js

@@ -0,0 +1,19 @@
+/** @type {import('jest').Config} */
+export default {
+  injectGlobals: true,
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1'
+  },
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        useESM: true
+      }
+    ]
+  },
+  testMatch: ['**/__tests__/**/*.[jt]s?(x)', '!**/__tests__/helpers/**']
+};

package/config/prettierrc.js

@@ -0,0 +1,7 @@
+/** @type {import('prettier').Config} */
+export default {
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'none',
+  endOfLine: 'lf'
+};

package/config/tsconfig.base.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "baseUrl": ".",
+    "target": "ESNEXT",
+    "module": "ESNext",
+    "lib": ["ESNext", "DOM"],
+    "outDir": "dist",
+    "sourceMap": true,
+    "declaration": true,
+    "declarationDir": "dist/types",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "Node"
+  }
+}

package/eslint/chain.js

@@ -0,0 +1,90 @@
+import tslint from 'typescript-eslint';
+import prettier from 'eslint-plugin-prettier';
+import lodash from 'lodash';
+import tsRules from './ts.rules.js';
+import js from '@eslint/js';
+import prettierConfig from '../config/prettierrc.js';
+const { merge } = lodash;
+
+/**
+ * Create typescript recommended config.
+ *
+ * @param {string[]} files
+ * @returns {import('eslint').Linter.Config}
+ */
+export function createTslintRecommended(files) {
+  let result = {};
+  tslint.configs.recommended.forEach((config) => {
+    result = merge(result, config);
+  });
+
+  if (files) {
+    result.files = files;
+  }
+
+  // merge ts rules
+  result.rules = {
+    ...result.rules,
+    ...tsRules
+  };
+
+  return result;
+}
+
+/**
+ * Create a common config.
+ *
+ * default config for js and ts.
+ *
+ *
+ * @param {string[]} files
+ * @returns {import('eslint').Linter.Config}
+ */
+export function createCommon(files) {
+  return {
+    files: files || ['**/*.js', '**/*.ts'],
+    languageOptions: {
+      globals: {
+        process: true,
+        console: true
+      }
+    },
+    plugins: {
+      prettier: prettier
+    },
+    rules: {
+      // TODO: import
+      ...js.configs.recommended.rules,
+      'prettier/prettier': ['error', prettierConfig],
+      'spaced-comment': 'error'
+    }
+  };
+}
+
+/**
+ * Add no-restricted-globals rule for browser environment.
+ *
+ * @param {import('eslint').Linter.Config} options
+ * @returns {import('eslint').Linter.Config}
+ */
+export function chainEnv(options) {
+  const { allGlobals, ...config } = options;
+  const globals = config.languageOptions.globals;
+
+  if (globals) {
+    const allGlobalKeys = new Set([...Object.keys(allGlobals)]);
+    const notAllowedGlobals = Array.from(allGlobalKeys).filter((key) => {
+      return !(key in globals) || globals[key] == null;
+    });
+
+    return {
+      ...config,
+      rules: {
+        ...config.rules,
+        'no-restricted-globals': ['error', ...notAllowedGlobals]
+      }
+    };
+  }
+
+  return config;
+}

package/eslint/index.js

@@ -0,0 +1 @@
+export * from './chain.js';

package/eslint/ts.rules.js

@@ -0,0 +1,22 @@
+/** @type {import('eslint').Linter.Config} */
+export default {
+  // force function return type
+  '@typescript-eslint/explicit-function-return-type': 'error',
+  // not use any
+  '@typescript-eslint/no-explicit-any': 'error',
+  // allow ts-comment
+  '@typescript-eslint/ban-ts-comment': 'off',
+  // allow empty object type
+  '@typescript-eslint/no-empty-object-type': 'off',
+  // not allow unused vars
+  '@typescript-eslint/no-unused-vars': [
+    'error',
+    {
+      vars: 'all',
+      args: 'none',
+      ignoreRestSiblings: true,
+      varsIgnorePattern: '^_',
+      caughtErrors: 'none'
+    }
+  ]
+};

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@qlover/fe-standard",
+  "version": "0.0.2",
+  "private": false,
+  "type": "module",
+  "files": [
+    "config",
+    "eslint",
+    "package.json",
+    "README.md"
+  ],
+  "exports": {
+    "./config/*": "./config/*",
+    "./eslint/*": "./eslint/*",
+    "./package.json": "./package.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/qlover/fe-base.git",
+    "directory": "packages/fe-standard"
+  },
+  "homepage": "https://github.com/qlover/fe-base/blob/master/packages/fe-standard/README.md",
+  "keywords": [
+    "config",
+    "standard",
+    "fe-standard",
+    "eslint-config"
+  ],
+  "author": "qlover",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.13.0",
+    "@typescript-eslint/eslint-plugin": "^8.12.0",
+    "@typescript-eslint/parser": "^8.12.0",
+    "eslint": "^9.13.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jest": "^28.8.3",
+    "eslint-plugin-n": "^17.11.1",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-promise": "^7.1.0",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "globals": "^15.11.0",
+    "prettier": "^3.3.3",
+    "ts-jest": "^29.2.5",
+    "typescript": "~5.4.0",
+    "typescript-eslint": "^8.18.0"
+  }
+}