@catladder/cli 0.0.0-waitfor-deploy-31ebcf14 → 0.0.0-workspace-builds-47c5aa5a

package/CONTRIBUTING.md

@@ -2,10 +2,11 @@
 
 #### Atomic commits
 
-If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means:
-- a commit should contain exactly one self-contained functional change
-- a functional change should be contained in exactly one commit
-- a commit should not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc...)
+If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means that a commit should:
+
+- Contain exactly one self-contained functional change
+- Not depend on changes in one of your later commits
+- Not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc…)
 
 A complex feature can be broken down into multiple commits as long as each one maintains a consistent state and consists of a self-contained change.
 
@@ -27,7 +28,8 @@ The **footer** can contain a [closing reference to an issue](https://help.github
 
 #### Revert
 
-If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit.  
+In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
 
 #### Type
 
@@ -42,25 +44,28 @@ The type must be one of the following:
 | **fix**      | A bug fix                                                                                                   |
 | **perf**     | A code change that improves performance                                                                     |
 | **refactor** | A code change that neither fixes a bug nor adds a feature                                                   |
-| **style**    | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)      |
+| **style**    | Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc)      |
 | **test**     | Adding missing tests or correcting existing tests                                                           |
 
 #### Subject
 
-The subject contains succinct description of the change:
+The subject contains a succinct description of the change:
 
 - use the imperative, present tense: "change" not "changed" nor "changes"
-- don't capitalize first letter
+- don't capitalize the first letter
 - no dot (.) at the end
 
 #### Body
-Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
-The body should include the motivation for the change and contrast this with previous behavior.
+
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".  
+The body should include the motivation for the change and contrast this with previous behaviour.
 
 #### Footer
+
 The footer should contain any information about **Breaking Changes** and is also the place to reference GitLab issues that this commit **Closes**.
 
-**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.  
+The rest of the commit message is then used for this.
 
 #### Examples
 
@@ -80,4 +85,4 @@ perf(pencil): remove graphiteWidth option`
 BREAKING CHANGE: The graphiteWidth option has been removed.
 
 The default graphite width of 10mm is always used for performance reasons.
-```
+```

package/README.md

@@ -1,34 +1,41 @@
 # catladder 🐱 🔧
 
-panter cli tool for kubernetes
+Panter cli tool for Kubernetes.
 
 ## Install
 
-`yarn global add @catladder/cli`
+```sh
+# yarn users
+yarn global add @catladder/cli
+# npm users
+npm install -g @catladder/cli
+```
 
-or npm users
-
-`npm install -g @catladder/cli`
-
-_Note: if you have `@panter/catladder` installed upgrade it to >=4.0.0 before installing `@catladder/cli`_
+> **Note**: If you have [@catladder/pipeline](https://www.npmjs.com/package/@catladder/pipeline) installed, upgrade it to >=4.0.0 before installing [@catladder/cli](https://www.npmjs.com/package/@catladder/cli).
 
 ## Getting started
 
-You'll need
+You'll need:
 
 - Google Cloud SDK ([see installation instructions](https://cloud.google.com/sdk/docs/install))
 - Kubectl ([see installation instructions](https://kubernetes.io/docs/tasks/tools/))
 - Cloud SQL Auth proxy ([see installation instructions](https://cloud.google.com/sql/docs/postgres/sql-proxy#install))
 
-Afterwards you need to connect to your cluster, e.g. `gcloud container clusters get-credentials clustername --zone google-zone --project google-project-id`
-In most cases you'll find the details on the Google Cloud [cluster overview ](https://console.cloud.google.com/kubernetes/list?project=skynet-164509)
+Afterwards, you need to connect to your cluster, e.g. `gcloud container clusters get-credentials clustername --zone google-zone --project google-project-id`
+In most cases, you'll find the details on the Google Cloud [cluster overview ](https://console.cloud.google.com/kubernetes/list?project=skynet-164509)
 
 It just works™
 
 ## Preferences
 
-catladder stores some preferences in `~/.catladder/preferences.yml` in case you want to change settings.
+Catladder stores some preferences in `~/.catladder/preferences.yml` in case you want to change settings.
 
 ## Contribution
 
-Check the docu [here](/CONTRIBUTING.md).
+Check the documentation [here](https://git.panter.ch/catladder/catladder/-/tree/main/cli/CONTRIBUTING.md).
+
+### Adding packages in cli
+
+if you add npm libs in cli, make sure to add them as dev-dependencies.
+
+the reason is that we bundle all dependencies in the cli package, so that if you add that to your project, it won't install all @catladder/cli's dependencies.

package/bin/catci

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// tslint:disable-next-line:no-var-requires
+require("../dist/bundles/catci/index.js");

package/bin/catci-dev

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// tslint:disable-next-line:no-var-requires
+require("../dist/cli/src/catci.js");

package/bin/catenv

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 // tslint:disable-next-line:no-var-requires
-require("../dist/catenv.js");
+require("../dist/bundles/catenv/index.js");

package/bin/catenv-dev

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// tslint:disable-next-line:no-var-requires
+require("../dist/cli/src/catenv.js");

package/bin/catladder

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 // tslint:disable-next-line:no-var-requires
-require("../dist/cli.js");
+require("../dist/bundles/cli/index.js");

package/bin/catladder-dev

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// tslint:disable-next-line:no-var-requires
+require("../dist/cli/src/cli.js");