diff --git a/packages/insomnia-inso/.npmignore b/packages/insomnia-inso/.npmignore index 9b0865cc54..dd6549cf98 100644 --- a/packages/insomnia-inso/.npmignore +++ b/packages/insomnia-inso/.npmignore @@ -5,4 +5,3 @@ # Don't ignore dist folder !dist/* -!assets/* diff --git a/packages/insomnia-inso/README.md b/packages/insomnia-inso/README.md index 2933b186ec..bf2f35f462 100644 --- a/packages/insomnia-inso/README.md +++ b/packages/insomnia-inso/README.md @@ -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. -![](/packages/insomnia-inso/assets/ci-demo.gif) -![](/assets/ci-demo.gif) +![](https://raw.githubusercontent.com/Kong/insomnia/develop/packages/insomnia-inso/assets/ci-demo.gif) ## Commands @@ -48,7 +47,8 @@ Similar to the Kong [Kubernetes](https://insomnia.rest/plugins/insomnia-plugin-k #### Examples -When running in the [git-repo](/packages/insomnia-inso/src/db/__fixtures__/git-repo) directory +
+ When running in the git-repo directory ``` inso generate config @@ -63,6 +63,7 @@ inso generate config "Sample Specification" --type kubernetes inso generate config spec.yaml --working-dir another/dir ``` +
### `$ inso lint spec [identifier]` @@ -72,7 +73,8 @@ Designer has the ability to lint and validate your OpenAPI specification as you #### Examples -When running in the [git-repo](/packages/insomnia-inso/src/db/__fixtures__/git-repo) directory +
+ When running in the git-repo directory ``` inso lint spec @@ -81,6 +83,7 @@ inso lint spec spc_46c5a4 inso lint spec "Sample Specification" ``` +
### `$ 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 -When running in the [git-repo](/packages/insomnia-inso/src/db/__fixtures__/git-repo) directory. +
+ When running in the git-repo directory +Not specifying any arguments will prompt ``` inso run test +``` -# By document +Scope by the document name or id +``` inso run test "Sample Specification" --env "OpenAPI env" 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 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 spc_46c5a4 --reporter progress --bail --keep-file ``` More examples: [#2338](https://github.com/Kong/insomnia/pull/2338). +
## Development