ngx-devkit-builders 1.0.0 → 1.2.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 - 2023 Celtian
+Copyright (c) 2022 - 2024 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

package/README.md

@@ -17,45 +17,14 @@ This package contains Architect builders used to build and test Angular applicat
 
 ## Builders
 
-| Name    | Description                   |
-| ------- | ----------------------------- |
-| version | Create build information file |
+| Name                                                 | Description                       |
+| ---------------------------------------------------- | --------------------------------- |
+| [version](./src/version/README.md)                   | Create build information file     |
+| [robots](./src/robots/README.md)                     | Create simplified robots.txt file |
+| [copy-environment](./src/copy-environment/README.md) | Copy environment 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"
-            "variable": "VERSION", // or whatever you want
-            "verbose": false // or true
-          }
-        }
-      }
-  }
-}
-```
-
-2. Run command
-
-```
-ng run your-project-name:version
-```
-
 ## Compatibility
 
 | Angular | ngx-app-version | Install                      |
@@ -65,7 +34,7 @@ ng run your-project-name:version
 
 ## License
 
-Copyright © 2022 - 2023 [Dominik Hladik](https://github.com/Celtian)
+Copyright © 2022 - 2024 [Dominik Hladik](https://github.com/Celtian)
 
 All contents are licensed under the [MIT license].
 

package/builders.json

@@ -1,5 +1,15 @@
 {
   "builders": {
+    "copy-environment": {
+      "description": "Copy environment file",
+      "implementation": "./copy-environment",
+      "schema": "./copy-environment/schema.json"
+    },
+    "robots": {
+      "description": "Create simplified robots file",
+      "implementation": "./robots",
+      "schema": "./robots/schema.json"
+    },
     "version": {
       "description": "Create build information file",
       "implementation": "./version",

package/copy-environment/index.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const architect_1 = require("@angular-devkit/architect");
+const core_1 = require("@angular-devkit/core");
+const fs_extra_1 = require("fs-extra");
+async function copyFiles({ sourceFile, targetFile, overwrite }) {
+    return new Promise((resolve, reject) => {
+        (0, fs_extra_1.copy)(sourceFile, targetFile, { overwrite }, () => {
+            reject();
+        });
+        resolve();
+    });
+}
+exports.default = (0, architect_1.createBuilder)(async ({ verbose, source, target, overwrite }, ctx) => {
+    ctx.logger.info('🚧 Creating robots file…');
+    const projectMetadata = await ctx.getProjectMetadata(ctx.target.project);
+    if (projectMetadata.projectType !== 'application') {
+        ctx.logger.error('❌ Project must be type of application');
+        return {
+            success: false,
+        };
+    }
+    if (ctx.target.configuration) {
+        ctx.logger.info(`Selected configuration "${ctx.target.configuration}"`);
+    }
+    const rootPath = (0, core_1.getSystemPath)((0, core_1.normalize)(ctx.workspaceRoot));
+    const environmentsFolder = `${rootPath}/${projectMetadata.sourceRoot}/environments`;
+    if (verbose)
+        ctx.logger.info(`Target folder is here "${environmentsFolder}"`);
+    const sourceFile = `${environmentsFolder}/${source}`;
+    const targetFile = `${environmentsFolder}/${target}`;
+    try {
+        await copyFiles({
+            sourceFile,
+            targetFile,
+            overwrite,
+        });
+        if (overwrite) {
+            ctx.logger.info(`✔️  Environment replaced in "${targetFile}"`);
+        }
+        else {
+            ctx.logger.info(`✔️  Environment replaced in "${targetFile}" if not exists`);
+        }
+        return {
+            success: true,
+        };
+    }
+    catch {
+        ctx.logger.error(`❌ Failed to replace file "${targetFile}"`);
+        return {
+            success: false,
+        };
+    }
+});

package/copy-environment/schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "type": "object",
+  "properties": {
+    "source": {
+      "description": "Relative path to source file",
+      "type": "string"
+    },
+    "target": {
+      "description": "Relative path to target file",
+      "type": "string"
+    },
+    "overwrite": {
+      "description": "Overwrite target",
+      "type": "boolean",
+      "default": false
+    },
+    "verbose": {
+      "description": "Extended logging output",
+      "type": "boolean",
+      "default": false
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-devkit-builders",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "author": {
     "name": "Dominik Hladík",
     "email": "dominik.hladik@seznam.cz",
@@ -13,7 +13,8 @@
   "scripts": {},
   "dependencies": {
     "@angular-devkit/architect": "^0.1700.8",
-    "@angular-devkit/core": "^17.0.8"
+    "@angular-devkit/core": "^17.0.8",
+    "fs-extra": "^11.2.0"
   },
   "devDependencies": {},
   "homepage": "https://github.com/Celtian/ngx-devkit-builders#readme",

package/robots/index.js

@@ -0,0 +1,43 @@
+"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");
+const createRobots = (options) => {
+    const lines = ['User-agent: *'];
+    if (options.allow) {
+        lines.push('Allow: /');
+        if (options.sitemap) {
+            lines.push(`Sitemap: ${options.sitemap}`);
+        }
+    }
+    else {
+        lines.push('Disallow: /');
+    }
+    return lines.join('\n\n');
+};
+exports.default = (0, architect_1.createBuilder)(async ({ allow, sitemap, verbose }, ctx) => {
+    ctx.logger.info('🚧 Creating robots file…');
+    const projectMetadata = await ctx.getProjectMetadata(ctx.target.project);
+    if (projectMetadata.projectType !== 'application') {
+        ctx.logger.error('❌ Project must be type of application');
+        return {
+            success: false,
+        };
+    }
+    if (ctx.target.configuration) {
+        ctx.logger.info(`Selected configuration "${ctx.target.configuration}"`);
+    }
+    const rootPath = (0, core_1.getSystemPath)((0, core_1.normalize)(ctx.workspaceRoot));
+    const targetFile = `${rootPath}/${projectMetadata.sourceRoot}/robots.txt`;
+    if (verbose === true)
+        ctx.logger.info(`Target file is here "${targetFile}"`);
+    (0, fs_1.writeFileSync)(targetFile, createRobots({
+        allow,
+        sitemap,
+    }), { encoding: 'utf-8' });
+    ctx.logger.info(`✔️  Robots file successfully created in ${targetFile}`);
+    return {
+        success: true,
+    };
+});

package/robots/schema.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "type": "object",
+  "properties": {
+    "allow": {
+      "description": "Allow or disallow",
+      "type": "boolean",
+      "default": false
+    },
+    "sitemap": {
+      "description": "Sitemap.xml url",
+      "type": "string",
+      "default": ""
+    },
+    "verbose": {
+      "description": "Extended logging output",
+      "type": "boolean",
+      "default": false
+    }
+  }
+}

package/version/schema.json

@@ -30,7 +30,7 @@
     "verbose": {
       "description": "Extended logging output",
       "type": "boolean",
-      "default": "false"
+      "default": false
     }
   }
 }