chore: Doc, output and code improvements

.github/workflows/pre_release.yml

@@ -0,0 +1,45 @@
+name: pre-release
+
+on:
+  create
+
+jobs:
+
+  # Make a PR to master from a new branch with changes, and delete the created one
+  update-versions:
+
+    # Only run when a release-v* branch is created, and not by drashbot
+    if: contains(github.ref, 'release-v') && !contains(github.event.sender.login, 'drashbot')
+
+    strategy:
+      matrix:
+        deno: ["1.4.2"]
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: Checkout master
+        uses: actions/checkout@v2
+        with:
+          ref: master
+
+      - name: Delete Remote Release Branch
+        run: git push --delete origin ${{ github.ref }}
+
+      - name: Install Deno
+        uses: denolib/setup-deno@v2
+        with:
+          deno-version: ${{ matrix.deno }}
+
+      - name: Bump Versions
+        run: deno run -A ./console/bump_versions.ts --version=${{ github.ref }} # version passed so we know what the new release version will be
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v2
+        with:
+          token: ${{ secrets.CI_USER_PAT }}
+          commit-message: bump versions
+          title: bump versions
+          body: This was auto-generated by GitHub Actions.
+          branch: release # Can change it to ${{ github.ref }} to be the branch name, but then we need to figure out how to stop this worjflow running  when it creates another "release-vx.x.x" branch

README.md

@@ -65,7 +65,6 @@ $ dmm ...
 
 *Through the URL*
 
-If you are using this method, be sure to use the latest version of dmm in the command below
 ```
 $ deno run --allow-net='cdn.deno.land,api.deno.land' --allow-read='.' --allow-write='deps.ts' https://deno.land/x/dmm@v1.1.5/mod.ts ...
 ```
@@ -151,40 +150,54 @@ export { fs, colors }
 Should you need any more information, use the `--help` option:
 
 ```
-$ dmm --help
+A module manager for Deno.
 
-A module manager for Deno.    
+USAGE
 
-USAGE:
-    deno run --allow-read --allow-net [--allow-write] https://deno.land/x/dmm@v1.1.5/mod.ts [ARGS] [MODULES]
+    deno install --allow-net='cdn.deno.land,api.deno.land' --allow-read='.' --allow-write='deps.ts' https://deno.land/x/dmm@v1.1.5/mod.ts
+    dmm [command]
 
-    dmm [ARGS] [MODULES]
 
-ARGUMENTS:
-The check and update arguments cannot be used together.
+COMMANDS
 
-    check
-        Checks the specified modules for newer version. Will check all if modules are omitted.
+    check [modules]
+        Checks the specified modules for newer version. Will check all if modules are 
+        omitted.
 
-    update
-        Updates the specified modules to the newest version. Will update all if modules are omitted.
+    update [modules]
+        Updates the specified modules to the newest version. Will update all if modules 
+        are omitted.
 
-     info
-        Shows information about the given module, be it std or 3rd party. The 3rd party module must be referenced at https://deno.land/x/
+    info
+        Shows information about the given module, be it std or 3rd party. The 3rd party 
+        module must be referenced at https://deno.land/x/
 
-OPTIONS:
     --help
-        Prints help message
+        Prints the help message
+
     --version
-        Prints dmm version
+        Prints the current dmm version
+
+    help
+        Prints the help message
+
+    version
+        Prints the current dmm version
+
+
+EXAMPLE USAGE
+
+    Install dmm
+        deno install --allow-net='cdn.deno.land,api.deno.land' --allow-read='.' --allow-write='deps.ts' https://deno.land/x/dmm@v1.1.5/mod.ts
+
+    Check a single module
+        dmm check fs
 
-EXAMPLE USAGE:
-    Assume you are importing an out of date version of `fs` from `std`. See [here](#quick-start) for adding further restrictions.
-    deno run --allow-net --allow-read https://deno.land/x/dmm@v1.1.5/mod.ts check fs
-    deno run --allow-net --allow-read --allow-write https://deno.land/x/dmm@v1.1.5/mod.ts update fs
-    deno run --allow-net https://deno.land/x/dmm@v1.1.5/mod.ts info http
-    dmm info http
+    Update a single module
+        dmm update fs
 
+    Get information about a module
+        dmm info http
 ```
 
 # How it Works

console/bump_versions.ts

@@ -0,0 +1,22 @@
+import { bumpVersions } from "https://raw.githubusercontent.com/drashland/services/master/console/bump_versions.ts";
+
+const branch: string = Deno.args[0].split("=")[1]; // ["--version", "release-vX.X.X"]
+const version = branch.substring(branch.indexOf("v") + 1); // 1.0.5
+
+bumpVersions([
+  {
+    filename: "./egg.json",
+    replaceTheRegex: /"version": "[0-9\.]+[0-9\.]+[0-9\.]"/,
+    replaceWith: `"version": "${version}"`,
+  },
+  {
+    filename: "./README.md",
+    replaceTheRegex: /dmm@v[0-9\.]+[0-9\.]+[0-9\.]/g,
+    replaceWith: `dmm@v${version}`,
+  },
+  {
+    filename: "./src/commands/version.ts",
+    replaceTheRegex: /version = "[0-9\.]+[0-9\.]+[0-9\.]"/,
+    replaceWith: `version = "${version}"`,
+  },
+]);

deps.ts

@@ -1,4 +1,10 @@
 import * as colours from "https://deno.land/std@0.74.0/fmt/colors.ts";
 export { colours };
-
+export { createHelpMenu } from "https://raw.githubusercontent.com/drashland/services/master/cli/help_menu_service.ts";
+export { CommandService } from "https://raw.githubusercontent.com/drashland/services/master/cli/command_service.ts";
+export {
+  logDebug,
+  logError,
+  logInfo,
+} from "https://raw.githubusercontent.com/drashland/services/master/cli/logger_service.ts";
 export { assertEquals } from "https://deno.land/std@0.74.0/testing/asserts.ts";

mod.ts

@@ -1,56 +1,42 @@
-import { colours } from "./deps.ts";
-import { helpMessage } from "./src/options/help.ts";
-import { versionMessage } from "./src/options/version.ts";
+import { colours, CommandService, logError } from "./deps.ts";
+import { helpMessage } from "./src/commands/help.ts";
+import { versionMessage } from "./src/commands/version.ts";
 import { info } from "./src/commands/info.ts";
 import { check } from "./src/commands/check.ts";
 import { update } from "./src/commands/update.ts";
 
-async function run(
-  purpose: string,
-  modulesForPurpose: string[],
-): Promise<void> {
-  if (purpose === "check") {
-    await check(modulesForPurpose);
-  } else if (purpose === "info") {
-    await info(modulesForPurpose);
-  } else if (purpose === "update") {
-    await update(modulesForPurpose);
-  } else {
-    console.error(
-      colours.red("Specify either `check`, `info` or `update`. See --help"),
-    );
-    Deno.exit(1);
-  }
-}
-
-// Gather args
-const args: string[] = Deno.args;
-if (!args.length) {
-  console.error(colours.red("Invalid arguments. See --help"));
-  Deno.exit(1);
-}
-
-// Support --help usage
-const wantsHelp: boolean = args.filter((arg) => arg === "--help").length === 1;
-if (wantsHelp) {
-  console.info(helpMessage);
-  Deno.exit();
-}
-
-// Support --version usage
-const wantsVersion: boolean =
-  args.filter((arg) => arg === "--version").length === 1;
-if (wantsVersion) {
-  console.info(versionMessage);
-  Deno.exit();
-}
-
-// Gather facts
-console.info("Gathering facts...");
-const purposeAndModules: string[] = args.filter((arg) =>
-  arg.indexOf("--") === -1
-);
-const purpose: string = purposeAndModules[0];
-const modulesForPurpose: string[] = purposeAndModules.slice(1);
-
-await run(purpose, modulesForPurpose);
+const args = Deno.args.slice().filter((arg: string, i: number) => {
+  return i !== 0;
+});
+
+const c = new CommandService(Deno.args);
+
+c.addCommand("--help", async () => {
+  console.log(helpMessage);
+});
+
+c.addCommand("--version", () => {
+  console.log(versionMessage);
+});
+
+c.addCommand("info", async () => {
+  await info(args);
+});
+
+c.addCommand("help", () => {
+  console.log(helpMessage);
+});
+
+c.addCommand("update", async () => {
+  await update(args);
+});
+
+c.addCommand("version", () => {
+  console.log(versionMessage);
+});
+
+c.addCommand("check", async () => {
+  await check(args);
+});
+
+c.executeCommand();

src/commands/help.ts

@@ -0,0 +1,46 @@
+import { createHelpMenu } from "../../deps.ts";
+import { version } from "./version.ts";
+
+export const helpMessage = createHelpMenu({
+  description: `A module manager for Deno.`,
+  usage: [
+    `deno install --allow-net='cdn.deno.land,api.deno.land' --allow-read='.' --allow-write='deps.ts' https://deno.land/x/dmm@v${version}/mod.ts`,
+    `dmm [command]`,
+  ],
+  commands: {
+    "check [modules]":
+      "Checks the specified modules for newer version. Will check all if modules are omitted.",
+    "update [modules]":
+      "Updates the specified modules to the newest version. Will update all if modules are omitted.",
+    "info":
+      "Shows information about the given module, be it std or 3rd party. The 3rd party module must be referenced at https://deno.land/x/",
+    "help, --help": "Prints the help message",
+    "version, --version": "Prints the current dmm version",
+  },
+  example_usage: [
+    {
+      description: "Install dmm",
+      examples: [
+        `deno install --allow-net='cdn.deno.land,api.deno.land' --allow-read='.' --allow-write='deps.ts' https://deno.land/x/dmm@v${version}/mod.ts`,
+      ],
+    },
+    {
+      description: "Check a single module",
+      examples: [
+        `dmm check fs`,
+      ],
+    },
+    {
+      description: "Update a single module",
+      examples: [
+        `dmm update fs`,
+      ],
+    },
+    {
+      description: "Get information about a module",
+      examples: [
+        "dmm info http",
+      ],
+    },
+  ],
+});