Add TSConfig package

spear-ai · May 13, 2024 · 626dc51 · 626dc51
1 parent 5b141ac
commit 626dc51
Show file tree

Hide file tree

Showing 28 changed files with 199 additions and 168 deletions.
diff --git a/.changeset/mean-apes-yell.md b/.changeset/mean-apes-yell.md
@@ -0,0 +1,5 @@
+---
+"@spear-ai/tsconfig": major
+---
+
+Added TSConfig.
diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz
diff --git a/package.json b/package.json
@@ -20,7 +20,7 @@
     "husky": "9.0.11",
     "npm-package-json-lint": "7.1.0",
     "prettier": "3.2.5",
-    "turbo": "1.13.2",
+    "turbo": "1.13.3",
     "typescript": "5.4.5"
   },
   "license": "MIT",

diff --git a/packages/commitlint-config/.gitignore b/packages/commitlint-config/.gitignore
@@ -1 +1,3 @@
+.turbo
 dist
+node_modules
diff --git a/packages/commitlint-config/tsconfig.json b/packages/commitlint-config/tsconfig.json
@@ -1,23 +1,6 @@
 {
-  "compilerOptions": {
-    "declaration": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "forceConsistentCasingInFileNames": true,
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitReturns": true,
-    "outDir": "bin",
-    "pretty": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "strict": true,
-    "stripInternal": true,
-    "target": "ESNext"
-  },
   "exclude": ["node_modules"],
+  "extends": "@spear-ai/tsconfig",
   "include": [
     "**/*.cjs",
     "**/*.cts",
@@ -28,7 +11,6 @@
     "**/*.mts",
     "**/*.ts",
     "**/*.tsx",
-    "<tsconfigRootDir>//README.md/1_1.js",
     "types"
   ]
 }
diff --git a/packages/eslint-config/.gitignore b/packages/eslint-config/.gitignore
@@ -1 +1,3 @@
+.turbo
 dist
+node_modules
diff --git a/packages/eslint-config/src/index.ts b/packages/eslint-config/src/index.ts
@@ -181,7 +181,7 @@ export const baseEslintConfig: Linter.FlatConfig[] = [
       jsonc: jsoncPlugin as unknown as ESLint.Plugin,
     },
     rules: {
-      ...(jsoncPlugin.configs.base.overrides[0].rules as Linter.RulesRecord),
+      ...(jsoncPlugin.configs.base.overrides[0]?.rules as Linter.RulesRecord),
       ...(jsoncPlugin.configs["recommended-with-json"].rules as Linter.RulesRecord),
       ...jsonFamilyRules,
     },
@@ -196,7 +196,7 @@ export const baseEslintConfig: Linter.FlatConfig[] = [
       jsonc: jsoncPlugin as unknown as ESLint.Plugin,
     },
     rules: {
-      ...(jsoncPlugin.configs.base.overrides[0].rules as Linter.RulesRecord),
+      ...(jsoncPlugin.configs.base.overrides[0]?.rules as Linter.RulesRecord),
       ...(jsoncPlugin.configs["recommended-with-json5"].rules as Linter.RulesRecord),
       ...jsonFamilyRules,
     },
@@ -211,7 +211,7 @@ export const baseEslintConfig: Linter.FlatConfig[] = [
       jsonc: jsoncPlugin as unknown as ESLint.Plugin,
     },
     rules: {
-      ...(jsoncPlugin.configs.base.overrides[0].rules as Linter.RulesRecord),
+      ...(jsoncPlugin.configs.base.overrides[0]?.rules as Linter.RulesRecord),
       ...(jsoncPlugin.configs["recommended-with-jsonc"].rules as Linter.RulesRecord),
       ...jsonFamilyRules,
     },
@@ -226,7 +226,7 @@ export const baseEslintConfig: Linter.FlatConfig[] = [
       toml: tomlPlugin as ESLint.Plugin,
     },
     rules: {
-      ...(tomlPlugin.configs.base.overrides[0].rules as Linter.RulesRecord),
+      ...(tomlPlugin.configs.base.overrides[0]?.rules as Linter.RulesRecord),
       ...(tomlPlugin.configs.standard.rules as Linter.RulesRecord),
       "no-multiple-empty-lines": ["error", { max: 1 }],
       "no-trailing-spaces": ["error"],
@@ -243,7 +243,7 @@ export const baseEslintConfig: Linter.FlatConfig[] = [
       yml: yamlPlugin as ESLint.Plugin,
     },
     rules: {
-      ...(yamlPlugin.configs.base.overrides[0].rules as Linter.RulesRecord),
+      ...(yamlPlugin.configs.base.overrides[0]?.rules as Linter.RulesRecord),
       ...(yamlPlugin.configs.standard.rules as Linter.RulesRecord),
       "no-multiple-empty-lines": ["error", { max: 0 }],
       "no-trailing-spaces": ["error"],
@@ -329,7 +329,7 @@ export const baseEslintConfig: Linter.FlatConfig[] = [
       ...airbnbTypescriptConfigShared.rules,
       ...airbnbTypescriptConfig.rules,
       ...(typescriptPlugin.configs?.base as ESLint.ConfigData).rules,
-      ...(typescriptPlugin.configs?.["eslint-recommended"] as ESLint.ConfigData).overrides?.[0].rules,
+      ...(typescriptPlugin.configs?.["eslint-recommended"] as ESLint.ConfigData).overrides?.[0]?.rules,
       ...(typescriptPlugin.configs?.["stylistic-type-checked"] as ESLint.ConfigData).rules,
       ...(typescriptPlugin.configs?.["strict-type-checked"] as ESLint.ConfigData).rules,
       ...(arrayFuncPlugin.configs?.recommended as ESLint.ConfigData).rules,
@@ -710,7 +710,7 @@ export const baseEslintConfig: Linter.FlatConfig[] = [
       react: reactPlugin,
     },
     rules: {
-      ...(markdownPlugin.configs?.recommended as ESLint.ConfigData).overrides?.[1].rules,
+      ...(markdownPlugin.configs?.recommended as ESLint.ConfigData).overrides?.[1]?.rules,
       "@typescript-eslint/no-unused-vars": ["off"],
       "formatjs/no-literal-string-in-jsx": ["off"],
       "import/no-default-export": ["off"],

diff --git a/packages/eslint-config/tsconfig.json b/packages/eslint-config/tsconfig.json
@@ -1,23 +1,6 @@
 {
-  "compilerOptions": {
-    "declaration": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "forceConsistentCasingInFileNames": true,
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitReturns": true,
-    "outDir": "bin",
-    "pretty": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "strict": true,
-    "stripInternal": true,
-    "target": "ESNext"
-  },
   "exclude": ["node_modules"],
+  "extends": "@spear-ai/tsconfig",
   "include": [
     "**/*.cjs",
     "**/*.cts",
@@ -28,7 +11,6 @@
     "**/*.mts",
     "**/*.ts",
     "**/*.tsx",
-    "<tsconfigRootDir>//README.md/1_1.js",
     "types"
   ]
 }
diff --git a/packages/npm-package-json-lint-config/.gitignore b/packages/npm-package-json-lint-config/.gitignore
@@ -1 +1,3 @@
+.turbo
 dist
+node_modules
diff --git a/packages/npm-package-json-lint-config/tsconfig.json b/packages/npm-package-json-lint-config/tsconfig.json
@@ -1,23 +1,6 @@
 {
-  "compilerOptions": {
-    "declaration": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "forceConsistentCasingInFileNames": true,
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitReturns": true,
-    "outDir": "bin",
-    "pretty": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "strict": true,
-    "stripInternal": true,
-    "target": "ESNext"
-  },
   "exclude": ["node_modules"],
+  "extends": "@spear-ai/tsconfig",
   "include": [
     "**/*.cjs",
     "**/*.cts",

diff --git a/packages/prettier-config/.gitignore b/packages/prettier-config/.gitignore
@@ -1 +1,3 @@
+.turbo
 dist
+node_modules
diff --git a/packages/prettier-config/tsconfig.json b/packages/prettier-config/tsconfig.json
@@ -1,23 +1,6 @@
 {
-  "compilerOptions": {
-    "declaration": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "forceConsistentCasingInFileNames": true,
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitReturns": true,
-    "outDir": "bin",
-    "pretty": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "strict": true,
-    "stripInternal": true,
-    "target": "ESNext"
-  },
   "exclude": ["node_modules"],
+  "extends": "@spear-ai/tsconfig",
   "include": [
     "**/*.cjs",
     "**/*.cts",
@@ -28,7 +11,6 @@
     "**/*.mts",
     "**/*.ts",
     "**/*.tsx",
-    "<tsconfigRootDir>//README.md/1_1.js",
     "types"
   ]
 }
diff --git a/packages/pulumi-policy-pack/.gitignore b/packages/pulumi-policy-pack/.gitignore
@@ -1,2 +1,3 @@
+.turbo
 dist
 node_modules
diff --git a/packages/pulumi-policy-pack/tsconfig.json b/packages/pulumi-policy-pack/tsconfig.json
@@ -1,23 +1,6 @@
 {
-  "compilerOptions": {
-    "declaration": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "forceConsistentCasingInFileNames": true,
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitReturns": true,
-    "outDir": "bin",
-    "pretty": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "strict": true,
-    "stripInternal": true,
-    "target": "ESNext"
-  },
   "exclude": ["node_modules"],
+  "extends": "@spear-ai/tsconfig",
   "include": [
     "**/*.cjs",
     "**/*.cts",

diff --git a/packages/ruff-config/.gitignore b/packages/ruff-config/.gitignore
@@ -1,3 +1,5 @@
 .ruff_cache
+.turbo
 .venv
 dist
+node_modules
diff --git a/packages/ruff-config/package.json b/packages/ruff-config/package.json
@@ -43,6 +43,7 @@
     "ruff-format:fix": "poetry run ruff format .",
     "ruff-lint:check": "poetry run ruff check .",
     "ruff-lint:fix": "poetry run ruff check --fix .",
-    "sync-version": "tsx sync-version"
+    "sync-version": "tsx sync-version",
+    "typescript:check": "tsc --noEmit"
   }
 }
diff --git a/packages/ruff-config/tsconfig.json b/packages/ruff-config/tsconfig.json
@@ -1,30 +1,12 @@
 {
-  "compilerOptions": {
-    "declaration": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "forceConsistentCasingInFileNames": true,
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitReturns": true,
-    "outDir": "bin",
-    "pretty": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "strict": true,
-    "stripInternal": true,
-    "target": "ESNext"
-  },
   "exclude": ["node_modules"],
+  "extends": "@spear-ai/tsconfig",
   "include": [
     "**/*.cjs",
     "**/*.cts",
     "**/*.js",
     "**/*.jsx",
     "**/*.jsx",
-    "<tsconfigRootDir>//README.md/1_1.js",
     "**/*.mjs",
     "**/*.mts",
     "**/*.ts",

diff --git a/packages/tsconfig/.gitignore b/packages/tsconfig/.gitignore
@@ -0,0 +1,3 @@
+.turbo
+dist
+node_modules
diff --git a/packages/tsconfig/.prettierignore b/packages/tsconfig/.prettierignore
@@ -0,0 +1,2 @@
+dist
+node_modules
diff --git a/packages/tsconfig/README.md b/packages/tsconfig/README.md
@@ -0,0 +1,20 @@
+# @spear-ai/tsconfig
+
+A [TSConfig](https://www.typescriptlang.org/tsconfig) file.
+
+## Installation
+
+```shell
+yarn add -DE @spear-ai/tsconfig
+```
+
+## Usage
+
+Add the following to your `tsconfig.json` file:
+
+```jsonc
+{
+  "extends": "@spear-ai/tsconfig",
+  // …
+}
+```
diff --git a/packages/tsconfig/eslint.config.js b/packages/tsconfig/eslint.config.js
@@ -0,0 +1,12 @@
+import { baseEslintConfig, prettierConfig } from "@spear-ai/eslint-config";
+
+/** @type {import("eslint").Linter.FlatConfig} */
+const eslintConfig = [
+  {
+    ignores: ["dist", "node_modules"],
+  },
+  ...baseEslintConfig,
+  prettierConfig,
+];
+
+export default eslintConfig;
diff --git a/packages/tsconfig/npmpackagejsonlint.config.cjs b/packages/tsconfig/npmpackagejsonlint.config.cjs
@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["@spear-ai/npm-package-json-lint-config/spear-library"],
+};
diff --git a/packages/tsconfig/package.json b/packages/tsconfig/package.json
@@ -0,0 +1,44 @@
+{
+  "name": "@spear-ai/tsconfig",
+  "version": "3.1.1",
+  "description": "Spear AI TSConfig",
+  "author": {
+    "name": "Spear AI",
+    "email": "[email protected]",
+    "url": "https://spear.ai"
+  },
+  "type": "module",
+  "devDependencies": {
+    "@commitlint/types": "18.6.1",
+    "commitlint": "18.6.1",
+    "eslint": "8.57.0",
+    "npm-package-json-lint": "7.1.0",
+    "prettier": "3.2.5",
+    "turbo": "1.13.3",
+    "typescript": "5.4.5"
+  },
+  "files": [
+    "CHANGELOG.md",
+    "tsconfig.json"
+  ],
+  "keywords": [
+    "TypeScript",
+    "config",
+    "TSConfig"
+  ],
+  "license": "MIT",
+  "main": "tsconfig.json",
+  "repository": {
+    "type": "git",
+    "directory": "packages/tsconfig",
+    "url": "https://github.com/spear-ai/citizen.git"
+  },
+  "scripts": {
+    "eslint:check": "eslint --max-warnings 0 .",
+    "eslint:fix": "yarn eslint:check --fix",
+    "npmpkgjsonlint:check": "npmPkgJsonLint .",
+    "prettier:check": "prettier --check .",
+    "prettier:fix": "prettier --write .",
+    "typescript:check": "tsc --noEmit"
+  }
+}
diff --git a/packages/tsconfig/prettier.config.cjs b/packages/tsconfig/prettier.config.cjs
@@ -0,0 +1,3 @@
+const prettierConfig = require("@spear-ai/prettier-config");
+
+module.exports = prettierConfig;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		const prettierConfig = require("@spear-ai/prettier-config");

		module.exports = prettierConfig;