From 2bf4370fd2fd4cdf03102eae85892e866c193c66 Mon Sep 17 00:00:00 2001 From: Dimitri Mitropoulos Date: Mon, 23 Aug 2021 20:21:19 -0400 Subject: [PATCH] Inso -> Inso CLI (in docs) (#3936) --- DEVELOPMENT.md | 2 +- README.md | 2 +- packages/insomnia-inso/README.md | 10 +++++----- plugins/insomnia-plugin-os/README.md | 4 +--- 4 files changed, 8 insertions(+), 10 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 5fe7fa8e2c..f747c42d13 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -20,7 +20,7 @@ There are a few more technologies and tools worth mentioning: - [`Webpack`](https://webpack.js.org/) is the bundler used to compile the JS/Less/babel/etc - [`libcurl`](https://curl.se/libcurl/) is the library that Insomnia uses to make requests. Libcurl is the HTTP client of choice because it allows the deepest amount of debuggability and control of HTTP requests. - [`nedb`](https://github.com/louischatriot/nedb) a local in-memory database. -- [`node-libcurl`](https://github.com/JCMais/node-libcurl) is a NodeJS wrapper around the native libcurl library. +- [`node-libcurl`](https://github.com/JCMais/node-libcurl) is a Node.js wrapper around the native libcurl library. - [`Codemirror`](https://codemirror.net/) is a web-based, extendable, code editor used for highlighting and linting of data formats like JSON, GraphQL, and XML. - [`Commander.js`](https://github.com/tj/commander.js) is used for building the inso CLI. diff --git a/README.md b/README.md index e4095d7f27..772ad6ea2b 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ common text editors. Read more and download plugins at [editorconfig.org](http:/ ## Developing Development on Insomnia can be done on Mac, Windows, or Linux as long as you have -[NodeJS](https://nodejs.org) and [Git](https://git-scm.com/). See the `.nvmrc` file located in the project for the correct Node version. +[Node.js](https://nodejs.org) and [Git](https://git-scm.com/). See the `.nvmrc` file located in the project for the correct Node version.
Initial Dev Setup diff --git a/packages/insomnia-inso/README.md b/packages/insomnia-inso/README.md index 549837e9b1..935dbb112c 100644 --- a/packages/insomnia-inso/README.md +++ b/packages/insomnia-inso/README.md @@ -4,7 +4,7 @@

- Inso + Inso CLI

@@ -269,9 +269,9 @@ inso gen-conf:k8s -o output.yaml # generates kubernetes config to output.yaml # Configuration -Inso can be configured with a configuration file, allowing you to specify options and scripts. For example, when running in a CI environment, you may choose to specify the steps as scripts in a config file, so that the same commands can be run both locally and in CI. +Inso CLI can be configured with a configuration file, allowing you to specify options and scripts. For example, when running in a CI environment, you may choose to specify the steps as scripts in a config file, so that the same commands can be run both locally and in CI. -Inso uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) for config file management, meaning any of the following items found in the working tree are automatically used: +Inso CLI uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) for config file management, meaning any of the following items found in the working tree are automatically used: + `inso` property in `package.json` + `.insorc` file in JSON or YAML format @@ -324,7 +324,7 @@ winpty inso.cmd generate config # Continuous Integration -`inso` has been designed to run in a CI environment, disabling prompts and providing exit codes to pass or fail the CI workflow accordingly. An example workflow run in Github Actions is as follows. This example will checkout > install NodeJS > install inso > run linting > run unit tests > generate configuration. If any of these steps fail, the GH workflow will as well. +`inso` has been designed to run in a CI environment, disabling prompts and providing exit codes to pass or fail the CI workflow accordingly. An example workflow run in Github Actions is as follows. This example will checkout > install Node.js > install Inso CLI > run linting > run unit tests > generate configuration. If any of these steps fail, the GH workflow will as well. ``` yaml # .github/workflows/test.yml @@ -338,7 +338,7 @@ jobs: steps: - name: Checkout branch uses: actions/checkout@v1 - - name: Install NodeJS + - name: Install Node.js uses: actions/setup-node@v1 - name: Install inso run: npm install --global insomnia-inso diff --git a/plugins/insomnia-plugin-os/README.md b/plugins/insomnia-plugin-os/README.md index 6c2c201aa4..9cd15acca8 100644 --- a/plugins/insomnia-plugin-os/README.md +++ b/plugins/insomnia-plugin-os/README.md @@ -2,10 +2,8 @@ [![Npm Version](https://img.shields.io/npm/v/insomnia-plugin-os.svg)](https://www.npmjs.com/package/insomnia-plugin-os) -This is a plugin for [Insomnia](https://insomnia.rest) that provides access to some -convenient functions from the NodeJS `os` package. +This is a plugin for [Insomnia](https://insomnia.rest) that provides access to some convenient functions from the Node.js `os` package. ## Installation Install the `insomnia-plugin-os` plugin from Preferences > Plugins. -