@cplace/cli
Advanced tools
Comparing version 0.19.8 to 0.19.9
@@ -12,2 +12,3 @@ /** | ||
commit?: string; | ||
description?: string; | ||
} | ||
@@ -14,0 +15,0 @@ export interface IModulesXmlRoot { |
@@ -49,3 +49,4 @@ "use strict"; | ||
url: current.url, | ||
branch: status.current | ||
branch: status.current, | ||
description: current.description ? current.description : repo.repoName | ||
}; | ||
@@ -52,0 +53,0 @@ if (this.freeze || current.commit) { |
{ | ||
"name": "@cplace/cli", | ||
"version": "0.19.8", | ||
"version": "0.19.9", | ||
"description": "", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
# Document Control / Repository Information | ||
Item | Value | ||
Item | Value | ||
--- | --- | ||
Owner | Christian Kaltenbach, Philip Stöhrer, Stefan Stadler | ||
Team | none yet | ||
Project | none | ||
Parent | none | ||
Developed by | collaboration Factory AG | ||
Description | Unser Kommandozeilen-Werkzeug um mit cplace Code zu arbeiten. | ||
Owner | Christian Kaltenbach, Philip Stöhrer, Stefan Stadler | ||
Team | none yet | ||
Project | none | ||
Parent | none | ||
Developed by | collaboration Factory AG | ||
Description | Our commandline utility to work with cplace code | ||
@@ -20,2 +21,3 @@ # cplace CLI tools | ||
To install `cplace-cli` run the following command: | ||
```bash | ||
@@ -26,6 +28,9 @@ npm install -g @cplace/cli | ||
After installation you can just execute: | ||
```bash | ||
cplace-cli --help | ||
``` | ||
to get the available commands and help: | ||
```text | ||
@@ -177,2 +182,3 @@ $ cplace-cli --help | ||
Before you can work with the repository, you need to install node modules once: | ||
```bash | ||
@@ -183,11 +189,15 @@ npm install | ||
Typescript is compiled and linted by running: | ||
```bash | ||
npm run dev | ||
``` | ||
This will execute both tslint (`npm run dev:lint`) as well as run the Typescript compiler (`npm run dev:tsc`). | ||
To test your local changes with `cplace-cli` on the command line you have to `link` your local npm package by running: | ||
```bash | ||
npm link | ||
``` | ||
This will first recompile the Typescript sources and do the linting before setting up and linking the binary executable. | ||
@@ -200,2 +210,3 @@ When `npm link` is completed, you can just use `cplace-cli` as usual to test it out. | ||
To execute the available unit tests run: | ||
```bash | ||
@@ -202,0 +213,0 @@ npm run test |
Sorry, the diff of this file is not supported yet
365962
5123
221