@labshare/lsc
v2.19.0
Published
Lab Share Command
Downloads
277
Readme
LSC
has all the code for CLI of LabShare. It is based on flatIron.
Install
npm i -g @labshare/lsc
Usage
Run lsc help
to display a list of available commands.
App Templates
Run lsc create app
to display a list of available templates.
- api: API template powered by LoopBack and LabShare Services
- ui: UI template powered by Angular and LabShare Services
- cli: CLI template LabShare Services
You can also provide CLI arguments for a programmatic usage:
--name my-app-name
--description 'some description'
--type ui
(can beui
,api
, orcli
)-y
(Bypass "continue?" question, useful for automated scripts)
Note: The command will add all the app's files. It is recommended to create a folder and execute the command inside that folder.
lsc Settings
To define the cliPattern and packageDependencies, you can use the lsc
property at package.json
"lsc": {
"cliPattern": "dist/cli/*.js",
"packageDependencies":[]
},
In the example , lsc is reading the package's cli commands from the cliPattern
directory, also
is checking the packageDependencies from the same section.
Package Dependencies
The add commands from other cli's labShare packages, you will need to specify the packageDependencies
property at
the package.json file. This property can be defined inside the lsc
property or as a root property at the package.json
file.
This is an array of all the projects which contains cli commands, for example:
"packageDependencies": [
"@labshare/services",
"@labshare/lsc"
],
In the example , lsc is reading the package's cli commands from each module declared at packageDependencies
,
Documentation
How to define new CLI commands for LSC
Working with package configuration files [Optional]
Tests
npm test