fix: provide default value for remote option (#194)

Author: fmalcher

src/deploy/schema.json

@@ -26,7 +26,8 @@
     },
     "remote": {
       "type": "string",
-      "description": "Provide the remote name. If no value is provided, `origin` is used. Has no function if --repo is set."
+      "description": "Provide the remote name. If no value is provided, `origin` is used. Has no function if --repo is set.",
+      "default": "origin"
     },
     "repo": {
       "type": "string",

src/engine/engine.spec.ts

@@ -83,6 +83,22 @@ describe('engine', () => {
 
       expect(finalOptions.repo).toMatch(/angular-schule\/angular-cli-ghpages/);
     });
+
+    describe('remote', () => {
+      it('should use the provided remote if --remote is set', async () => {
+        const options = { remote: 'foobar', repo: 'xxx' };
+        const finalOptions = await engine.prepareOptions(options, logger);
+
+        expect(finalOptions.remote).toBe('foobar');
+      });
+
+      it('should use the origin remote if --remote is not set', async () => {
+        const options = { repo: 'xxx' };
+        const finalOptions = await engine.prepareOptions(options, logger);
+
+        expect(finalOptions.remote).toBe('origin');
+      });
+    });
   });
 
   describe('prepareOptions - handling dotfiles, notfound, and nojekyll', () => {

src/engine/engine.ts

@@ -297,6 +297,7 @@ async function publishViaGhPages(
         {
           dir,
           repo: options.repo || 'current working directory (which must be a git repo in this case) will be used to commit & push',
+          remote: options.remote,
           message: options.message,
           branch: options.branch,
           name: options.name ? `the name '${options.username} will be used for the commit` : 'local or global git user name will be used for the commit',