feat(*): Rewrite install logic, add checksum and health checks, add additional params (#28)

- Rewrite install logic
- Add checksum and health checks
- Add support for more OS and architecture variants
- Add support for all Hugo version
- Add additional CLI params

Author: dominique-mueller

.github/workflows/ci.yml

@@ -37,3 +37,28 @@ jobs:
         run: npm ci
       - name: Lint
         run: npm run lint
+
+  test:
+    name: Test
+    needs: build
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-20.04
+          - os: windows-2019
+          - os: macos-10.15
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Setup NodeJS
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14.15.x
+      - name: Install dependencies
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Test
+        run: npm run test

.gitignore

@@ -1,3 +1,5 @@
+test-output
+
 # Created by https://www.toptal.com/developers/gitignore/api/node,vscode
 # Edit at https://www.toptal.com/developers/gitignore?templates=node,vscode
 

bin/hugo-installer.ts

@@ -1,58 +1,88 @@
 #!/usr/bin/env node
 
-import * as objectPath from 'object-path';
+import objectPath from 'object-path';
+import * as os from 'os';
 import * as path from 'path';
 import * as yargs from 'yargs';
 
 import { installHugo } from '../index';
 
 // Read CLI parameters
-const argv: { [param: string]: any } = yargs
+const argv = yargs
   .version(false) // Disable default version flag (we're using our own in the next line)
-  .option('version', {
-    describe: 'Hugo version to install, or path to package.json value with the version',
-    type: 'string',
-    required: true,
+  .option('arch', {
+    choices: ['arm', 'arm64', 'x64', 'x86'],
+    default: os.arch(),
+    describe: 'System architecture that the binary should run on. It is recommended to use auto-detect by not using this option.',
   })
   .option('destination', {
-    describe: 'Destination to download the Hugo binary into',
-    type: 'string',
     default: 'bin/hugo',
+    describe: 'Destination to download the Hugo binary into.',
+    type: 'string',
+  })
+  .option('downloadUrl', {
+    default: 'https://github.com/gohugoio/hugo/releases/download/',
+    describe:
+      'Source base URL from where the Hugo binary will be fetched. By default, GitHub will be used. When using a custom URL, make sure to replicate GitHub release asset URLs and append a trailing slash to the custom URL.',
+    type: 'string',
   })
   .option('extended', {
-    describe: 'Download Hugo extended',
+    default: false,
+    describe: 'Download Hugo extended version.',
+    type: 'boolean',
+  })
+  .option('os', {
+    choices: ['darwin', 'freebsd', 'linux', 'openbsd', 'win32'],
+    default: os.platform(),
+    describe: 'Operating system that the binary should run on. It is recommended to use auto-detect by not using this option.',
+  })
+  .option('skipChecksumCheck', {
+    default: false,
+    describe: 'Skip checksum checks for downloaded binaries. It is recommended to leave this option enabled.',
     type: 'boolean',
+  })
+  .option('skipHealthCheck', {
     default: false,
+    describe: 'Skip health checks for downloaded binaries. It is recommended to leave this option enabled.',
+    type: 'boolean',
+  })
+  .option('version', {
+    describe:
+      'Hugo version to install, or path to package.json value with the version. Make sure to use the exact version number defined in Hugo releases.',
+    type: 'string',
+    required: true,
   })
   .strict().argv;
 
 // If the version does not have the format of a version number, assume it's an object path
 if (isNaN(parseFloat(argv.version))) {
-  // Note: No is no other way in NodeJS to dynamically resolve and import the project's package.json file
+  // Note: There is no other way in NodeJS to dynamically resolve and import the project's package.json file
   // eslint-disable-next-line @typescript-eslint/no-var-requires
   const packageJson: any = require(path.resolve(process.cwd(), 'package.json'));
   const packageJsonHugoVersion: string | null = objectPath.get(packageJson, argv.version, null);
   if (!packageJsonHugoVersion) {
-    console.error(`Cannot find a hugo version in the package.json file at "${argv.version}"`);
+    console.error(`The version "${argv.version}" is either invalid or not part of the "package.json" file.`);
     process.exit(1);
   }
   argv.version = packageJsonHugoVersion;
 }
 
 // Run
-const versionString = `${argv.version}${argv.extended ? '_extended' : ''}`;
-console.log(`Download hugo binary (version "${versionString}") into "${argv.destination}" ...`);
-installHugo(argv.version, argv.destination)
+installHugo({
+  arch: argv.arch,
+  downloadUrl: argv.downloadUrl,
+  destination: argv.destination,
+  extended: argv.extended,
+  os: argv.os,
+  skipChecksumCheck: argv.skipChecksumCheck,
+  skipHealthCheck: argv.skipHealthCheck,
+  version: argv.version,
+})
   .then(() => {
     console.log('Success!');
     process.exit();
   })
   .catch((error: any) => {
-    console.error('Error!');
-    if (error.toString().indexOf('404') !== -1) {
-      console.error(`  -> It seems like the hugo version "${versionString}" does not exist.`);
-    }
-    console.log('');
-    console.dir(error);
+    console.log(error);
     process.exit(1);
   });