ngx-devkit-builders 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Celtian
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,63 @@
+<p align="center">
+  <a href="https://github.com/Celtian/ngx-devkit-builders" target="blank"><img src="assets/logo.svg?sanitize=true" alt="" width="120"></a>
+  <h1 align="center">NgxDevkit</h1>
+</p>
+
+[![npm version](https://badge.fury.io/js/ngx-devkit-builders.svg)](https://badge.fury.io/js/ngx-devkit-builders)
+[![Package License](https://img.shields.io/npm/l/ngx-devkit-builders.svg)](https://www.npmjs.com/ngx-devkit-builders)
+[![NPM Downloads](https://img.shields.io/npm/dm/ngx-devkit-builders.svg)](https://www.npmjs.com/ngx-devkit-builders)
+[![Build & Publish](https://github.com/celtian/ngx-devkit-builders/workflows/Build%20&%20Publish/badge.svg)](https://github.com/celtian/ngx-devkit-builders/actions)
+[![stars](https://badgen.net/github/stars/celtian/ngx-devkit-builders)](https://github.com/celtian/ngx-devkit-builders/)
+[![forks](https://badgen.net/github/forks/celtian/ngx-devkit-builders)](https://github.com/celtian/ngx-devkit-builders/)
+[![HitCount](http://hits.dwyl.com/celtian/ngx-devkit-builders.svg)](http://hits.dwyl.com/celtian/ngx-devkit-builders)
+
+This package contains Architect builders used to build and test Angular applications and libraries.
+
+> ✓ _Angular 15 compatible_
+
+## Builders
+
+| Name    | Description                   |
+| ------- | ----------------------------- |
+| version | Create build information file |
+
+_More builders can be added in the future._
+
+## Quick start
+
+1. Go to angular.json
+
+```json
+{
+  ...,
+  "projects": {
+    "your-project-name": { // project will be different
+      ...,
+      "architect": {
+        ...,
+        "version": { // name can be different if you want
+          "builder": "ngx-devkit-builders:version",
+          "options": { // not needed
+            "outputFile": "src/environments/version.ts", // or src/assets/version.json
+            "fields": ["version", "date", "author", "git"], // or custom selection
+            "lint": "eslint" // or "tslint"
+          }
+        }
+      }
+  }
+}
+```
+
+2. Run command
+
+```
+ng run your-project-name:version
+```
+
+## License
+
+Copyright &copy; 2022 [Dominik Hladik](https://github.com/Celtian)
+
+All contents are licensed under the [MIT license].
+
+[mit license]: LICENSE

package/builders.json

@@ -0,0 +1,9 @@
+{
+  "builders": {
+    "version": {
+      "description": "Create build information file",
+      "implementation": "./version",
+      "schema": "./version/schema.json"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "ngx-devkit-builders",
+  "version": "0.0.2",
+  "author": {
+    "name": "Dominik Hladík",
+    "email": "dominik.hladik@seznam.cz",
+    "url": "https://github.com/Celtian"
+  },
+  "private": false,
+  "license": "MIT",
+  "description": "Custom Angular builders",
+  "builders": "builders.json",
+  "scripts": {},
+  "dependencies": {
+    "@angular-devkit/architect": "^0.1500.3",
+    "@angular-devkit/core": "^15.0.3"
+  },
+  "devDependencies": {},
+  "homepage": "https://github.com/Celtian/ngx-devkit-builders#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Celtian/ngx-devkit-builders.git"
+  },
+  "keywords": [
+    "angular",
+    "ngx",
+    "builder",
+    "devkit"
+  ],
+  "bugs": {
+    "url": "https://github.com/Celtian/ngx-devkit-builders/issues"
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "peerDependencies": {
+    "@angular/core": ">=12",
+    "@angular/cli": ">=12"
+  }
+}

package/version/index.js

@@ -0,0 +1,48 @@
+"use strict";
+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 }, ctx) => {
+    ctx.logger.info('Creating version information file');
+    try {
+        const rootPath = (0, core_1.getSystemPath)((0, core_1.normalize)(ctx.workspaceRoot));
+        const encoding = 'utf-8';
+        const fileToPatch = `${rootPath}/${outputFile}`;
+        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 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);
+        const rawFormat = outputFile?.split('.')?.pop();
+        const format = ['json', 'ts'].includes(rawFormat) ? rawFormat : 'json';
+        if (format === 'ts') {
+            (0, fs_1.writeFileSync)(fileToPatch, `// IMPORTANT: THIS FILE IS AUTO GENERATED!
+/* ${lint === 'tslint' ? 'tslint:disable' : 'eslint-disable'} */
+export const VERSION = ${json};
+/* ${lint === 'tslint' ? 'tslint:enable' : 'eslint-enable'} */
+`, { encoding: 'utf-8' });
+        }
+        else {
+            (0, fs_1.writeFileSync)(fileToPatch, json, { encoding });
+        }
+    }
+    catch (error) {
+        return {
+            success: false
+        };
+    }
+    return {
+        success: true
+    };
+});

package/version/schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "type": "object",
+  "properties": {
+    "outputFile": {
+      "description": "File where version information will be created",
+      "type": "string",
+      "default": "src/environments/version.ts"
+    },
+    "fields": {
+      "description": "Array of fields which will be included",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": ["version", "date", "author", "git"]
+      },
+      "default": ["version", "date", "author", "git"]
+    },
+    "lint": {
+      "description": "Linter which will be disabled inside generated file",
+      "type": "string",
+      "enum": ["eslint", "tslint"],
+      "default": "eslint"
+    }
+  }
+}