@citolab/tspci 2.3.0-alpha.4 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@citolab/tspci",
-  "version": "2.3.0-alpha.4",
+  "version": "2.3.0",
   "description": "an opiniated typescript ims-pci builder with tao integration",
   "author": "patrick <patrick.deklein@cito.nl>",
   "repository": "@citolab/tspci",
@@ -46,5 +46,5 @@
     "help": "tspci --help",
     "init": "tspci init --force --path=../../pcis"
   },
-  "gitHead": "a73cb286cca0f12d474e155915c251f85abf4b16"
+  "gitHead": "c7100a7ee3cd62cb7beb2bd6379c830cdec04a59"
 }

package/readme.md

@@ -23,6 +23,42 @@
 
 ## 🔧 Installation & Setup
 
+### Cli
+
+The easiest way to setup a pci develop environment is by using the cli.
+This will ask a few options, and creates a PCI development environment with an example implementation.
+
+<p align="center">
+  <img src="https://github.com/Citolab/tspci/blob/main/lib/tspci/tspci-console.png" alt="Setup using console">
+</p>
+
+Run:  ```npx @citolab/tspci@latest init```
+
+1. It will ask to download the latest version of tspci.
+2. If agreed; tspci will be downloaded and started. 
+3. You should provide a name/identifier for your PCI.
+4. You should provide a description.
+5. Last option is to add options: tailwind and preact (both are selected by default, for more info; keep reading).
+
+#### Tailwind
+Tailwind is a popular css framework and can be used to give a nice look and feel of the PCI. The cli will make sure the css is added; and all build stuff that comes with tailwind is setup.
+
+#### preact
+preact is a small version of react. You can develop your PCI using hooks and the render function as you are familiar with in react. When preact is selected the cli will also add a store to manage state. This can easily be used to store all user actions in the PCI, and even replay them.
+
+### specific implementations like TAO.
+We also support to create a PCI that can be imported in TAO. Therefor you should use @citolab/tspci-tao.
+
+To add tao using the cli you should run the following command inside your PCI folder:
+
+``` sh
+  npm run tspci -- add --target tao
+```
+
+For more info: [@citolab/tspci-tao](https://github.com/Citolab/tspci/tree/main/lib/tspci-tao)
+
+### Manual
+
 1️. **Install** by running: `npm i -D @citolab/tspci`
 
 2️. **Set up** your `package.json`:
@@ -40,6 +76,11 @@
     "@citolab/tspci": "^1.5.6",
     "@citolab/tspci-tao": "^1.0.0"
   },
+  "config": {
+    "tspci": {
+      "typeIdentifier": "helloWorld"
+    }
+  },
   "scripts": {
     "dev": "tspci --dev",
     "prod": "tspci"
@@ -129,6 +170,8 @@ Available Commands
   --watch  -w     Only watch changes
   --help   -h     Help about commandos
   --target -t     Build production for platform
+  init            Init PCI development environment.
+  add --target    Add specific implementation to the PCI. 
 
 Examples package.json scripts
 	$ "dev": "tspci --dev",
@@ -322,14 +365,6 @@ More info, see our extension
 - [github](https://github.com/Citolab/tspci/blob/main/lib/tspci-tao)
 - [@citolab/tspci-tao](https://www.npmjs.com/package/@citolab/tspci-tao)
 
-
-## Roadmap
-
-- Packager for Facet
-- Packager for Trifork
-- Create PCI with Vue
-- Create PCI with Haunted
-
 If you want your platform to be support,  [contact us](mailto://getinspiredbycitolab@gmail.com)
 
 

package/release-notes.md

@@ -1,4 +1,6 @@
 
+# 2.3.0
+- added a cli to initialize a PCI workspace (```tspci init```)
 # 2.1.3
 - added workaround for bug in new @rollup/plugin-terser
   see https://github.com/rollup/plugins/issues/1366#issuecomment-1345358157

package/src/cli.js

@@ -349,7 +349,7 @@ const run = async () => {
     if (args.indexOf("--no-install") === -1) {
       console.log(chalk.green("📦 Installing dependencies"));
       execSync("npm install", { cwd: destinationFolder, stdio: [0, 1, 2] });
-      console.log(chalk.green("📦 Done! You can now start the dev server with npm run dev"));
+      console.log(chalk.green(`📦 Done! Navigate to ${destinationFolder} or open this folder (e.g. with vscode). You can now start the dev server with: npm run dev`));
       return;
     } else {
       console.log(chalk.yellow("Skipping npm install, run npm install in the project folder to install dependencies"));