mirrors/insomnia
1
0
Fork 0
mirror of https://github.com/Kong/insomnia synced 2024-11-08 06:39:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tidy up inso readme (#2363)

Browse Source
This commit is contained in:
Opender Singh 2020-07-09 11:45:54 +12:00 committed by GitHub
parent b571ba5755
commit 7d49e58fb8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
packages/insomnia-inso/.npmignore
View File

@ -5,4 +5,3 @@
# Don't ignore dist folder # Don't ignore dist folder
!dist/* !dist/*
!assets/*

27
packages/insomnia-inso/README.md
View File

@ -20,8 +20,7 @@ Typically, Insomnia database id's are quite long, for example: `wrk_012d4860c7da
Additionally, if the `[identifier]` argument is ommitted from the command, `inso` will search in the database for the information it needs, and prompt the user. Prompts can be disabled with the `--ci` global option. Additionally, if the `[identifier]` argument is ommitted from the command, `inso` will search in the database for the information it needs, and prompt the user. Prompts can be disabled with the `--ci` global option.
![](/packages/insomnia-inso/assets/ci-demo.gif) ![](https://raw.githubusercontent.com/Kong/insomnia/develop/packages/insomnia-inso/assets/ci-demo.gif)
![](/assets/ci-demo.gif)
## Commands ## Commands
@ -48,7 +47,8 @@ Similar to the Kong [Kubernetes](https://insomnia.rest/plugins/insomnia-plugin-k
#### Examples #### Examples
When running in the [git-repo](/packages/insomnia-inso/src/db/__fixtures__/git-repo) directory <details>
<summary>When running in the <a href="https://github.com/Kong/insomnia/tree/develop/packages/insomnia-inso/src/db/__fixtures__/git-repo">git-repo</a> directory</summary>
``` ```
inso generate config inso generate config
@ -63,6 +63,7 @@ inso generate config "Sample Specification" --type kubernetes
inso generate config spec.yaml --working-dir another/dir inso generate config spec.yaml --working-dir another/dir
``` ```
</details>
### `$ inso lint spec [identifier]` ### `$ inso lint spec [identifier]`
@ -72,7 +73,8 @@ Designer has the ability to lint and validate your OpenAPI specification as you
#### Examples #### Examples
When running in the [git-repo](/packages/insomnia-inso/src/db/__fixtures__/git-repo) directory <details>
<summary>When running in the <a href="https://github.com/Kong/insomnia/tree/develop/packages/insomnia-inso/src/db/__fixtures__/git-repo">git-repo</a> directory</summary>
``` ```
inso lint spec inso lint spec
@ -81,6 +83,7 @@ inso lint spec spc_46c5a4
inso lint spec "Sample Specification" inso lint spec "Sample Specification"
``` ```
</details>
### `$ inso run test [options] [identifier]` ### `$ inso run test [options] [identifier]`
@ -100,24 +103,34 @@ The test runner is built on top of Mocha, thus many of the options behave as the
#### Examples #### Examples
When running in the [git-repo](/packages/insomnia-inso/src/db/__fixtures__/git-repo) directory. <details>
<summary>When running in the <a href="https://github.com/Kong/insomnia/tree/develop/packages/insomnia-inso/src/db/__fixtures__/git-repo">git-repo</a> directory</summary>
Not specifying any arguments will prompt
``` ```
inso run test inso run test
```
# By document Scope by the document name or id
```
inso run test "Sample Specification" --env "OpenAPI env" inso run test "Sample Specification" --env "OpenAPI env"
inso run test spc_46c5a4 --env env_env_ca046a inso run test spc_46c5a4 --env env_env_ca046a
```
# By suite Scope by the a test suite name or id
```
inso run test "Math Suite" --env "OpenAPI env" inso run test "Math Suite" --env "OpenAPI env"
inso run test uts-7f0f85 --env env_env_ca046a inso run test uts-7f0f85 --env env_env_ca046a
```
Scope by test name regex, and control test running and reporting
```
inso run test "Sample Specification" --test-name-pattern Math --env env_env_ca046a inso run test "Sample Specification" --test-name-pattern Math --env env_env_ca046a
inso run test spc_46c5a4 --reporter progress --bail --keep-file inso run test spc_46c5a4 --reporter progress --bail --keep-file
``` ```
More examples: [#2338](https://github.com/Kong/insomnia/pull/2338). More examples: [#2338](https://github.com/Kong/insomnia/pull/2338).
</details>
## Development ## Development