feat(typescript): add base config

README.md

@@ -320,6 +320,55 @@ To show final ESLint config:
 npx eslint --print-config <some-file>
 ```
 
+## TypeScript
+
+We provide a base config for TypeScript which contains some defaults we usually
+use.
+
+To use it, just extend it in your `tsconfig.json`:
+
+```json
+{
+  "extends": "@datarockets/style-guide/typescript"
+}
+```
+
+The base config isn't intented to be used as a complete one so you might need
+to add more settings in your `tsconfig.json`. For example:
+
+```json
+{
+  "extends": "@datarockets/style-guide/typescript",
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "noEmit": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ],
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts",
+    ".storybook/**/*"
+  ],
+  "exclude": ["node_modules"]
+}
+```
+
 ## Acknowledge
 
 Inspired by https://github.com/vercel/style-guide.

package.json

@@ -13,12 +13,14 @@
   "license": "MIT",
   "exports": {
     "./eslint/*": "./eslint/configs/*.js",
-    "./prettier": "./prettier/index.js"
+    "./prettier": "./prettier/index.js",
+    "./typescript": "./typescript/tsconfig.base.json"
   },
   "main": "index.js",
   "files": [
     "eslint",
-    "prettier"
+    "prettier",
+    "typescript"
   ],
   "scripts": {
     "format": "prettier --write .",

typescript/tsconfig.base.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "docs": "https://github.com/datarockets/style-guide",
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "incremental": true
+  }
+}