@resolid/config 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-present, Resolid Tech
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,84 @@
+# @resolid/config
+
+Resolid 通用配置, 包含了 `TypeScript`, `ESLint` 的基础配置
+
+## 使用方法
+
+### 安装
+
+```bash
+pnpm add -D eslint @resolid/config
+```
+
+### TypeScript 配置
+
+增加下面内容到 `tsconfig.json`
+
+#### 普通项目
+
+```json
+{
+  "extends": "@resolid/config/tsconfig.base"
+}
+```
+
+#### React 项目
+
+```json
+{
+  "extends": "@resolid/config/tsconfig.react"
+}
+```
+
+### ESLint 配置
+
+本配置包是纯 ESM 包, 并使用了 ESLint 扁平配置, 需要使用 `eslint.config.js` 文件来进行配置
+
+语言选项默认为 `ecmaVersion: 2022`, `sourceType: 'module'`
+
+#### TypeScript Lint 配置
+
+```js
+// eslint.config.js
+import eslintTypescript from "@resolid/config/eslint.typescript";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [...eslintTypescript];
+```
+
+#### React Lint 配置
+
+```js
+// eslint.config.js
+import eslintReact from "@resolid/config/eslint.react";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [...eslintReact];
+```
+
+### ESLint 环境设置
+
+```js
+// eslint.config.js
+
+// 浏览器环境
+import eslintBowser from "@resolid/config/eslint.bowser";
+
+// Node 环境
+import eslintNode from "@resolid/config/eslint.node";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [...eslintBowser, ...eslintNode];
+```
+
+### ESLint 配置查看
+
+你可以进入拥有 `eslint.config.js` 文件的目录运行下面的命令来检查
+
+```bash
+npx eslint-flat-config-viewer
+```
+
+## 感谢
+
+- [eslint-flat-config-viewer](https://github.com/antfu/eslint-flat-config-viewer)

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@resolid/config",
+  "version": "1.0.1",
+  "type": "module",
+  "sideEffects": false,
+  "description": "Resolid 通用配置",
+  "author": "Huijie Wei",
+  "license": "MIT",
+  "keywords": [
+    "resolid",
+    "eslint",
+    "typescript"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "files": [
+    "src",
+    "tsconfig.base.json",
+    "tsconfig.react.json"
+  ],
+  "exports": {
+    "./tsconfig.base": "./tsconfig.base.json",
+    "./tsconfig.react": "./tsconfig.react.json",
+    "./*": "./src/*.js"
+  },
+  "dependencies": {
+    "@eslint/js": "^8.57.0",
+    "eslint-plugin-jsx-a11y": "^6.8.0",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-react": "^7.34.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "globals": "^14.0.0",
+    "typescript-eslint": "^7.1.1"
+  },
+  "devDependencies": {
+    "eslint": "^8.57.0",
+    "typescript": "^5.4.2"
+  },
+  "peerDependencies": {
+    "eslint": "^8.57.0",
+    "typescript": "^5.4.2"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "homepage": "https://resolid.tech",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/huijiewei/resolid-config.git"
+  },
+  "scripts": {
+    "lint": "eslint ."
+  }
+}

package/src/eslint.base.js

@@ -0,0 +1,41 @@
+import js from "@eslint/js";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [
+  {
+    ignores: [
+      "**/node_modules",
+      "**/build",
+      "**/dist",
+      "**/package-lock.json",
+      "**/pnpm-lock.yaml",
+      "**/.vercel",
+      "**/.changeset",
+      "**/.idea",
+      "**/.cache",
+      "**/.output",
+      "**/.resolid",
+      "**/.vite-inspect",
+      "**/*.min.*",
+      "**/LICENSE*",
+    ],
+  },
+  {
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: "module",
+      parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: "module",
+      },
+    },
+    linterOptions: {
+      reportUnusedDisableDirectives: true,
+    },
+    rules: {
+      ...js.configs.recommended.rules,
+      "no-extra-semi": "off",
+      "no-mixed-spaces-and-tabs": "off",
+    },
+  },
+];

package/src/eslint.bowser.js

@@ -0,0 +1,12 @@
+import globals from "globals";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [
+  {
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+      },
+    },
+  },
+];

package/src/eslint.node.js

@@ -0,0 +1,24 @@
+import n from "eslint-plugin-n";
+import globals from "globals";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [
+  {
+    plugins: { n },
+    rules: {
+      "n/handle-callback-err": ["error", "^(err|error)$"],
+      "n/no-deprecated-api": "error",
+      "n/no-exports-assign": "error",
+      "n/no-new-require": "error",
+      "n/no-path-concat": "error",
+      "n/prefer-global/buffer": ["error", "never"],
+      "n/prefer-global/process": ["error", "never"],
+      "n/process-exit-as-throw": "error",
+    },
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+    },
+  },
+];

package/src/eslint.react.js

@@ -0,0 +1,65 @@
+import jsxA11y from "eslint-plugin-jsx-a11y";
+import react from "eslint-plugin-react";
+import reactHooks from "eslint-plugin-react-hooks";
+import eslintTypescript from "./eslint.typescript.js";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [
+  ...eslintTypescript,
+  {
+    files: ["**/*.{jsx,tsx}"],
+    plugins: {
+      react: react,
+    },
+    rules: {
+      ...react.configs.recommended.rules,
+      ...react.configs["jsx-runtime"].rules,
+      "react/prop-types": "off",
+    },
+    languageOptions: {
+      parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: "module",
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+    settings: {
+      react: {
+        version: "detect",
+      },
+    },
+  },
+  {
+    files: ["**/*.{js,jsx,ts,tsx}"],
+    plugins: {
+      "react-hooks": reactHooks,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      "react-hooks/exhaustive-deps": [
+        "warn",
+        {
+          additionalHooks: "(useIsomorphicEffect)",
+        },
+      ],
+    },
+  },
+  {
+    files: ["**/*.{jsx,tsx}"],
+    plugins: {
+      "jsx-a11y": jsxA11y,
+    },
+    rules: {
+      ...jsxA11y.configs.recommended.rules,
+    },
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+  },
+];

package/src/eslint.typescript.js

@@ -0,0 +1,5 @@
+import typescript from "typescript-eslint";
+import eslintBase from "./eslint.base.js";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default typescript.config(...eslintBase, ...typescript.configs.recommended);

package/tsconfig.base.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    // Type Checking
+    "strict": true,
+    "noFallthroughCasesInSwitch": true,
+
+    // Modules
+    "module": "ES2022",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "moduleDetection": "force",
+
+    // Emit
+    "noEmit": true,
+    "verbatimModuleSyntax": true,
+
+    // JavaScript Support
+    "allowJs": true,
+
+    // Interop Constraints
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+
+    // Language and Environment
+    "lib": ["DOM", "DOM.Iterable", "ES2022"],
+    "target": "ES2022",
+
+    // Completeness
+    "skipLibCheck": true
+  }
+}

package/tsconfig.react.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "jsx": "react-jsx"
+  }
+}