♻️ Moving from JavaScript to TypeScript

Author: Juri Adams

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 build.ts
-src/
+src/
+bin/

README.md

@@ -20,7 +20,7 @@ export const buildInfo = {
     user: "Juri Adams",
     hash: "1e872b5",
     version: "1.1.4",
-    timestamp: "November 15, 2019 16:37:35"
+    timestamp: "November 15, 2019 16:37:35",
 };
 ```
 
@@ -59,22 +59,21 @@ import { environment } from "../environments/environment";
 @Component({
     selector: "app-root",
     templateUrl: "./app.component.html",
-    styleUrls: ["./app.component.css"]
+    styleUrls: ["./app.component.css"],
 })
 export class AppComponent {
     constructor() {
         console.log(
-            `\n%cBuild Info:\n\n%c ❯ Environment: %c${
-                environment.production ? "production 🏭" : "development 🚧"
-            }\n%c ❯ Build Version: ${buildInfo.version}\n ❯ Build Timestamp: ${
-                buildInfo.timestamp
-            }\n ❯ Built by: ${buildInfo.user}\n ❯ Commit: ${buildInfo.hash}\n`,
+            `\n%cBuild Info:\n\n` +
+                `%c ❯ Environment: %c${environment.production ? "production 🏭" : "development 🚧"}\n` +
+                `%c ❯ Build Version: ${buildInfo.version}\n` +
+                ` ❯ Build Timestamp: ${buildInfo.timestamp}\n` +
+                ` ❯ Built by: ${buildInfo.user}\n` +
+                ` ❯ Commit: ${buildInfo.hash}\n`,
             "font-size: 14px; color: #7c7c7b;",
             "font-size: 12px; color: #7c7c7b",
-            environment.production
-                ? "font-size: 12px; color: #95c230;"
-                : "font-size: 12px; color: #e26565;",
-            "font-size: 12px; color: #7c7c7b"
+            environment.production ? "font-size: 12px; color: #95c230;" : "font-size: 12px; color: #e26565;",
+            "font-size: 12px; color: #7c7c7b",
         );
     }
 }

bin/build-info.js renamed to angular-build-info.ts

@@ -1,33 +1,45 @@
 #! /usr/bin/env node
 
+/**
+ * IBuildInfo interface and typings
+ */
+interface IBuildInfo {
+    hash?: string; // Latest commit hash
+    timestamp?: string; // Timestamp on when the build was made
+    user?: string; // Current git user
+    version?: string; // `version` from package.json
+}
+
 /**
  * Dependencies
  */
-const moment = require("moment");
-const signale = require("signale");
-const util = require("util");
-const exec = util.promisify(require("child_process").exec);
-const fs = require("fs").promises;
+import { exec } from "child_process";
+import { promises as fs } from "fs";
+import moment from "moment";
+import signale from "signale";
+import { promisify } from "util";
+const execAsync = promisify(exec);
 
 /**
  * Information sources
  */
-const package = require(`${process.cwd()}/package.json`);
-const args = process.argv.slice(2);
-const opts = [
+// tslint:disable-next-line: no-var-requires
+const version = require(`${process.cwd()}/package.json`).version;
+const args: string[] = process.argv.slice(2);
+const opts: string[] = [
     "--help", // Shows manual
     "--init", // Perform initial setup
     "--no-hash", // Don't show commit hash in build info
     "--no-user", // Don't show git user in build info
     "--no-version", // Don't show package version in build info
-    "--no-time" // Don't show timestamp in build info
+    "--no-time", // Don't show timestamp in build info
 ];
 
 /**
  * Get relevant build information
  */
-async function getGitUser() {
-    const { stdout, stderr } = await exec("git config user.name");
+async function getGitUser(): Promise<string | undefined> {
+    const { stdout, stderr } = await execAsync("git config user.name");
     if (stderr) {
         signale.error("Error getting git user, skipping...");
         return undefined;
@@ -37,8 +49,8 @@ async function getGitUser() {
     }
 }
 
-async function getCommitHash() {
-    const { stdout, stderr } = await exec("git rev-parse --short HEAD");
+async function getCommitHash(): Promise<string | undefined> {
+    const { stdout, stderr } = await execAsync("git rev-parse --short HEAD");
     if (stderr) {
         signale.error("Error getting latest commit hash, skipping...");
         return undefined;
@@ -48,18 +60,19 @@ async function getCommitHash() {
     }
 }
 
-async function buildInfo() {
+async function buildInfo(): Promise<void> {
     signale.start("Collecting build information...");
 
     // Check provided args if they exist
-    args.map(arg => {
+    args.map((arg: any) => {
         if (!opts.includes(arg)) {
-            throw `Error: Unknown arg "${arg}", please re-check arguments before running the tool again!`;
+            signale.error(`Error: Unknown arg "${arg}", please re-check arguments before running the tool again!`);
+            process.exit(1);
         }
     });
 
     // Object we store build info in
-    let build = {};
+    const build: IBuildInfo = {};
 
     if (!args.includes("--no-hash")) {
         build.hash = await getCommitHash();
@@ -70,7 +83,7 @@ async function buildInfo() {
     }
 
     if (!args.includes("--no-version")) {
-        build.version = package.version;
+        build.version = version;
     }
 
     if (!args.includes("--no-time")) {
@@ -89,33 +102,33 @@ async function buildInfo() {
             "// Angular build information, automatically generated by `angular-build-info`\n" +
                 "export const buildInfo = " +
                 JSON.stringify(build, null, 4).replace(/\"([^(\")"]+)\":/g, "$1:") +
-                ";\n"
+                ";\n",
         );
         signale.success(`Saved build information to \`${exportPath}\``);
     } catch {
         signale.error(`An error occured writing to \`${exportPath}\`, does the path exist?`);
     }
 }
 
-async function init() {
+async function init(): Promise<void> {
     // Path we write the file to, should match your Angular projects `src/` folder
     const exportPath = process.cwd() + "/src/build.ts";
 
     signale.info("Welcome to `angular-build-info`!");
     signale.info(
-        `We will now create a boilerplate \`build.ts\` file in \`${exportPath}\` and fill it with basic information so you can start implementing it in your front-end.`
+        `We will now create a boilerplate \`build.ts\` file in \`${exportPath}\` and fill it with basic information so you can start implementing it in your front-end.`,
     );
     signale.info(
-        `If you wish for more info on how to implement the provided info in your Angular app, feel free to check out the main repo over at https://github.com/4dams/angular-build-info`
+        `If you wish for more info on how to implement the provided info in your Angular app, feel free to check out the main repo over at https://github.com/4dams/angular-build-info`,
     );
 
     signale.start("Creating `build.ts` file...");
 
     const template = {
-        user: "Octocat",
         hash: "1e872b5",
+        timestamp: moment().format("MMMM DD, YYYY HH:mm:ss"),
+        user: "Octocat",
         version: "1.0.0",
-        timestamp: moment().format("MMMM DD, YYYY HH:mm:ss")
     };
 
     // Try writing file, if it fails, display error message
@@ -125,12 +138,12 @@ async function init() {
             "// Angular build information, automatically generated by `angular-build-info`\n" +
                 "export const buildInfo = " +
                 JSON.stringify(template, null, 4).replace(/\"([^(\")"]+)\":/g, "$1:") +
-                ";\n"
+                ";\n",
         );
 
         signale.success("Successfully created `build.ts` file!");
         signale.info(
-            "You should now modify your build/deploy scripts in your `package.json` file to run this script every time before your Angular app is built. An example would be:"
+            "You should now modify your build/deploy scripts in your `package.json` file to run this script every time before your Angular app is built. An example would be:",
         );
         signale.info(`[...] "build": "build-info && ng build --prod", [...]`);
         signale.info("Again, you can find more info on implementing this tool on the main repo.");
@@ -153,7 +166,7 @@ async function displayManual() {
 /**
  * Main function we run upon starting the script
  */
-function start() {
+function start(): void {
     if (args.includes("--init")) {
         init();
         return;

package-lock.json

@@ -1,13 +1,15 @@
 {
     "name": "angular-build-info",
     "version": "1.0.2",
-    "description": "A command line interface to collect information about your current build.",
+    "description": "🛠 A command line interface to collect build information for your Angular application.",
     "main": "index.js",
     "bin": {
         "angular-build-info": "bin/build-info.js"
     },
     "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1"
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "build": "tsc",
+        "publish": "npm ci && tsc && npm publish"
     },
     "repository": {
         "type": "git",
@@ -30,5 +32,9 @@
     "dependencies": {
         "moment": "^2.24.0",
         "signale": "^1.4.0"
+    },
+    "devDependencies": {
+        "@types/node": "^12.12.12",
+        "@types/signale": "^1.2.1"
     }
 }

package.json

@@ -0,0 +1,67 @@
+{
+    "compilerOptions": {
+        /* Basic Options */
+        // "incremental": true,                   /* Enable incremental compilation */
+        "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
+        "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+        // "lib": [],                             /* Specify library files to be included in the compilation. */
+        // "allowJs": true,                       /* Allow javascript files to be compiled. */
+        // "checkJs": true,                       /* Report errors in .js files. */
+        // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+        // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+        // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+        // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+        // "outFile": "./",                       /* Concatenate and emit output to single file. */
+        "outDir": "./bin" /* Redirect output structure to the directory. */,
+        // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+        // "composite": true,                     /* Enable project compilation */
+        // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+        // "removeComments": true,                /* Do not emit comments to output. */
+        // "noEmit": true,                        /* Do not emit outputs. */
+        // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+        // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+        // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+        /* Strict Type-Checking Options */
+        "strict": true /* Enable all strict type-checking options. */,
+        // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+        // "strictNullChecks": true,              /* Enable strict null checks. */
+        // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+        // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+        // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+        // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+        // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+        /* Additional Checks */
+        // "noUnusedLocals": true,                /* Report errors on unused locals. */
+        // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+        // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+        // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+        /* Module Resolution Options */
+        // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+        // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+        // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+        // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+        // "typeRoots": [],                       /* List of folders to include type definitions from. */
+        // "types": [],                           /* Type declaration files to be included in compilation. */
+        // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+        "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+        // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+        // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+        /* Source Map Options */
+        // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+        // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+        // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+        // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+        /* Experimental Options */
+        // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+        // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+        /* Advanced Options */
+        "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */,
+        "resolveJsonModule": true
+    }
+}

tsconfig.json

@@ -0,0 +1,9 @@
+{
+    "defaultSeverity": "error",
+    "extends": [
+        "tslint:recommended"
+    ],
+    "jsRules": {},
+    "rules": {},
+    "rulesDirectory": []
+}