Merge pull request #2043 from guardian/aa/tsconfig

chore: Adopt `@guardian/tsconfig` to simplify `tsconfig.json`
guardian · Oct 5, 2023 · 173f134 · 173f134
2 parents c68b5a6 + d43919a
commit 173f134
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 72 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,5 @@ yarn-error.log
 node_modules
 # This repository currently uses npm over yarn due to some complications in releasing the library with yarn
 yarn.lock
+
+tsconfig.tsbuildinfo
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -30,6 +30,7 @@
   "devDependencies": {
     "@guardian/eslint-config-typescript": "7.0.0",
     "@guardian/eslint-plugin-tsdoc-required": "^0.1.3",
+    "@guardian/tsconfig": "^0.2.0",
     "@types/git-url-parse": "^9.0.1",
     "@types/jest": "^29.5.5",
     "@types/js-yaml": "^4.0.6",

diff --git a/src/bin/commands/new-project/index.ts b/src/bin/commands/new-project/index.ts
@@ -117,7 +117,7 @@ export const newCdkProject = async (props: NewProjectProps): CliCommandResponse
 
   // lib directory
   await constructStack({
-    imports: Imports.newStackImports(),
+    imports: Imports.newStackImports(!!config.yamlTemplateLocation),
     appName: config.appName,
     outputFile: basename(config.stackPath),
     outputDir: dirname(config.stackPath),

diff --git a/src/bin/commands/new-project/template/tsconfig.json.template b/src/bin/commands/new-project/template/tsconfig.json.template
@@ -1,31 +1,7 @@
 {
-  "ts-node": {
-    "compilerOptions": {
-      "module": "CommonJS"
-    }
-  },
+  "extends": "@guardian/tsconfig/tsconfig.json",
   "compilerOptions": {
-    "target": "ES2020",
-    "module": "ES2020",
-    "moduleResolution": "node",
-    "lib": ["ES2020"],
-    "declaration": true,
-    "strict": true,
-    "noImplicitAny": true,
-    "strictNullChecks": true,
-    "esModuleInterop": true,
-    "noImplicitThis": true,
-    "alwaysStrict": true,
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": false,
-    "inlineSourceMap": true,
-    "inlineSources": true,
-    "experimentalDecorators": true,
-    "strictPropertyInitialization": false,
-    "typeRoots": ["./node_modules/@types"],
-    "outDir": "dist"
+    "module": "CommonJS"
   },
   "include": ["lib/**/*", "bin/**/*"],
   "exclude": [

diff --git a/src/bin/commands/new-project/utils/imports.ts b/src/bin/commands/new-project/utils/imports.ts
@@ -14,16 +14,18 @@ export class Imports {
     this.imports = imports;
   }
 
-  public static newStackImports(): Imports {
+  public static newStackImports(addCfnIncludeImports: boolean): Imports {
     return new Imports({
-      path: {
-        types: [],
-        components: ["join"],
-      },
-      "aws-cdk-lib/cloudformation-include": {
-        types: [],
-        components: ["CfnInclude"],
-      },
+      ...(addCfnIncludeImports && {
+        path: {
+          types: [],
+          components: ["join"],
+        },
+        "aws-cdk-lib/cloudformation-include": {
+          types: [],
+          components: ["CfnInclude"],
+        },
+      }),
       "aws-cdk-lib": {
         types: ["App"],
         components: [],

diff --git a/src/bin/commands/new-project/utils/init.ts b/src/bin/commands/new-project/utils/init.ts
@@ -72,6 +72,7 @@ function createPackageJson(outputDirectory: string): void {
 
   const coreDeps: Record<string, string> = [
     "@guardian/eslint-config-typescript",
+    "@guardian/tsconfig",
     "@types/jest",
     "@types/node",
     "eslint",

diff --git a/tools/integration-test/package.json b/tools/integration-test/package.json
@@ -17,6 +17,7 @@
   },
   "devDependencies": {
     "@guardian/eslint-config-typescript": "7.0.0",
+    "@guardian/tsconfig": "^0.2.0",
     "@types/jest": "^29.1.2",
     "@types/node": "20.8.2",
     "aws-cdk": "2.95.1",

diff --git a/tools/integration-test/tsconfig.json b/tools/integration-test/tsconfig.json
@@ -1,31 +1,7 @@
 {
-  "ts-node": {
-    "compilerOptions": {
-      "module": "CommonJS"
-    }
-  },
+  "extends": "@guardian/tsconfig/tsconfig.json",
   "compilerOptions": {
-    "target": "ES2020",
-    "module": "ES2020",
-    "moduleResolution": "node",
-    "lib": ["ES2020"],
-    "declaration": true,
-    "strict": true,
-    "noImplicitAny": true,
-    "strictNullChecks": true,
-    "esModuleInterop": true,
-    "noImplicitThis": true,
-    "alwaysStrict": true,
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": false,
-    "inlineSourceMap": true,
-    "inlineSources": true,
-    "experimentalDecorators": true,
-    "strictPropertyInitialization": false,
-    "typeRoots": ["./node_modules/@types"],
-    "outDir": "dist"
+    "module": "CommonJS"
   },
   "include": [
     "src/**/*", "bin/**/*"

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,22 +1,13 @@
 {
+  "extends": "@guardian/tsconfig/tsconfig.json",
   "compilerOptions": {
     "target": "ES2020",
     "module": "commonjs",
-    "moduleResolution": "node",
     "declaration": true,
     "declarationMap": true,
-    "esModuleInterop": true,
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
     "sourceMap": true,
     "inlineSourceMap": false,
     "inlineSources": true,
-    "experimentalDecorators": true,
-    "typeRoots": ["./node_modules/@types"],
     "outDir": "lib"
   },
   "include": ["src/**/*"],