#10: Migrate to oclif

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.eslintignore

@@ -0,0 +1 @@
+/dist

.eslintrc

@@ -0,0 +1,10 @@
+{
+  "extends": [
+    "oclif",
+    "oclif-typescript"
+  ],
+    "rules": {
+      "semi": ["error", "always"],
+      "object-curly-spacing": ["error", "always"]
+    }
+}

.gitignore

@@ -8,4 +8,14 @@ node_modules/
 .DS_Store
 
 # Log files
-*.log
+*.log
+
+*-debug.log
+*-error.log
+/.idea
+/.nyc_output
+/dist
+/lib
+/package-lock.json
+/tmp
+oclif.manifest.json

.mocharc.json

@@ -0,0 +1,12 @@
+{
+  "require": [
+    "test/helpers/init.js",
+    "ts-node/register"
+  ],
+  "watch-extensions": [
+    "ts"
+  ],
+  "recursive": true,
+  "reporter": "spec",
+  "timeout": 60000
+}

README.md

@@ -1,36 +1,76 @@
 [![npm version](https://badge.fury.io/js/@chuva.io%2Fless-cli.svg)](https://badge.fury.io/js/@chuva.io%2Fless-cli)
 
+
 `less-cli` is a CLI tool that allows you to deploy your Less projects to AWS while providing several other tools to facilitate your interaction with Less.
 
 - [Learn about Less](https://chuva-io.notion.site/Less-44d98337e08a46af934364700da05e3a)
 - [Less developer documentation](https://chuva-io.notion.site/Developer-documentation-ddbab90913494721b58eca81b3fb7552)
 
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @chuva.io/less-cli
+$ less-cli COMMAND
+running command...
+$ less-cli (--version)
+@chuva.io/less-cli/1.0.0-beta.5 darwin-x64 node-v16.20.0
+$ less-cli --help [COMMAND]
+USAGE
+  $ less-cli COMMAND
+...
+```
+<!-- usagestop -->
+*Note: Before deploying your project make sure to `export` your `LESS_TOKEN`.*
+
+```bash
+$ export LESS_TOKEN=your-less-token
+```
+
 # Commands
+<!-- commands -->
+* [`less-cli deploy PROJECTNAME`](#less-cli-deploy-projectname)
+* [`less-cli help [COMMANDS]`](#less-cli-help-commands)
 
-## `deploy`
+## `less-cli deploy PROJECTNAME`
 
-The `deploy` command allows you to deploy your Less project to AWS.
+Deploy your less project
 
-*Note: Before deploying your project make sure to `export` your `LESS_TOKEN`.*
+```
+USAGE
+  $ less-cli deploy PROJECTNAME
 
-```bash
-$ export LESS_TOKEN=your-less-token
-$ less-cli deploy <projectName>
+ARGUMENTS
+  PROJECTNAME  Name of your project
+
+DESCRIPTION
+  Deploy your less project
+
+EXAMPLES
+  $ less-cli deploy my-awesome-api
 ```
 
-### Parameters
+_See code: [dist/commands/deploy/index.ts](https://github.com/chuva-io/less-cli/blob/v1.0.0-beta.5/dist/commands/deploy/index.ts)_
 
-`<projectName>`  
-The name of your Less project.  
+## `less-cli help [COMMANDS]`
 
-*Note: Supports alphanumeric characters and "-".*
+Display help for less-cli.
 
-```bash
-$ export LESS_TOKEN=your-less-token
-$ less-cli deploy invoice-microservice
 ```
+USAGE
+  $ less-cli help [COMMANDS] [-n]
 
----
+ARGUMENTS
+  COMMANDS  Command to show help for.
 
-Do more with Less.  
-🇨🇻
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for less-cli.
+```
+<!-- commandsstop -->
+Do more with Less.

bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package.json

@@ -3,14 +3,74 @@
   "version": "1.0.0-beta.4",
   "description": "`less-cli` is a CLI tool that allows you to deploy your Less projects to AWS while providing several other tools to facilitate your interaction with Less.",
   "author": "Chuva, LLC",
-  "license": "Apache-2.0",
+  "bin": {
+    "less-cli": "./bin/run"
+  },
   "url": "https://github.com/chuva-io/less-cli.git",
   "homepage": "https://bit.ly/less-framework",
-  "type": "module",
-  "exports": "./bin/index.js",
-  "bin": {
-    "less-cli": "bin/index.js"
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "repository": "chuva-io/less-cli",
+  "files": [
+    "/bin",
+    "/dist",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@oclif/core": "^2",
+    "@oclif/plugin-help": "^5",
+    "@oclif/plugin-plugins": "^3.5.0",
+    "adm-zip": "^0.5.10",
+    "axios": "^1.4.0",
+    "chalk": "4.1.0",
+    "glob": "^10.3.4",
+    "js-yaml": "^4.1.0",
+    "ora": "^5.0.0",
+    "ws": "^8.13.0"
+  },
+  "devDependencies": {
+    "@oclif/test": "^2.5.3",
+    "@types/chai": "^4",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^16.18.50",
+    "chai": "^4",
+    "eslint": "^7.32.0",
+    "eslint-config-airbnb": "19.0.4",
+    "eslint-config-oclif": "^4",
+    "eslint-config-oclif-typescript": "^1.0.3",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "mocha": "^9",
+    "oclif": "^3.15.0",
+    "shx": "^0.3.3",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.6.2",
+    "typescript": "^4.9.5"
   },
+  "oclif": {
+    "bin": "less-cli",
+    "dirname": "less-cli",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help"
+    ],
+    "topicSeparator": " "
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "dev":"yarn build && node ./bin/run",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "yarn lint",
+    "prepack": "yarn build && oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "bugs": "https://github.com/chuva-io/less-cli/issues",
   "keywords": [
     "distributed",
     "infinite scale",
@@ -36,22 +96,5 @@
     "less",
     "less-cli"
   ],
-  "dependencies": {
-    "adm-zip": "^0.5.10",
-    "axios": "^1.4.0",
-    "chalk": "^5.3.0",
-    "commander": "^11.0.0",
-    "glob": "^10.3.4",
-    "js-yaml": "^4.1.0",
-    "ora": "^7.0.1",
-    "ws": "^8.13.0"
-  },
-  "main": "bin/index.js",
-  "devDependencies": {},
-  "bugs": {
-    "url": "https://bitbucket.org/chuva-io/less-cli-client/issues"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  }
+  "types": "dist/index.d.ts"
 }

src/commands/deploy/index.ts

@@ -0,0 +1,34 @@
+import { Args, Command } from '@oclif/core';
+import chalk from 'chalk';
+import deploy from '../../helpers/deploy';
+
+export default class Deploy extends Command {
+  static description = 'Deploy your less project'
+
+  static examples = [
+    '$ less-cli deploy my-awesome-api',
+  ]
+
+  static flags = {}
+
+  static args = {
+    projectName: Args.string({ description: 'Name of your project', required: true }),
+  }
+
+  async run(): Promise<void> {
+    const { args } = await this.parse(Deploy);
+    const projectName = args.projectName;
+
+    if (!/^[A-Za-z][\dA-Za-z-]*$/.test(projectName)) {
+      console.log(chalk.redBright('Error:'), 'The projectName must satisfy regular expression pattern: [a-zA-Z][-a-zA-Z0-9]');
+      this.exit(1);
+    }
+
+    if (!process.env.LESS_TOKEN) {
+      console.log(chalk.redBright('Error:'), 'Environment variable LESS_TOKEN must be defined');
+      this.exit(1);
+    }
+
+    await deploy(projectName);
+  }
+}