Skip to content
This repository has been archived by the owner on Mar 13, 2021. It is now read-only.

Commit

Permalink
Merge branch 'master' into fixup-cli-command
Browse files Browse the repository at this point in the history
  • Loading branch information
rkrauskopf committed Aug 25, 2020
2 parents e8718cb + 6fc8b83 commit 5656a73
Show file tree
Hide file tree
Showing 80 changed files with 4,882 additions and 3,153 deletions.
2 changes: 0 additions & 2 deletions .eslintignore

This file was deleted.

27 changes: 0 additions & 27 deletions .eslintrc.js

This file was deleted.

79 changes: 79 additions & 0 deletions .eslintrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# ESLint config
# http://eslint.org/docs/user-guide/configuring
# https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/README.md
# https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TYPED_LINTING.md

root: true

env:
es6: true
node: true

overrides:
# Linter settings for JavaScript
- files: ["**/*.js"]
parserOptions:
ecmaVersion: 2020
extends:
- oclif
- eslint:recommended
- prettier
rules:
one-var: warn
camelcase: warn
no-else-return: warn
node/no-missing-require: warn
no-unused-expressions: warn
no-unused-vars: warn
no-multi-assign: warn
node/no-extraneous-require: warn


# Linter settings for TypeScript
- files: ["**/*.ts"]
parser: "@typescript-eslint/parser"
parserOptions:
ecmaVersion: 2020
sourceType: module
project: tsconfig.json
plugins:
- "@typescript-eslint"
extends:
- oclif
- oclif-typescript
- eslint:recommended
- prettier
- prettier/@typescript-eslint
- plugin:@typescript-eslint/recommended
- plugin:@typescript-eslint/recommended-requiring-type-checking
rules:
no-console: off
valid-jsdoc: off
no-warning-comments: off
no-use-before-define: off
prefer-promise-reject-errors: off
no-await-in-loop: off
no-negated-condition: off
no-implicit-coercion: off
new-cap: off
no-dupe-else-if: off
no-import-assign: off
no-setter-return: off
camelcase: warn
no-case-declarations: warn
"@typescript-eslint/ban-types": off
"@typescript-eslint/no-use-before-define": off
"@typescript-eslint/unbound-method": warn
"@typescript-eslint/ban-ts-comment": warn
"@typescript-eslint/prefer-regexp-exec": warn
"@typescript-eslint/no-non-null-assertion": warn
"@typescript-eslint/no-unsafe-call": warn
"@typescript-eslint/no-unsafe-return": warn
"@typescript-eslint/no-unsafe-member-access": warn
"@typescript-eslint/no-unsafe-assignment": warn
"@typescript-eslint/restrict-plus-operands": warn
"@typescript-eslint/restrict-template-expressions": warn
"@typescript-eslint/no-unnecessary-type-assertion": warn
"@typescript-eslint/await-thenable": warn
"@typescript-eslint/require-await": warn
"@typescript-eslint/no-var-requires": warn
7 changes: 4 additions & 3 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"internalConsoleOptions": "openOnSessionStart",
"skipFiles": [
"<node_internals>/**"

]
},
{
Expand All @@ -22,14 +23,14 @@
"skipFiles": [
"<node_internals>/**"
],
"smartStep": true,
"console": "integratedTerminal",
"internalConsoleOptions": "openOnSessionStart",
"program": "${workspaceFolder}/bin/run",
"args": [
"test",
"-g multi"
"publish"
],
"cwd": "/home/rkrauskopf/repos/connect-sample-apps/parcel-post"
"cwd": "/home/rkrauskopf/repos/connect-samples/cargo-inc"
}
]
}
77 changes: 49 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
![ShipEngine Connect](https://connect.shipengine.com/img/logos/shipengine-connect-logo.png)

# ShipEngine Connect CLI

### Command-line tool for building [ShipEngine Connect](https://connect.shipengine.com/docs/) apps
### Command-line tool for building [ShipEngine Connect](https://connect.shipengine.com/) apps

[![Cross-Platform Compatibility](https://shipengine.github.io/img/badges/os-badges.svg)](https://github.com/ShipEngine/connect-cli/actions)
[![Build Status](https://github.com/ShipEngine/connect-cli/workflows/CI-CD/badge.svg)](https://github.com/ShipEngine/connect-cli/actions)
Expand All @@ -24,7 +26,7 @@ $ npm install -g @shipengine/connect-cli
$ connect COMMAND
running command...
$ connect (-v|--version|version)
@shipengine/connect-cli/1.0.1 darwin-x64 node-v12.16.2
@shipengine/connect-cli/1.0.14 win32-x64 node-v14.7.0
$ connect --help [COMMAND]
USAGE
$ connect COMMAND
Expand All @@ -37,9 +39,10 @@ USAGE
<!-- commands -->
* [`connect help [COMMAND]`](#connect-help-command)
* [`connect info`](#connect-info)
* [`connect init [PATH]`](#connect-init-path)
* [`connect login`](#connect-login)
* [`connect logout`](#connect-logout)
* [`connect new [PATH]`](#connect-new-path)
* [`connect pack`](#connect-pack)
* [`connect publish`](#connect-publish)
* [`connect start`](#connect-start)
* [`connect test`](#connect-test)
Expand All @@ -60,7 +63,7 @@ OPTIONS
--all see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.0/src\commands\help.ts)_

## `connect info`

Expand All @@ -74,7 +77,32 @@ OPTIONS
-h, --help show help for the info command
```

_See code: [src/commands/info.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/info.ts)_
_See code: [src\commands\info.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.14/src\commands\info.ts)_

## `connect init [PATH]`

create a new package to develop a custom ShipEngine app

```
USAGE
$ connect init [PATH]
ARGUMENTS
PATH path to new package (defaults to current directory)
OPTIONS
-f, --force overwrite existing files
-h, --help show help for the new command
-y, --yes skips the questions and uses the defaults (carrier|Javascript|yaml)
ALIASES
$ connect new
EXAMPLE
$ connect init
```

_See code: [src\commands\init.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.14/src\commands\init.ts)_

## `connect login`

Expand All @@ -91,7 +119,7 @@ ALIASES
$ connect login
```

_See code: [src/commands/login.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/login.ts)_
_See code: [src\commands\login.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.14/src\commands\login.ts)_

## `connect logout`

Expand All @@ -108,32 +136,25 @@ ALIASES
$ connect logout
```

_See code: [src/commands/logout.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/logout.ts)_
_See code: [src\commands\logout.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.14/src\commands\logout.ts)_

## `connect new [PATH]`
## `connect pack`

create a new package to develop a custom ShipEngine app
package your app

```
USAGE
$ connect new [PATH]
ARGUMENTS
PATH path to new package (defaults to current directory)
$ connect pack
OPTIONS
-f, --force overwrite existing files
-h, --help show help for the new command
-y, --yes skips the questions and uses the defaults (carrier|Javascript|yaml)
ALIASES
$ connect init
-h, --help show help for the pack command
EXAMPLE
$ shipengine new
$ connect pack
```

_See code: [src/commands/new.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/new.ts)_
_See code: [src\commands\pack.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.14/src\commands\pack.ts)_

## `connect publish`

Expand All @@ -145,14 +166,14 @@ USAGE
OPTIONS
-h, --help show help for the publish command
-n, --no-watch does not track the status of the deployment
-s, --skip-tests skip running the test before publishing
-w, --watch check the status of the deployment until complete
EXAMPLE
$ shipengine publish
$ connect publish
```

_See code: [src/commands/publish.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/publish.ts)_
_See code: [src\commands\publish.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.14/src\commands\publish.ts)_

## `connect start`

Expand All @@ -167,7 +188,7 @@ OPTIONS
-p, --port=port [default: 3000] the port that the app will run on
```

_See code: [src/commands/start.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/start.ts)_
_See code: [src\commands\start.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.14/src\commands\start.ts)_

## `connect test`

Expand All @@ -186,11 +207,11 @@ OPTIONS
-t, --timeout=timeout specify the timeout for all the test
EXAMPLES
$ shipengine test
$ shipengine test --grep rateShipment
$ connect test
$ connect test --grep rateShipment
```

_See code: [src/commands/test.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/test.ts)_
_See code: [src\commands\test.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.14/src\commands\test.ts)_

## `connect whoami`

Expand All @@ -207,5 +228,5 @@ ALIASES
$ connect whoami
```

_See code: [src/commands/whoami.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/whoami.ts)_
_See code: [src\commands\whoami.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.14/src\commands\whoami.ts)_
<!-- commandsstop -->

0 comments on commit 5656a73

Please sign in to comment.