Merge pull request #449 from alexa/v2.29.0

V2.29.0

.commitlintrc.json

@@ -4,28 +4,10 @@
     "footer-leading-blank": [1, "always"],
     "subject-empty": [2, "never"],
     "subject-full-stop": [2, "never", "."],
-    "subject-case": [
-      2,
-      "never",
-      ["sentence-case", "pascal-case", "start-case", "upper-case"]
-    ],
+    "subject-case": [2, "never", ["sentence-case", "pascal-case", "start-case", "upper-case"]],
     "scope-case": [2, "always", "lower-case"],
     "type-case": [2, "always", "lower-case"],
     "type-empty": [2, "never"],
-    "type-enum": [
-      2,
-      "always",
-      [
-        "chore",
-        "docs",
-        "feat",
-        "fix",
-        "perf",
-        "refactor",
-        "revert",
-        "style",
-        "test"
-      ]
-    ]
+    "type-enum": [2, "always", ["chore", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test"]]
   }
 }

.github/workflows/functional-test-clean-up.yml

@@ -15,7 +15,7 @@ jobs:
     - name: Use Node.js
       uses: actions/setup-node@v1
       with:
-        node-version: '12.x'
+        node-version: '16.x'
     - run: npm install
     - run: npm run functional-test:clean-up --unhandled-rejections=strict
       env:

.github/workflows/functional-test.yml

@@ -8,15 +8,14 @@ on:
 jobs:
   build:
     if: "!contains(github.event.head_commit.message, 'chore(release):')"
-
-    runs-on: ubuntu-latest
 
+    runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js
       uses: actions/setup-node@v1
       with:
-        node-version: '12.x'
+        node-version: '16.x'
     - run: git config --global user.email "[email protected]"
     - run: git config --global user.name "Ask Cli Test"
     - run: npm install

.github/workflows/integration-test.yml

@@ -2,7 +2,7 @@ name: Integration Test
 
 on:
   push:
-    branches:    
+    branches:
       - master
       - develop
     paths-ignore:
@@ -18,8 +18,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        node: [12, 14, 16]
-
+        node: [16]
     steps:
     - uses: actions/checkout@v3
     - name: Use Node.js ${{ matrix.node }}

.github/workflows/release.yml

@@ -0,0 +1,21 @@
+name: "Publish the ask-cli package to the npmjs registry"
+
+# this action will only run when a new GitHub release is published.
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm test
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.ASK_TOOLS_NPM_TOKEN }}

.github/workflows/unit-test.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        node: [12, 14, 16]
+        node: [14, 16]
 
     steps:
     - uses: actions/checkout@v3
@@ -27,5 +27,4 @@ jobs:
       with:
         node-version: ${{ matrix.node }}
     - run: npm install
-    - run: npm run lint
     - run: npm run test:report

.gitignore

@@ -1,6 +1,8 @@
 # Dependency directories
 node_modules/
-package-lock.json
+build
+dist/
+package/
 
 # Logs
 logs
@@ -23,3 +25,5 @@ test/temp
 
 .vagrant
 
+# distribution files
+*.tgz

.npmignore

@@ -9,3 +9,13 @@ docs
 jsconfig.json
 scripts
 test
+package-lock.json
+build
+*.tgz
+lib
+bin
+!dist/**
+dist/test
+.husky
+.prettierrc
+.prettierignore

.prettierignore

@@ -0,0 +1,7 @@
+.github
+dist
+build
+node_modules
+docs
+scripts
+*.md

.prettierrc

@@ -0,0 +1,12 @@
+{
+  "arrowParens": "always",
+  "bracketSpacing": false,
+  "embeddedLanguageFormatting": "auto",
+  "printWidth": 140,
+  "proseWrap": "never",
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "useTabs": false
+}

.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "printWidth": 140,
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "useTabs": false
+}

CONTRIBUTING.md

@@ -9,13 +9,14 @@ Below are typical steps to follow if you want to contribute:
 git clone [email protected]:<your-account>/ask-cli.git
 ```
 3. Run `npm install` at the root of the repo
-4. Run `npm test` to verify that the tests are passing
-5. Make your code change(s)
-3. Run `npm test` to verify that the tests are still passing. If you added a new functionality, add tests to ensure that we have adequate test coverage.
+4. Run `npm run build` to compile the Typescript part of the source code and tests
+5. Run `npm test` to verify that the tests are passing
+6. Make your code change(s)
+7. Run `npm test` to verify that the tests are still passing. If you added a new functionality, add tests to ensure that we have adequate test coverage.
 You can check test coverage by running `npm run test:report` 
-4. Commit your work. Your commit message should follow [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/). We have a pre commit hook to validate the commit message.
-5. Send us a pull request, answering any default questions in the pull request interface. The pull request should be going to `develop` branch.
-6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+8. Commit your work. Your commit message should follow [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/). We have a pre commit hook to validate the commit message.
+9. Send us a pull request, answering any default questions in the pull request interface. The pull request should be going to `develop` branch.
+10. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
 
 
 ## Branch Organization

bin/ask-skill.ts

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+
+import {commander, SKILL_COMMAND_MAP} from "../lib/commands/skill/skill-commander";
+
+commander.parse(process.argv);
+
+if (!process.argv.slice(2).length) {
+  commander.outputHelp();
+} else if (SKILL_COMMAND_MAP[process.argv[2]] === undefined) {
+  console.error('Command not recognized. Please run "ask skill" to check the user instructions.');
+  process.exit(1);
+}

bin/ask-smapi.ts

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+import Messenger from "../lib/view/messenger";
+import jsonView from "../lib/view/json-view";
+import {makeSmapiCommander} from "../lib/commands/smapi/smapi-commander";
+
+const commander = makeSmapiCommander();
+
+if (!process.argv.slice(2).length) {
+  commander.outputHelp();
+} else {
+  commander
+    .parseAsync(process.argv)
+    .then((result) => Messenger.getInstance().info(result))
+    .catch((err) => {
+      Messenger.getInstance().error(jsonView.toString(err));
+      process.exit(1);
+    });
+}

bin/ask-util.ts

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import {commander, UTIL_COMMAND_MAP} from "../lib/commands/util/util-commander";
+
+commander.parse(process.argv);
+
+if (!process.argv.slice(2).length) {
+  commander.outputHelp();
+} else if (UTIL_COMMAND_MAP[process.argv[2]] === undefined) {
+  console.error('Command not recognized. Please run "ask util" to check the user instructions.');
+  process.exit(1);
+}