chore(all): tsconfig sharing via internal package

serjilyashenko · May 12, 2024 · 65fc627 · 65fc627
1 parent 7a2a104
commit 65fc627
Show file tree

Hide file tree

Showing 19 changed files with 96 additions and 49 deletions.
diff --git a/README.md b/README.md
@@ -42,7 +42,8 @@ simple-pie-project
 └─ packages
    ├─ pie-math
    ├─ simple-pie
-   └─ react-simple-pie
+   ├─ react-simple-pie
+   └─ tsconfig
 ```
 
 ## Installing packages

diff --git a/apps/homepage-legacy/package.json b/apps/homepage-legacy/package.json
@@ -6,7 +6,8 @@
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",
-    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "lint": "tsc",
+    "lint-legacy": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "preview": "vite preview"
   },
   "dependencies": {

diff --git a/apps/homepage-legacy/tsconfig.json b/apps/homepage-legacy/tsconfig.json
@@ -1,4 +1,5 @@
 {
+  "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
     "target": "ES2020",
     "useDefineForClassFields": true,

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -23,4 +23,18 @@ Some common ones are:
 
 ## Linting
 
-🚧TBD
+TypeScript can be used in one of two ways - as a linter, or as a build tool.
+`noEmit` prevents emitting files. So, TS is used to check source code's types.
+
+tsconfig for `packages/*` is shared from the `packages/tsconfig` package. `apps/hompage-legacy` has
+its own tsconfig
+
+```mermaid
+flowchart
+  T[packages/tsconfig] --> PM[packages/pie-math]
+  T --> SP[packages/simple-pie]
+  T --> RSP[packages/react-simple-pie]
+  HL[apps/homepage-legacy]
+```
+
+🚧 TBD
diff --git a/docs/monorepo.md b/docs/monorepo.md
@@ -23,17 +23,22 @@ simple-pie-project
 └─ packages
    ├─ pie-math
    ├─ simple-pie
-   └─ react-simple-pie
+   ├─ react-simple-pie
+   └─ tsconfig
 ```
 
 `packages/pie-math` includes all calculations (business logic).\
 `packages/simple-pie` and `packages/react-simple-pie` are external and are published to npm.
-They don't include any calculations and they are just "transport" packages (read more in [package-publishing.md](./package-publishing.md)).
+They don't include any calculations and they are just "transport" packages (read more in [package-publishing.md](./package-publishing.md)).\
+`packages/tsconfig` just shares tsconfigs for packages.
 
 ```mermaid
 flowchart TD
-  PM[packages/pie-math] --> SP[packages/simple-pie]
-  PM[packages/pie-math] --> RSP[packages/react-simple-pie]
+  T[packages/tsconfig] --> PM[packages/pie-math]
+  T --> SP[packages/simple-pie]
+  PM --> SP
+  PM --> RSP[packages/react-simple-pie]
+  T --> RSP
   SP --> HL[apps/homepage-legacy]
   RSP --> HL
   SP -.-> NPM[npm]

diff --git a/docs/package-publishing.md b/docs/package-publishing.md
@@ -1,6 +1,6 @@
 # Package publishing
 
-The publishing is applied to the next packages:
+The publishing is applied to external packages. The next ones:
 
 - `packages/simple-pie`
 - `packages/react-simple-pie`

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -13,6 +13,7 @@
     "dev": "turbo dev",
     "build": "turbo build",
     "build:packages": "turbo build --filter='./packages/*'",
+    "lint": "turbo lint",
     "changeset": "npx changeset",
     "release": "changeset publish",
     "prettier": "prettier --write .",

diff --git a/packages/pie-math/package.json b/packages/pie-math/package.json
@@ -4,7 +4,10 @@
   "main": "./src/index.ts",
   "private": true,
   "scripts": {
-    "type-check": "tsc"
+    "lint": "tsc"
+  },
+  "devDependencies": {
+    "tsconfig": "*"
   },
   "author": "Serge Iyashenko <[email protected]>",
   "repository": "https://github.com/serjilyashenko/simple-pie-project",

diff --git a/packages/pie-math/tsconfig.json b/packages/pie-math/tsconfig.json
@@ -1,15 +1,5 @@
 {
-  "compilerOptions": {
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "isolatedModules": true,
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "preserveWatchOutput": true,
-    "skipLibCheck": true,
-    "noEmit": true,
-    "strict": true
-  },
+  "extends": "tsconfig/pkg.json",
   "include": ["src"],
   "exclude": ["node_modules"]
 }
diff --git a/packages/react-simple-pie/package.json b/packages/react-simple-pie/package.json
@@ -12,9 +12,7 @@
   "scripts": {
     "dev": "npm run build -- --watch",
     "build": "tsup src/index.ts --format cjs,esm --dts --minify",
-    "npm:publish": "npm version patch && npm publish",
-    "type-check": "tsc",
-    "lint": "eslint src"
+    "lint": "tsc"
   },
   "devDependencies": {
     "@types/react": "18.2.64",

diff --git a/packages/react-simple-pie/tsconfig.json b/packages/react-simple-pie/tsconfig.json
@@ -1,15 +1,7 @@
 {
+  "extends": "tsconfig/pkg.json",
   "compilerOptions": {
-    "jsx": "react-jsx",
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "isolatedModules": true,
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "preserveWatchOutput": true,
-    "skipLibCheck": true,
-    "noEmit": true,
-    "strict": true
+    "jsx": "react-jsx"
   },
   "include": ["src"],
   "exclude": ["node_modules"]

diff --git a/packages/simple-pie/package.json b/packages/simple-pie/package.json
@@ -12,9 +12,7 @@
   "scripts": {
     "dev": "npm run build -- --watch",
     "build": "tsup src/index.ts --format cjs,esm --dts --minify",
-    "npm:publish": "npm version patch && npm publish",
-    "type-check": "tsc",
-    "lint": "eslint src"
+    "lint": "tsc"
   },
   "devDependencies": {
     "pie-math": "*",

diff --git a/packages/simple-pie/tsconfig.json b/packages/simple-pie/tsconfig.json
@@ -1,15 +1,5 @@
 {
-  "compilerOptions": {
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "isolatedModules": true,
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "preserveWatchOutput": true,
-    "skipLibCheck": true,
-    "noEmit": true,
-    "strict": true
-  },
+  "extends": "tsconfig/pkg.json",
   "include": ["src"],
   "exclude": ["node_modules"]
 }
diff --git a/packages/tsconfig/package.json b/packages/tsconfig/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "tsconfig",
+  "private": true
+}
diff --git a/packages/tsconfig/pkg.json b/packages/tsconfig/pkg.json
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "isolatedModules": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "noEmit": true,
+    "strict": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules"]
+}
diff --git a/packages/tsconfig/vite.json b/packages/tsconfig/vite.json
@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["src"],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}
diff --git a/packages/tsconfig/vite.node.json b/packages/tsconfig/vite.node.json
diff --git a/turbo.json b/turbo.json
@@ -5,6 +5,7 @@
       "dependsOn": ["^build"],
       "outputs": ["dist/**"]
     },
+    "lint": {},
     "dev": {
       "cache": false,
       "persistent": true,