feat(typescript): add type linting and configure gts as lint command (GoogleChrome#18)

MichaelSolati · web-flow · commit bcdcc75ef3de · 2020-07-30T17:19:00.000-07:00
diff --git a/package.json b/package.json
@@ -9,11 +9,13 @@
     "eleventy": "npx eleventy",
     "gulp:watch": "npx gulp watch",
     "gulp": "npx gulp",
+    "lint:js": "gts check",
+    "lint:types": "tsc --noEmit",
+    "lint": "npm-run-all lint:js lint:types",
     "production": "NODE_ENV=production npm-run-all clean gulp rollup eleventy",
     "rollup": "npx rollup -c",
     "rollup:watch": "npx chokidar \"site/**/*.js\" -c \"npx rollup -c\"",
     "server": "node ./server",
-    "check": "gts check",
     "fix": "gts fix"
   },
   "license": "Apache 2.0",
diff --git a/site/_data/lib/links.js b/site/_data/lib/links.js
@@ -6,16 +6,15 @@
  *
  * @param {string} itemUrl The link in question
  * @param {string} pageUrl The page context
- * @returns {string} The attributes or empty
+ * @returns {string|undefined} The attributes or empty
  */
 function getLinkActiveState(itemUrl, pageUrl) {
   if (itemUrl === pageUrl) {
     return ' data-state="active" aria-current="page"';
-  }
-
-  if (itemUrl.length > 1 && pageUrl.indexOf(itemUrl) === 0) {
+  } else if (itemUrl.length > 1 && pageUrl.indexOf(itemUrl) === 0) {
     return ' data-state="active"';
   }
+  return;
 }
 
 module.exports = {
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,41 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "allowJs": true,
+    "checkJs": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "outDir": "dist",
+    "rootDir": "./",
+    "noEmit": true,
+    "strict": true,
+    "noImplicitAny": false,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "baseUrl": "./",
+    "typeRoots": [
+      "node_modules/@types",
+    ],
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": [
+    "site/**/*",
+    "types/**/*.d.ts"
+  ],
+  "exclude": [
+    ".github",
+    ".vscode",
+    "dist",
+    "node_modules",
+    "test",
+    "./*.js"
+  ]
+}
diff --git a/types/todo.d.ts b/types/todo.d.ts
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare global {
+  export type TODO = any; // eslint-disable-line
+}
+
+// empty export to keep file a module
+export {};

Original file line number	Diff line number	Diff line change
`@@ -6,16 +6,15 @@`
`6`	`6`	`*`
`7`	`7`	`* @param {string} itemUrl The link in question`
`8`	`8`	`* @param {string} pageUrl The page context`
`9`		`- * @returns {string} The attributes or empty`
	`9`	`+ * @returns {string\|undefined} The attributes or empty`
`10`	`10`	`*/`
`11`	`11`	`function getLinkActiveState(itemUrl, pageUrl) {`
`12`	`12`	`if (itemUrl === pageUrl) {`
`13`	`13`	`return ' data-state="active" aria-current="page"';`
`14`		`- }`
`15`		`-`
`16`		`- if (itemUrl.length > 1 && pageUrl.indexOf(itemUrl) === 0) {`
	`14`	`+ } else if (itemUrl.length > 1 && pageUrl.indexOf(itemUrl) === 0) {`
`17`	`15`	`return ' data-state="active"';`
`18`	`16`	`}`
	`17`	`+ return;`
`19`	`18`	`}`
`20`	`19`
`21`	`20`	`module.exports = {`