Merge pull request #124 from ngx-builders/feat/update-package-and-provide-withDeps-flag

Feat/update package and provide with deps flag

Author: santoshyadavdev

.github/workflows/nodejs.yml

@@ -18,7 +18,7 @@ jobs:
         working-directory: ./src
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [14.x]
 
     steps:
     - uses: actions/checkout@v2

src/README.md

@@ -71,6 +71,12 @@ This command causes the `--configuration` setting to have no effect.
 
 Specifies the base URL for the application being built.
 Same as `ng build --base-href=/XXX/`
+
+#### --with-deps <a name="withDeps"></a>
+- **optional**
+- Default: `false` (string)
+- Example:
+  - `ng deploy --with-deps` – Use this flag with Nx, to build your app withDeps.
 ## License
 
 MIT

src/deploy/index.ts

@@ -1,58 +1,92 @@
-import { BuilderContext, BuilderOutput, createBuilder } from '@angular-devkit/architect';
-import { json } from '@angular-devkit/core';
-import { Schema } from './schema';
-const NetlifyAPI = require('netlify');
+import {
+    BuilderContext,
+    BuilderOutput,
+    createBuilder,
+} from "@angular-devkit/architect";
+import { json } from "@angular-devkit/core";
+import { Schema } from "./schema";
+const NetlifyAPI = require("netlify");
 
 export default createBuilder(
-    async (builderConfig: Schema, context: BuilderContext): Promise<BuilderOutput> => {
+    async (
+        builderConfig: Schema,
+        context: BuilderContext
+    ): Promise<BuilderOutput> => {
         context.reportStatus(`Executing deploy...`);
         context.logger.info(`Executing netlify deploy command ...... `);
 
         if (builderConfig.noBuild) {
             context.logger.info(`📦 Skipping build`);
         } else {
-            const configuration = builderConfig.configuration || 'production';
+            const configuration = builderConfig.configuration || "production";
 
-            const overrides = {
+            const withDeps = {
+                ...{ withDeps: builderConfig.withDeps },
+            };
+
+            let overrides: any = {
                 // this is an example how to override the workspace set of options
-                ...(builderConfig.baseHref && { baseHref: builderConfig.baseHref })
+                ...(builderConfig.baseHref && {
+                    baseHref: builderConfig.baseHref,
+                }),
             };
 
-            if (!context.target) {
-                throw new Error('Cannot build the application without a target');
+            if (builderConfig.withDeps) {
+                overrides = {
+                    ...(builderConfig.baseHref && {
+                        baseHref: builderConfig.baseHref,
+                    }),
+                    withDeps: builderConfig.withDeps,
+                };
             }
 
-            const baseHref = builderConfig.baseHref ? `Your base-href: "${builderConfig.baseHref}` : '';
-            const buildTarget = builderConfig.buildTarget ? builderConfig.buildTarget : 'build';
-            context.logger.info(`📦 Building "${context.target.project}". Configuration: "${configuration}". Build Command: ${buildTarget}. ${baseHref}`);
+            if (!context.target) {
+                throw new Error(
+                    "Cannot build the application without a target"
+                );
+            }
 
-            const build = await context.scheduleTarget({
-                target: buildTarget,
-                project: context.target.project || '',
-                configuration
-            }, overrides as json.JsonObject);
+            const baseHref = builderConfig.baseHref
+                ? `Your base-href: "${builderConfig.baseHref}`
+                : "";
+            const buildTarget = builderConfig.buildTarget
+                ? builderConfig.buildTarget
+                : "build";
+            context.logger.info(
+                `📦 Building "${context.target.project}". Configuration: "${configuration}". Build Command: ${buildTarget}. ${baseHref}`
+            );
+
+            const build = await context.scheduleTarget(
+                {
+                    target: buildTarget,
+                    project: context.target.project || "",
+                    configuration,
+                },
+                overrides as json.JsonObject
+            );
 
             const buildResult = await build.result;
 
             if (buildResult.success !== true) {
                 context.logger.error(`❌ Application build failed`);
                 return {
                     error: `❌ Application build failed`,
-                    success: false
+                    success: false,
                 };
             }
 
             context.logger.info(`✔ Build Completed`);
         }
 
-        const netlifyToken = process.env.NETLIFY_TOKEN || builderConfig.netlifyToken;
-        if (netlifyToken === '' || netlifyToken === undefined) {
+        const netlifyToken =
+            process.env.NETLIFY_TOKEN || builderConfig.netlifyToken;
+        if (netlifyToken === "" || netlifyToken === undefined) {
             context.logger.error("🚨 Netlify Token not found !");
             return { success: false };
         }
 
         let siteId = process.env.NETLIFY_API_ID || builderConfig.siteId;
-        if (siteId === '' || siteId === undefined) {
+        if (siteId === "" || siteId === undefined) {
             // site id is needed if the create option is false
             if (builderConfig.create === false) {
                 context.logger.error("🚨 API ID (Site ID) not found !");
@@ -61,11 +95,11 @@ export default createBuilder(
         }
 
         const client = new NetlifyAPI(netlifyToken, {
-            userAgent: 'netlify/js-client',
-            scheme: 'https',
-            host: 'api.netlify.com',
-            pathPrefix: '/api/v1',
-            globalParams: {}
+            userAgent: "netlify/js-client",
+            scheme: "https",
+            host: "api.netlify.com",
+            pathPrefix: "/api/v1",
+            globalParams: {},
         });
 
         // let check if the site exists
@@ -82,20 +116,20 @@ export default createBuilder(
                     // if the create is false - just return the error
                     if (builderConfig.create !== true) {
                         return {
-                            success: false
+                            success: false,
                         };
                     }
                     break;
                 case 401:
                     context.logger.fatal("🚨 Netlify: Unauthorized Token");
                     return {
-                        success: false
+                        success: false,
                     };
                 default:
-                    // for all other errors 
+                    // for all other errors
                     return {
                         error: e.message,
-                        success: false
+                        success: false,
                     };
             }
         }
@@ -106,36 +140,48 @@ export default createBuilder(
                 context.logger.info(`Creating new site for the application`);
                 site = await client.createSite();
                 siteId = site.id as string;
-                context.logger.info(`✔ Site "${site.name}" (${siteId}) created. Please update the angular.json so on the next run we can re-deploy on the same site`);
+                context.logger.info(
+                    `✔ Site "${site.name}" (${siteId}) created. Please update the angular.json so on the next run we can re-deploy on the same site`
+                );
             } catch (e) {
                 context.logger.error("🚨 Unable to create the site");
                 return {
                     error: e.message,
-                    success: false
+                    success: false,
                 };
             }
         }
 
         // if we still don't have the site return with error
         if (!site) {
-            context.logger.error("🚨 Unable to deploy as we don't have any context about the site");
+            context.logger.error(
+                "🚨 Unable to deploy as we don't have any context about the site"
+            );
             return {
                 error: "🚨 Unable to deploy as we don't have any context about the site",
-                success: false
+                success: false,
             };
         }
 
         // lets deploy the application to the site
         try {
-            context.logger.info(`Deploying project from 📂 ./${builderConfig.outputPath}`);
-            const response = await client.deploy(siteId, builderConfig.outputPath);
-            context.logger.info(`✔ Your updated site 🕸  is running at ${response.deploy.ssl_url}`);
+            context.logger.info(
+                `Deploying project from 📂 ./${builderConfig.outputPath}`
+            );
+            const response = await client.deploy(
+                siteId,
+                builderConfig.outputPath
+            );
+            context.logger.info(
+                `✔ Your updated site 🕸  is running at ${response.deploy.ssl_url}`
+            );
             return { success: true };
         } catch (e) {
             context.logger.error(`❌ Deployment failed: ${e.message}`);
             return {
                 error: e.message,
-                success: false
+                success: false,
             };
         }
-    });
+    }
+);

src/deploy/schema.d.ts

@@ -7,4 +7,5 @@ export interface Schema {
     siteId?: string;
     baseHref?: string;
     create?: boolean;
+    withDeps?: boolean
 }

src/deploy/schema.json

@@ -1,44 +1,49 @@
 {
-  "$id": "Schema",
-  "title": "schema",
-  "description": "Deployment of Angular CLI applications to Netlify",
-  "properties": {
-    "buildTarget": {
-      "type": "string",
-      "default": "build",
-      "description": "A build target command."
-    },
-    "configuration": {
-      "type": "string",
-      "default": "production",
-      "description": "A named build target, as specified in the `configurations` section of angular.json. Each named target is accompanied by a configuration of option defaults for that target. Same as `ng build --configuration=XXX`.",
-      "alias": "c"
-    },
-    "noBuild": {
-      "type": "boolean",
-      "default": false,
-      "description": "Skip build process during deployment."
-    },
-    "outputPath": {
-      "type": "string",
-      "description": "This is one of the options you can freely choose according to your needs. --- We will 'deploy' to this folder."
-    },
-    "netlifyToken": {
-      "type": "string",
-      "description": "Acess token give you the ability to communicate with netlify over API."
-    },
-    "siteId": {
-      "type": "string",
-      "description": "Every netlify app have a API ID which uniquly identify that app."
-    },
-    "baseHref": {
-      "type": "string",
-      "description": "This is an example how to override the workspace set of options. --- Base url for the application being built. Same as `ng build --base-href=/XXX/`."
-    },
-    "create": {
-      "type": "boolean",
-      "default": false,
-      "description": "Creates the site if it does not exists or no site id is set"
+    "$id": "Schema",
+    "title": "schema",
+    "description": "Deployment of Angular CLI applications to Netlify",
+    "properties": {
+        "buildTarget": {
+            "type": "string",
+            "default": "build",
+            "description": "A build target command."
+        },
+        "configuration": {
+            "type": "string",
+            "default": "production",
+            "description": "A named build target, as specified in the `configurations` section of angular.json. Each named target is accompanied by a configuration of option defaults for that target. Same as `ng build --configuration=XXX`.",
+            "alias": "c"
+        },
+        "noBuild": {
+            "type": "boolean",
+            "default": false,
+            "description": "Skip build process during deployment."
+        },
+        "outputPath": {
+            "type": "string",
+            "description": "This is one of the options you can freely choose according to your needs. --- We will 'deploy' to this folder."
+        },
+        "netlifyToken": {
+            "type": "string",
+            "description": "Acess token give you the ability to communicate with netlify over API."
+        },
+        "siteId": {
+            "type": "string",
+            "description": "Every netlify app have a API ID which uniquly identify that app."
+        },
+        "baseHref": {
+            "type": "string",
+            "description": "This is an example how to override the workspace set of options. --- Base url for the application being built. Same as `ng build --base-href=/XXX/`."
+        },
+        "create": {
+            "type": "boolean",
+            "default": false,
+            "description": "Creates the site if it does not exists or no site id is set"
+        },
+        "withDeps": {
+            "type": "boolean",
+            "default": false,
+            "description": "To be used with Nx if app needs to be built with-deps"
+        }
     }
-  }
 }