feat(build): add --cordova-mock option (#63)

Add support for adding a blank `cordova.js` to the build with `--cordova-mock`.

Author: tlancina

builders/cordova-build/cordova.js

@@ -0,0 +1 @@
+// mock cordova.js

builders/cordova-build/index.ts

@@ -23,12 +23,25 @@ export class CordovaBuildBuilder implements Builder<CordovaBuildBuilderSchema> {
       tap(description => browserDescription = description),
       concatMap(() => this.context.architect.validateBuilderOptions(browserConfig, browserDescription)),
       tap(config => browserConfig = config),
+      tap(() => this.validateBuilderConfig(builderConfig.options)),
       tap(() => this.prepareBrowserConfig(builderConfig.options, browserConfig.options)),
       concatMap(() => of(this.context.architect.getBuilder(browserDescription, this.context))),
       concatMap(builder => builder.run(browserConfig))
     );
   }
 
+  // Mutates builderOptions
+  validateBuilderConfig(builderOptions: CordovaBuildBuilderSchema) {
+    // if we're mocking cordova.js, don't build cordova bundle
+    if (builderOptions.cordovaMock) {
+      builderOptions.cordovaAssets = false;
+    }
+
+    if (builderOptions.cordovaAssets && !builderOptions.platform) {
+      throw new Error('The `--platform` option is required with `--cordova-assets`');
+    }
+  }
+
   // Mutates browserOptions
   prepareBrowserConfig(options: CordovaBuildBuilderSchema, browserOptions: BrowserBuilderSchema) {
     const cordovaBasePath = normalize(options.cordovaBasePath ? options.cordovaBasePath : '.');
@@ -41,7 +54,13 @@ export class CordovaBuildBuilder implements Builder<CordovaBuildBuilderSchema> {
     // by default. Let's keep it around.
     browserOptions.deleteOutputPath = false;
 
-    if (options.cordovaAssets) {
+    if (options.cordovaMock) {
+      browserOptions.scripts.push({
+        input: getSystemPath(join(normalize(__dirname), normalize('cordova.js'))),
+        bundleName: 'cordova',
+        lazy: false,
+      });
+    } else if (options.cordovaAssets) {
       const platformWWWPath = join(cordovaBasePath, normalize(`platforms/${options.platform}/platform_www`));
 
       // Add Cordova www assets that were generated whenever platform(s) and

builders/cordova-build/schema.d.ts

@@ -1,7 +1,8 @@
 export interface CordovaBuildBuilderSchema {
   browserTarget: string;
-  platform: string;
+  platform?: string;
   cordovaBasePath?: string;
   sourceMap?: boolean;
   cordovaAssets?: boolean;
+  cordovaMock?: boolean;
 }

builders/cordova-build/schema.json

@@ -23,11 +23,15 @@
       "type": "boolean",
       "description": "Bundle Cordova assets with build",
       "default": true
+    },
+    "cordovaMock": {
+      "type": "boolean",
+      "description": "Bundle empty cordova.js with build",
+      "default": false
     }
   },
   "additionalProperties": false,
   "required": [
-    "browserTarget",
-    "platform"
+    "browserTarget"
   ]
 }

builders/cordova-serve/index.ts

@@ -36,9 +36,9 @@ export class CordovaServeBuilder implements Builder<CordovaServeBuilderSchema> {
   }
 
   protected _getCordovaBuildConfig(cordovaServeOptions: CordovaServeBuilderSchema): Observable<BuilderConfiguration<CordovaBuildBuilderSchema>> {
-    const { platform } = cordovaServeOptions;
+    const { platform, cordovaAssets, cordovaMock } = cordovaServeOptions;
     const [ project, target, configuration ] = cordovaServeOptions.cordovaBuildTarget.split(':');
-    const cordovaBuildTargetSpec = { project, target, configuration, overrides: { platform } };
+    const cordovaBuildTargetSpec = { project, target, configuration, overrides: { platform, cordovaAssets, cordovaMock } };
     const cordovaBuildTargetConfig = this.context.architect.getBuilderConfiguration<CordovaBuildBuilderSchema>(cordovaBuildTargetSpec);
 
     return this.context.architect.getBuilderDescription(cordovaBuildTargetConfig).pipe(
@@ -54,6 +54,7 @@ class CordovaDevServerBuilder extends DevServerBuilder {
 
   buildWebpackConfig(root: Path, projectRoot: Path, host: virtualFs.Host<fs.Stats>, browserOptions: NormalizedBrowserBuilderSchema) {
     const builder = new CordovaBuildBuilder(this.context);
+    builder.validateBuilderConfig(this.cordovaBuildOptions);
     builder.prepareBrowserConfig(this.cordovaBuildOptions, browserOptions);
 
     return super.buildWebpackConfig(root, projectRoot, host, browserOptions);

builders/cordova-serve/schema.d.ts

@@ -1,10 +1,12 @@
 export interface CordovaServeBuilderSchema {
   cordovaBuildTarget: string;
   devServerTarget: string;
-  platform: string;
+  platform?: string;
   port?: number;
   host?: string;
   ssl?: boolean;
   cordovaBasePath?: string;
   sourceMap?: boolean;
+  cordovaAssets?: boolean;
+  cordovaMock?: boolean;
 }

builders/cordova-serve/schema.json

@@ -37,12 +37,21 @@
     "sourceMap":  {
       "type": "boolean",
       "description": "Create source-map file"
+    },
+    "cordovaAssets": {
+      "type": "boolean",
+      "description": "Bundle Cordova assets with build",
+      "default": true
+    },
+    "cordovaMock": {
+      "type": "boolean",
+      "description": "Bundle empty cordova.js with build",
+      "default": false
     }
   },
   "additionalProperties": false,
   "required": [
     "cordovaBuildTarget",
-    "devServerTarget",
-    "platform"
+    "devServerTarget"
   ]
 }