diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index d945abc..0000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,59 +0,0 @@ ---- -version: 2 -jobs: - node-latest: &test - docker: - - image: node:latest - working_directory: ~/cli - steps: - - checkout - - restore_cache: &restore_cache - keys: - - v1-npm-{{checksum ".circleci/config.yml"}}-{{checksum "yarn.lock"}} - - v1-npm-{{checksum ".circleci/config.yml"}} - - run: - name: Install dependencies - command: yarn - - run: - name: Testing - command: yarn test - - run: - name: Submitting code coverage to codecov - command: | - ./node_modules/.bin/nyc report --reporter text-lcov > coverage.lcov - curl -s https://codecov.io/bash | bash - node-8: - <<: *test - docker: - - image: node:8 - node-10: - <<: *test - docker: - - image: node:10 - cache: - <<: *test - steps: - - checkout - - run: - name: Install dependencies - command: yarn - - save_cache: - key: v1-npm-{{checksum ".circleci/config.yml"}}-{{checksum "yarn.lock"}} - paths: - - ~/cli/node_modules - - /usr/local/share/.cache/yarn - - /usr/local/share/.config/yarn - -workflows: - version: 2 - "hutte": - jobs: - - node-latest - - node-8 - - node-10 - - cache: - filters: - tags: - only: /^v.*/ - branches: - ignore: /.*/ diff --git a/README.md b/README.md index 6f4d9df..fb6cd79 100644 --- a/README.md +++ b/README.md @@ -4,31 +4,17 @@ hutte CLI for [hutte.io](https://hutte.io) [![Version](https://img.shields.io/npm/v/hutte.svg)](https://npmjs.org/package/hutte) -[![CircleCI](https://circleci.com/gh/hutte-io/cli/tree/master.svg?style=shield)](https://circleci.com/gh/hutte-io/cli/tree/master) -[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/hutte-io/cli?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/cli/branch/master) -[![Codecov](https://codecov.io/gh/hutte-io/cli/branch/master/graph/badge.svg)](https://codecov.io/gh/hutte-io/cli) -[![Greenkeeper](https://badges.greenkeeper.io/hutte-io/cli.svg)](https://greenkeeper.io/) -[![Known Vulnerabilities](https://snyk.io/test/github/hutte-io/cli/badge.svg)](https://snyk.io/test/github/hutte-io/cli) [![Downloads/week](https://img.shields.io/npm/dw/hutte.svg)](https://npmjs.org/package/hutte) [![License](https://img.shields.io/npm/l/hutte.svg)](https://github.com/hutte-io/cli/blob/master/package.json) - -* [Debugging your plugin](#debugging-your-plugin) - - - +## Installation + ```sh-session -$ npm install -g hutte -$ sfdx COMMAND -running command... -$ sfdx (-v|--version|version) -hutte/0.0.47 darwin-x64 node-v12.21.0 -$ sfdx --help [COMMAND] -USAGE - $ sfdx COMMAND -... +$ sfdx plugins:install hutte ``` - + +## Commands + * [`sfdx hutte:auth:login [-e ] [-p ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hutteauthlogin--e-string--p-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) * [`sfdx hutte:org:authorize [--no-git] [--no-pull] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-hutteorgauthorize---no-git---no-pull---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) @@ -62,7 +48,7 @@ EXAMPLE My hub org id is: 00Dxx000000001234 ``` -_See code: [lib/commands/hutte/auth/login.js](https://github.com/hutte-io/cli/blob/v0.0.47/lib/commands/hutte/auth/login.js)_ +_See code: [lib/commands/hutte/auth/login.js](https://github.com/hutte-io/cli/blob/master/src/commands/hutte/auth/login.ts)_ ## `sfdx hutte:org:authorize [--no-git] [--no-pull] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -86,7 +72,7 @@ OPTIONS the scratch org ``` -_See code: [lib/commands/hutte/org/authorize.js](https://github.com/hutte-io/cli/blob/v0.0.47/lib/commands/hutte/org/authorize.js)_ +_See code: [lib/commands/hutte/org/authorize.js](https://github.com/hutte-io/cli/blob/master/src/commands/hutte/org/authorize.ts)_ ## `sfdx hutte:org:terminate [-t ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -108,7 +94,7 @@ OPTIONS this command invocation ``` -_See code: [lib/commands/hutte/org/terminate.js](https://github.com/hutte-io/cli/blob/v0.0.47/lib/commands/hutte/org/terminate.js)_ +_See code: [lib/commands/hutte/org/terminate.js](https://github.com/hutte-io/cli/blob/master/src/commands/hutte/org/terminate.ts)_ ## `sfdx hutte:pool:take [-t ] [-n ] [-p ] [--timeout ] [-w] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -140,7 +126,7 @@ OPTIONS --timeout=timeout the timeout period in seconds. ``` -_See code: [lib/commands/hutte/pool/take.js](https://github.com/hutte-io/cli/blob/v0.0.47/lib/commands/hutte/pool/take.js)_ +_See code: [lib/commands/hutte/pool/take.js](https://github.com/hutte-io/cli/blob/master/src/commands/hutte/pool/take.ts)_ # Debugging your plugin diff --git a/appveyor.yml b/appveyor.yml deleted file mode 100644 index 7fc71e7..0000000 --- a/appveyor.yml +++ /dev/null @@ -1,22 +0,0 @@ -environment: - nodejs_version: "10" -cache: - - '%LOCALAPPDATA%\Yarn -> appveyor.yml' - - node_modules -> yarn.lock - -install: - - ps: Install-Product node $env:nodejs_version x64 - - yarn -test_script: - - yarn test - -after_test: - - .\node_modules\.bin\nyc report --reporter text-lcov > coverage.lcov - - ps: | - $env:PATH = 'C:\msys64\usr\bin;' + $env:PATH - Invoke-WebRequest -Uri 'https://codecov.io/bash' -OutFile codecov.sh - bash codecov.sh - - -build: off - diff --git a/package.json b/package.json index 35441e1..6815d0e 100644 --- a/package.json +++ b/package.json @@ -58,9 +58,10 @@ "oclif": { "commands": "./lib/commands", "bin": "sfdx", + "repositoryPrefix": "<%- repo %>/blob/master/<%- commandPath.replace('lib', 'src').replace('.js', '.ts') %>", "topics": { - "hello": { - "description": "Commands to say hello." + "hutte": { + "description": "manage scratch orgs using Hutte" } }, "devPlugins": [