.circleci/config.yml

@@ -7,7 +7,7 @@ version: 2
 defaults: &defaults
   working_directory: ~/repo
   docker:
-    - image: circleci/node:8.9.1
+    - image: circleci/node:10.16.2
 
 jobs:
   test:

.gitignore

@@ -1,3 +1,145 @@
-.nyc_output
+# File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
+
+# Created by https://www.gitignore.io/api/visualstudiocode,node,macos
+# Edit at https://www.gitignore.io/?templates=visualstudiocode,node,macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
 coverage
-/node_modules
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# react / gatsby
+public/
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+
+# End of https://www.gitignore.io/api/visualstudiocode,node,macos
+
+# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
+
+.topcoderrc
+
+# package-lock.json vary while installing on different operating system
+package-lock.json

README.md

@@ -1,74 +1,19 @@
-topcoder-cli
+# Topcoder CLI
 ===
 
-# Dependencies
-- nodejs https://nodejs.org/en/ (v10)
-- npm https://www.npmjs.com/ (v6)
+#### Build Status:
+[![CircleCI](https://circleci.com/gh/topcoder-platform/topcoder-cli/tree/master.svg?style=svg)](https://circleci.com/gh/topcoder-platform/topcoder-cli/tree/master) ![npm (tag)](https://img.shields.io/npm/v/@topcoder/topcoder-cli/latest.svg?style=plastic) ![GitHub issues](https://img.shields.io/github/issues/topcoder-platform/topcoder-cli.svg?style=plastic)
 
-# Configuration
-Configuration for the application is at `config/default.js`.
-The following parameters can be set in config files or in env variables:
+## Installation
 
-| Property               | Environment varible     | Default value                              | Description                            |
-| ---                    | ---                     | ---                                        | ---                                    |
-| LOG_LEVEL              | LOG_LEVEL               | info                                       | control log level                      |
-| SUBMISSION_API_URL     | TEST_SUBMISSION_API_URL | https://api.topcoder.com/v5/submissions    | the TC submission API URL              |
-| TC_AUTHN_URL           | TC_AUTHN_URL            | https://topcoder.auth0.com/oauth/ro        | API that is used to fetch JWT token v2 |
-| TC_AUTHZ_URL           | TC_AUTHZ_URL            | https://api.topcoder.com/v3/authorizations | API that is used to fetch JWT token v3 |
-| TC_CLIENT_ID           | TC_CLIENT_ID            | 6ZwZEUo2ZK4c50aLPpgupeg5v2Ffxp9P           | TC client ID                           |
-| TC_CLIENT_V2CONNECTION | CLIENT_V2CONNECTION     | TC-User-Database                           | TC client connection protocol          |
-
-# Publish the package to npm
-- Create a npm account on https://www.npmjs.com/signup if you don't have one.
-- Use the account to sign in via cli: `npm login`
-- In the root directory of the project, run `npm publish --access=public` to publish the package to npm registry.
-
-## Notes
-- In rare cases the module name would have been used by others. You may need to change the value of the `name` field in `package.json`
-  to a unique one.
-- When you make changes to your code and want to update the package you'll need to update the version of the package.
-  After that, run `npm publish` again to republish the package.
-- If you want to remove the package from npm registry anyway, run `npm unpublish --force` under the root directory of the project.
-
-# Installation
-
-- After you published the package to npm registry you can then install the package via npm-cli:
+- Install the package via npm cli
 
 ``` node
-npm install -g <your package name here>
-```
-
-# Usage
-
-First, install the package, and then run `tc-submission-cli` command on the root directory of your project with `.topcoderrc` file.
-It'll then automatically zip all files under the root directory recursively(except the .topcoderrc file itself) and finally upload the zip file to the TC challenge as a submission.
-
-An example `.topcoderrc` file should conform to at least the following structure.
-
-``` jsonr
-{
-  "challengeIds": [
-    "30095545" // at least one item here
-  ],
-  "username": "TonyJ",
-  "password": "appirio123"
-}
+npm i -g @topcoder/topcoder-cli
 ```
 
-# test
+## Usage
 
-## Prepare
-- Install dependencies `npm install`
+* To understand the commands supported by Topcoder CLI, after installing the package run `topcoder --help` which would list out all supported commands. 
 
-## Unit test
-To run unit tests alone
-
-```bash
-npm run test
-```
-
-To run unit tests with coverage report
-
-```bash
-npm run test:cov
-```
+* If you need to understand the options available with each command, run `topcoder [ command ] --help`. E.g. Executing the command `topcoder submit --help` will display the help content related to making topcoder submission using CLI