Fix all tests + handling of dotfiles, notfound, and nojekyll for Comm…

…ander vs. Angular CLI (#180)

* fix jest / ts-jest setup

* Looks like the angularfire team has now changed their setup like this:
https://github.com/angular/angularfire/blob/master/package.json

only dependencies and devDependencies, no peerDependencies any longer. And they skipped all previous version, too. So I think I will try this out too:

* fixing snapshot file

* remove support for deprecated defaultProject setting

* fix all unit tests

* tests for Commander CLI Options

* tests for Angular CLI options

* remove own consoleLogger

* 2.0.0-beta.2

* Update docs/README_standalone.md

Co-authored-by: Ferdinand Malcher <[email protected]>

* Update docs/README_standalone.md

Co-authored-by: Ferdinand Malcher <[email protected]>

* Update docs/README_standalone.md

Co-authored-by: Ferdinand Malcher <[email protected]>

---------

Co-authored-by: Ferdinand Malcher <[email protected]>

README.md

@@ -158,10 +158,7 @@ This will install the NPM package and add the necessary `deploy` configuration t
 ng add angular-cli-ghpages
 ```
 
-The `deploy` config will be added for the specified `defaultProject`.
-If there is no `defaultProject` set and there is only one project in your workspace, this project will be used.
-
-If you have multiple projects in one workspace, you can manually define the project name:
+If you have multiple projects in one workspace, you should manually define the project name:
 
 ```sh
 ng add angular-cli-ghpages --project MYPROJECTNAME

docs/README_standalone.md

@@ -16,44 +16,29 @@ The command `npx` is also able to install `angular-cli-ghpages` on the first usa
 
 ## Usage
 
-Execute `npx angular-cli-ghpages` in order to deploy the project with a build from `dist` folder.  
-**Note: You have to create the `dist` folder first (e.g. by running `ng build --prod`).**
+Execute `npx angular-cli-ghpages` in order to deploy the project with a build from `dist` folder. (`dist` is the default)
+**Note: You have to create the `dist` folder first (e.g. by running `ng build`).**
 
-Usage:
+Since Angular CLI 6 the build artifacts will be put in a subfolder, e.g. `dist/PROJECTNAME`.
+Since Angular CLI 17 the build artifacts will be put in a subfolder, followed by the folder `browser`, e.g. `dist/PROJECTNAME/browser`.
 
-```bash
-ng build --prod --base-href "https://USERNAME.github.io/REPOSITORY_NAME/"
-npx angular-cli-ghpages [OPTIONS]
-```
+Please take a look at the `dist` folder to see whether there is a subfolder with your project's name or not.
+If yes, you need to specify the deploy directory manually then when using this tool:
 
-or
+Usage:
 
 ```bash
-ng build --prod --base-href "/REPOSITORY_NAME/"
-npx angular-cli-ghpages [OPTIONS]
+ng build --base-href "/REPOSITORY_NAME/"
+npx angular-cli-ghpages --dir=dist/[PROJECTNAME]/browser
 ```
 
 or (`<base href="/">` stays untouched)
 
 ```bash
-ng build --prod
-npx angular-cli-ghpages [OPTIONS]
+ng build
+npx angular-cli-ghpages [OPTIONS]  --dir=dist/[PROJECTNAME]/browser
 ```
 
-If you want to push to `gh-pages` on the same repository with your default credentials, then just enter `npx angular-cli-ghpages` without any options.
-
-### Usage with Angular CLI 6 or higher
-
-With Angular CLI 6 the build artifacts will be put in a subfolder under `dist`.
-Please take a look at the `dist` folder to see whether there is a subfolder with your project's name or not.
-If yes, you need to specify the deploy directory manually then when using this tool:
-
-```bash
-npx angular-cli-ghpages --dir=dist/[PROJECTNAME]
-```
-
-I most cases, the `[PROJECTNAME]` can be found in the `angular.json` file at `defaultProject`.
-
 ### Usage with Ionic
 
 You can use the tool with Angular based Ionic projects, too. Instead of the ` dist` folder, the Ionic CLI will create a `www` folder you have to point the tool to. Just use the following commands:
@@ -76,7 +61,7 @@ In example, the following command runs [on our Travis-CI](https://travis-ci.org/
 npx angular-cli-ghpages --repo=https://[email protected]/<username>/<repositoryname>.git --name="Displayed Username" [email protected]
 ```
 
-> You have to treat the GH_TOKEN as secure as a password!
+> Don't share the GH_TOKEN with anyone! It is essentially a password to your GitHub account.
 
 ## Options
 

src/__snapshots__/ng-add.spec.ts.snap

@@ -2,29 +2,29 @@
 
 exports[`ng-add generating files generates new files if starting from scratch 1`] = `
 "{
-  \\"version\\": 1,
-  \\"projects\\": {
-    \\"THEPROJECT\\": {
-      \\"projectType\\": \\"application\\",
-      \\"root\\": \\"PROJECTROOT\\",
-      \\"architect\\": {
-        \\"build\\": {
-          \\"options\\": {
-            \\"outputPath\\": \\"dist/THEPROJECT\\"
+  "version": 1,
+  "projects": {
+    "THEPROJECT": {
+      "projectType": "application",
+      "root": "PROJECTROOT",
+      "architect": {
+        "build": {
+          "options": {
+            "outputPath": "dist/THEPROJECT"
           }
         },
-        \\"deploy\\": {
-          \\"builder\\": \\"angular-cli-ghpages:deploy\\"
+        "deploy": {
+          "builder": "angular-cli-ghpages:deploy"
         }
       }
     },
-    \\"OTHERPROJECT\\": {
-      \\"projectType\\": \\"application\\",
-      \\"root\\": \\"PROJECTROOT\\",
-      \\"architect\\": {
-        \\"build\\": {
-          \\"options\\": {
-            \\"outputPath\\": \\"dist/OTHERPROJECT\\"
+    "OTHERPROJECT": {
+      "projectType": "application",
+      "root": "PROJECTROOT",
+      "architect": {
+        "build": {
+          "options": {
+            "outputPath": "dist/OTHERPROJECT"
           }
         }
       }
@@ -35,33 +35,33 @@ exports[`ng-add generating files generates new files if starting from scratch 1`
 
 exports[`ng-add generating files overrides existing files 1`] = `
 "{
-  \\"version\\": 1,
-  \\"projects\\": {
-    \\"THEPROJECT\\": {
-      \\"projectType\\": \\"application\\",
-      \\"root\\": \\"PROJECTROOT\\",
-      \\"architect\\": {
-        \\"build\\": {
-          \\"options\\": {
-            \\"outputPath\\": \\"dist/THEPROJECT\\"
+  "version": 1,
+  "projects": {
+    "THEPROJECT": {
+      "projectType": "application",
+      "root": "PROJECTROOT",
+      "architect": {
+        "build": {
+          "options": {
+            "outputPath": "dist/THEPROJECT"
           }
         },
-        \\"deploy\\": {
-          \\"builder\\": \\"angular-cli-ghpages:deploy\\"
+        "deploy": {
+          "builder": "angular-cli-ghpages:deploy"
         }
       }
     },
-    \\"OTHERPROJECT\\": {
-      \\"projectType\\": \\"application\\",
-      \\"root\\": \\"PROJECTROOT\\",
-      \\"architect\\": {
-        \\"build\\": {
-          \\"options\\": {
-            \\"outputPath\\": \\"dist/OTHERPROJECT\\"
+    "OTHERPROJECT": {
+      "projectType": "application",
+      "root": "PROJECTROOT",
+      "architect": {
+        "build": {
+          "options": {
+            "outputPath": "dist/OTHERPROJECT"
           }
         },
-        \\"deploy\\": {
-          \\"builder\\": \\"angular-cli-ghpages:deploy\\"
+        "deploy": {
+          "builder": "angular-cli-ghpages:deploy"
         }
       }
     }

src/angular-cli-ghpages

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-// the standalone version
+// the standalone version, pure js, no compilation necessary
 
 var path = require('path'),
   engine = require('./engine/engine'),

src/angular-cli-ghpages.spec.ts

@@ -0,0 +1,33 @@
+import path from 'path';
+import fs from 'fs';
+
+import { execSync } from 'child_process';
+
+
+function runCliWithArgs(args) {
+
+  const distFolder = path.resolve(__dirname, 'dist');
+
+  if (!fs.existsSync(distFolder)) {
+    throw new Error(`Dist directory ${distFolder} not found. Can't execute test! The directory must exist from the last build.`);
+  }
+  const program = path.resolve(__dirname, 'dist/angular-cli-ghpages');
+  return execSync(`node ${program} --dry-run ${args}`).toString();
+}
+
+describe('Commander CLI options', () => {
+
+  test('should set dotfiles, notfound, and nojekyll to `true` by default', () => {
+    const output = runCliWithArgs('');
+    expect(output).toContain(`"dotfiles": "files starting with dot ('.') will be included"`);
+    expect(output).toContain('"notfound": "a 404.html file will be created"');
+    expect(output).toContain('"nojekyll": "a .nojekyll file will be created"');
+  });
+
+  test('should set dotfiles, notfound, and nojekyll to `false` with no- flags', () => {
+    const output = runCliWithArgs('--no-dotfiles --no-notfound --no-nojekyll');
+    expect(output).toMatch(`"dotfiles": "files starting with dot ('.') will be ignored"`);
+    expect(output).toMatch('"notfound": "a 404.html file will NOT be created"');
+    expect(output).toMatch('"nojekyll": "a .nojekyll file will NOT be created"');
+  });
+});

src/deploy/actions.spec.ts

@@ -6,7 +6,7 @@ import {
   Target
 } from '@angular-devkit/architect/src';
 import { JsonObject, logging } from '@angular-devkit/core';
-import { BuildTarget } from 'interfaces';
+import { BuildTarget } from '../interfaces';
 
 import deploy from './actions';
 
@@ -22,7 +22,7 @@ describe('Deploy Angular apps', () => {
   beforeEach(() => initMocks());
 
   it('should invoke the builder', async () => {
-    const spy = spyOn(context, 'scheduleTarget').and.callThrough();
+    const spy = jest.spyOn(context, 'scheduleTarget');
     await deploy(mockEngine, context, BUILD_TARGET, {});
 
     expect(spy).toHaveBeenCalledWith(
@@ -36,7 +36,7 @@ describe('Deploy Angular apps', () => {
   });
 
   it('should invoke the builder with the baseHref', async () => {
-    const spy = spyOn(context, 'scheduleTarget').and.callThrough();
+    const spy = jest.spyOn(context, 'scheduleTarget');
     await deploy(mockEngine, context, BUILD_TARGET, { baseHref: '/folder' });
 
     expect(spy).toHaveBeenCalledWith(
@@ -50,10 +50,10 @@ describe('Deploy Angular apps', () => {
   });
 
   it('should invoke engine.run', async () => {
-    const spy = spyOn(mockEngine, 'run').and.callThrough();
+    const spy = jest.spyOn(mockEngine, 'run');
     await deploy(mockEngine, context, BUILD_TARGET, {});
 
-    expect(spy).toHaveBeenCalledWith('dist/some-folder', {}, context.logger);
+    expect(spy).toHaveBeenCalledWith('dist/some-folder/browser', {}, context.logger);
   });
 
   describe('error handling', () => {
@@ -100,7 +100,7 @@ const initMocks = () => {
     },
     currentDirectory: 'cwd',
     id: 1,
-    logger: new logging.NullLogger() as any,
+    logger: new logging.NullLogger(),
     workspaceRoot: 'cwd',
     addTeardown: _ => {},
     validateOptions: _ => Promise.resolve({} as any),

src/deploy/builder.ts

@@ -7,7 +7,7 @@ import {
 import * as engine from '../engine/engine';
 import deploy from './actions';
 import { Schema } from './schema';
-import { BuildTarget } from './interfaces';
+import { BuildTarget } from '../interfaces';
 
 // Call the createBuilder() function to create a builder. This mirrors
 // createJobHandler() but add typings specific to Architect Builders.

src/engine/engine.spec.ts

@@ -1,10 +1,10 @@
-import { NullLogger } from '@angular-devkit/core/src/logger';
+import { logging } from '@angular-devkit/core';
 
 import * as engine from './engine';
 
 describe('engine', () => {
   describe('prepareOptions', () => {
-    const logger = new NullLogger();
+    const logger = new logging.NullLogger();
 
     beforeEach(() => {
       process.env = {};
@@ -83,20 +83,31 @@ describe('engine', () => {
 
       expect(finalOptions.repo).toMatch(/angular-schule\/angular-cli-ghpages/);
     });
+  });
 
-    /*
-    // i was not able to somehow catch an error... :-(
-    it('should should throw an exception, if remote url could not be discovered', async () => {
+  describe('prepareOptions - handling dotfiles, notfound, and nojekyll', () => {
+    const logger = new logging.NullLogger();
 
-      expect.assertions(1);
+    it('should set dotfiles, notfound, and nojekyll to false when no- flags are given', async () => {
+      const options = {
+        noDotfiles: true,
+        noNotfound: true,
+        noNojekyll: true
+      };
+      const finalOptions = await engine.prepareOptions(options, logger);
 
-      const options = { git: 'xxx' };
+      expect(finalOptions.dotfiles).toBe(false);
+      expect(finalOptions.notfound).toBe(false);
+      expect(finalOptions.nojekyll).toBe(false);
+    });
 
-      try {
-        await engine.prepareOptions(options, logger);
-      } catch (e) {
-        expect(e).toBeTruthy();
-      }
-    })*/
+    it('should set dotfiles, notfound, and nojekyll to true when no- flags are not given', async () => {
+      const options = {};
+      const finalOptions = await engine.prepareOptions(options, logger);
+
+      expect(finalOptions.dotfiles).toBe(true);
+      expect(finalOptions.notfound).toBe(true);
+      expect(finalOptions.nojekyll).toBe(true);
+    });
   });
 });

src/interfaces.ts

@@ -12,11 +12,10 @@ export interface WorkspaceProject {
 }
 
 export interface Workspace {
-  defaultProject?: string;
   projects: Record<string, WorkspaceProject>;
 }
 
 export interface BuildTarget {
   name: string;
-  options?: { [name: string]: any };
+  options?: Record<string, any>;
 }

src/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node'
+};