ngx-devkit-builders 0.0.3 → 0.0.5

package/README.md

@@ -41,7 +41,8 @@ _More builders can be added in the future._
             "outputFile": "src/environments/version.ts", // or src/assets/version.json
             "fields": ["version", "date", "author", "git"], // or custom selection
             "lint": "eslint", // or "tslint"
-            "variable": "VERSION" // or whatever you want
+            "variable": "VERSION", // or whatever you want
+            "verbose": false // or true
           }
         }
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-devkit-builders",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "author": {
     "name": "Dominik Hladík",
     "email": "dominik.hladik@seznam.cz",

package/version/index.js

@@ -3,45 +3,85 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const architect_1 = require("@angular-devkit/architect");
 const core_1 = require("@angular-devkit/core");
 const fs_1 = require("fs");
-exports.default = (0, architect_1.createBuilder)(({ outputFile, fields, lint, variable }, ctx) => {
+exports.default = (0, architect_1.createBuilder)(({ outputFile, fields, lint, variable, verbose }, ctx) => {
     ctx.logger.info('🚧 Creating version information file…');
     let targetFile = '';
+    const generalError = '❌ Creating version information file failed';
     try {
+        const result = {};
         const rootPath = (0, core_1.getSystemPath)((0, core_1.normalize)(ctx.workspaceRoot));
         const encoding = 'utf-8';
+        if (verbose === true)
+            ctx.logger.info(`Encoding for read/write is ${encoding}`);
         const fileToPatch = `${rootPath}/${outputFile}`;
+        if (verbose === true)
+            ctx.logger.info(`Output file is ${fileToPatch}`);
         targetFile = fileToPatch;
-        const packageJsonContent = (0, fs_1.readFileSync)(`${rootPath}/package.json`, encoding);
-        let head = (0, fs_1.readFileSync)(`${rootPath}/.git/HEAD`, encoding).toString().trim();
-        if (head.split(':').length > 1) {
-            head = head.split(':')[1].trim();
+        const packageJson = JSON.parse((0, fs_1.readFileSync)(`${rootPath}/package.json`, encoding));
+        if (fields.includes('version')) {
+            result.version = packageJson.version;
         }
-        const commit = head ? (0, fs_1.readFileSync)(`${rootPath}/.git/${head}`, encoding).toString().trim() : undefined;
-        const branch = head?.split('/')?.pop();
-        const packageJson = JSON.parse(packageJsonContent);
-        const git = branch || commit ? { branch, commit } : undefined;
-        const json = JSON.stringify({
-            version: fields.includes('version') ? packageJson.version : undefined,
-            date: fields.includes('date') ? new Date().toISOString() : undefined,
-            author: fields.includes('author') ? packageJson.author : undefined,
-            git: fields.includes('git') ? git : undefined
-        }, null, 2);
+        if (fields.includes('date')) {
+            result.date = new Date().toISOString();
+        }
+        if (fields.includes('author')) {
+            result.author = packageJson.author;
+        }
+        if (fields.includes('git')) {
+            const headFile = `${rootPath}/.git/HEAD`;
+            if (verbose === true)
+                ctx.logger.info(`Head is ${headFile}`);
+            if (!(0, fs_1.existsSync)(headFile)) {
+                ctx.logger.info(generalError);
+                ctx.logger.error(`${headFile} was not found`);
+                return {
+                    success: false
+                };
+            }
+            let head = (0, fs_1.readFileSync)(headFile, encoding).toString().trim();
+            if (head.split(':').length > 1) {
+                head = head.split(':')[1].trim();
+            }
+            if (verbose === true)
+                ctx.logger.info(`Head is ${head}`);
+            const refFile = `${rootPath}/.git/${head}`;
+            if (verbose === true)
+                ctx.logger.info(`Last commit is located here ${refFile}`);
+            if (!(0, fs_1.existsSync)(refFile)) {
+                ctx.logger.info(generalError);
+                ctx.logger.error(`${refFile} was not found`);
+                return {
+                    success: false
+                };
+            }
+            const commit = head ? (0, fs_1.readFileSync)(refFile, encoding).toString().trim() : undefined;
+            if (verbose === true)
+                ctx.logger.info(`Commit is ${commit}`);
+            const branch = head?.split('/')?.pop();
+            if (verbose === true)
+                ctx.logger.info(`Branch is ${branch}`);
+            const git = branch || commit ? { branch, commit } : undefined;
+            result.git = git;
+        }
+        const json = JSON.stringify(result, null, 2);
         const rawFormat = outputFile?.split('.')?.pop();
         const format = ['json', 'ts'].includes(rawFormat) ? rawFormat : 'json';
+        if (verbose === true)
+            ctx.logger.info(`Output format is: ${format}`);
         if (format === 'ts') {
             (0, fs_1.writeFileSync)(fileToPatch, `// IMPORTANT: THIS FILE IS AUTO GENERATED!
 /* ${lint === 'tslint' ? 'tslint:disable' : 'eslint-disable'} */
 export const ${variable} = ${json};
 /* ${lint === 'tslint' ? 'tslint:enable' : 'eslint-enable'} */
-`, { encoding: 'utf-8' });
+`, { encoding });
         }
         else {
             (0, fs_1.writeFileSync)(fileToPatch, json, { encoding });
         }
     }
     catch (error) {
-        ctx.logger.info('❌  Creating version information file failed');
-        ctx.logger.error(error);
+        ctx.logger.info(generalError);
+        ctx.logger.error(JSON.stringify(error, null, 2));
         return {
             success: false
         };

package/version/schema.json

@@ -26,6 +26,11 @@
       "description": "Variable name which will be used inside generated file",
       "type": "string",
       "default": "VERSION"
+    },
+    "verbose": {
+      "description": "Extended logging output",
+      "type": "boolean",
+      "default": "false"
     }
   }
 }