@springmicro/cli 0.1.4 → 0.1.6

package/README.md

@@ -1,6 +1,6 @@
 # @springmicro/cli
 
-A new CLI generated with oclif.
+Command line utilities for SpringMicroHost.
 
 [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
 [![Version](https://img.shields.io/npm/v/@springmicro/cli.svg)](https://npmjs.org/package/@springmicro/cli)
@@ -10,11 +10,10 @@ A new CLI generated with oclif.
 * [@springmicro/cli](#springmicrocli)
 * [Usage](#usage)
 * [Commands](#commands)
+* [Development](#development)
 <!-- tocstop -->
 
-- [Usage](#usage)
-- [Commands](#commands)
-<!-- tocstop -->
+- [@springmicro/cli](#springmicrocli)
 - [Usage](#usage)
 - [Commands](#commands)
 <!-- tocstop -->
@@ -27,7 +26,7 @@ $ npm install -g @springmicro/cli
 $ springmicro COMMAND
 running command...
 $ springmicro (--version)
-@springmicro/cli/0.1.4 win32-x64 node-v18.17.1
+@springmicro/cli/0.1.6 win32-x64 node-v18.17.1
 $ springmicro --help [COMMAND]
 USAGE
   $ springmicro COMMAND
@@ -40,21 +39,7 @@ $ npm install -g @springmicro/cli
 $ springmicro COMMAND
 running command...
 $ springmicro (--version)
-@springmicro/cli/0.1.0 win32-x64 node-v18.17.1
-$ springmicro --help [COMMAND]
-USAGE
-  $ springmicro COMMAND
-...
-```
-
-<!-- usagestop -->
-
-```sh-session
-$ npm install -g @springmicro/cli
-$ springmicro COMMAND
-running command...
-$ springmicro (--version)
-@springmicro/cli/0.0.0 win32-x64 node-v18.17.1
+@springmicro/cli/0.1.5 win32-x64 node-v18.17.1
 $ springmicro --help [COMMAND]
 USAGE
   $ springmicro COMMAND
@@ -121,7 +106,7 @@ EXAMPLES
   $ springmicro init astro -n example
 ```
 
-_See code: [src/commands/init/index.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.1.4/src/commands/init/index.ts)_
+_See code: [src/commands/init/index.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.1.6/src/commands/init/index.ts)_
 
 ## `springmicro init astro`
 
@@ -141,7 +126,7 @@ EXAMPLES
   $ springmicro init astro -n <project-name>
 ```
 
-_See code: [src/commands/init/astro.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.1.4/src/commands/init/astro.ts)_
+_See code: [src/commands/init/astro.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.1.6/src/commands/init/astro.ts)_
 
 ## `springmicro plugins`
 
@@ -488,6 +473,374 @@ EXAMPLES
   $ springmicro init astro -n example
 ```
 
+_See code: [src/commands/init/index.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.1.5/src/commands/init/index.ts)_
+
+## `springmicro init astro`
+
+Initialize a Astro project according to SpringMicroHost's specifications.
+
+```
+USAGE
+  $ springmicro init astro -n <value>
+
+FLAGS
+  -n, --name=<value>  (required) Project name
+
+DESCRIPTION
+  Initialize a Astro project according to SpringMicroHost's specifications.
+
+EXAMPLES
+  $ springmicro init astro -n <project-name>
+```
+
+_See code: [src/commands/init/astro.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.1.5/src/commands/init/astro.ts)_
+
+## `springmicro plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ springmicro plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ springmicro plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/index.ts)_
+
+## `springmicro plugins add PLUGIN`
+
+Installs a plugin into springmicro.
+
+```
+USAGE
+  $ springmicro plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into springmicro.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the SPRINGMICRO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the SPRINGMICRO_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ springmicro plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ springmicro plugins add myplugin
+
+  Install a plugin from a github url.
+
+    $ springmicro plugins add https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ springmicro plugins add someuser/someplugin
+```
+
+## `springmicro plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ springmicro plugins inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN...  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ springmicro plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/inspect.ts)_
+
+## `springmicro plugins install PLUGIN`
+
+Installs a plugin into springmicro.
+
+```
+USAGE
+  $ springmicro plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into springmicro.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the SPRINGMICRO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the SPRINGMICRO_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ springmicro plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ springmicro plugins install myplugin
+
+  Install a plugin from a github url.
+
+    $ springmicro plugins install https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ springmicro plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/install.ts)_
+
+## `springmicro plugins link PATH`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ springmicro plugins link PATH [-h] [--install] [-v]
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help          Show CLI help.
+  -v, --verbose
+      --[no-]install  Install dependencies after linking the plugin.
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ springmicro plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/link.ts)_
+
+## `springmicro plugins remove [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ springmicro plugins remove [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ springmicro plugins unlink
+  $ springmicro plugins remove
+
+EXAMPLES
+  $ springmicro plugins remove myplugin
+```
+
+## `springmicro plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ springmicro plugins reset [--hard] [--reinstall]
+
+FLAGS
+  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
+  --reinstall  Reinstall all plugins after uninstalling.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/reset.ts)_
+
+## `springmicro plugins uninstall [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ springmicro plugins uninstall [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ springmicro plugins unlink
+  $ springmicro plugins remove
+
+EXAMPLES
+  $ springmicro plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/uninstall.ts)_
+
+## `springmicro plugins unlink [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ springmicro plugins unlink [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ springmicro plugins unlink
+  $ springmicro plugins remove
+
+EXAMPLES
+  $ springmicro plugins unlink myplugin
+```
+
+## `springmicro plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ springmicro plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/update.ts)_
+
+<!-- commandsstop -->
+
+- [`springmicro help [COMMAND]`](#springmicro-help-command)
+- [`springmicro init PROJECTTYPE`](#springmicro-init-projecttype)
+- [`springmicro init astro`](#springmicro-init-astro)
+- [`springmicro plugins`](#springmicro-plugins)
+- [`springmicro plugins add PLUGIN`](#springmicro-plugins-add-plugin)
+- [`springmicro plugins:inspect PLUGIN...`](#springmicro-pluginsinspect-plugin)
+- [`springmicro plugins install PLUGIN`](#springmicro-plugins-install-plugin)
+- [`springmicro plugins link PATH`](#springmicro-plugins-link-path)
+- [`springmicro plugins remove [PLUGIN]`](#springmicro-plugins-remove-plugin)
+- [`springmicro plugins reset`](#springmicro-plugins-reset)
+- [`springmicro plugins uninstall [PLUGIN]`](#springmicro-plugins-uninstall-plugin)
+- [`springmicro plugins unlink [PLUGIN]`](#springmicro-plugins-unlink-plugin)
+- [`springmicro plugins update`](#springmicro-plugins-update)
+
+## `springmicro help [COMMAND]`
+
+Display help for springmicro.
+
+```
+USAGE
+  $ springmicro help [COMMAND...] [-n]
+
+ARGUMENTS
+  COMMAND...  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for springmicro.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.0/src/commands/help.ts)_
+
+## `springmicro init PROJECTTYPE`
+
+Initialize a JavaScript framework project according to SpringMicroHost's specifications.
+
+```
+USAGE
+  $ springmicro init PROJECTTYPE -n <value>
+
+ARGUMENTS
+  PROJECTTYPE  Project type (astro)
+
+FLAGS
+  -n, --name=<value>  (required) Project name
+
+DESCRIPTION
+  Initialize a JavaScript framework project according to SpringMicroHost's specifications.
+
+EXAMPLES
+  $ springmicro init astro -n example
+```
+
 _See code: [src/commands/init/index.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.1.0/src/commands/init/index.ts)_
 
 ## `springmicro init astro`
@@ -1166,4 +1519,15 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/update.ts)_
 
-<!-- commandsstop -->
+<!-- commandsstop -->
+
+# Development
+
+See [https://oclif.io/docs/templates](https://oclif.io/docs/templates) for details about running the CLI in development.
+
+The generated CLI project contains 4 bin scripts that you can use for either production or development.
+
+- `bin/run.js` - Run the CLI in production (macOS and Linux)
+- `bin/dev.js` - Run the CLI in development (macOS and Linux)
+- `bin/run.cmd` - Run the CLI in production (Windows)
+- `bin/dev.cmd` - Run the CLI in development (Windows)

package/dist/commands/init/astro.d.ts

@@ -12,5 +12,6 @@ export default class Astro extends Command {
      */
     astroCreate(args: Record<string, string>, flags: Record<string, string>): Promise<void>;
     astroFileManip(args: Record<string, string>, flags: Record<string, string>): void;
+    finished(args: Record<string, string>, flags: Record<string, string>): void;
     run(): Promise<void>;
 }

package/dist/commands/init/astro.js

@@ -1,11 +1,10 @@
 import { Command, Flags } from '@oclif/core';
-import { spawn } from 'node:child_process';
 import fs from 'node:fs';
 import path from 'node:path';
 import { tailwindConfigMjs, globalsCSS, libUtils, componentsJSON } from '../../data/astro/index.js';
 import chalk from 'chalk';
 import { logStep } from '../../log/index.js';
-import os from 'os';
+import { checkUnixShellAndSpawn } from '../../utils/shell.js';
 export default class Astro extends Command {
     static step = 1;
     static totalSteps = 2;
@@ -26,25 +25,12 @@ export default class Astro extends Command {
             this.log(chalk.red('Filesystem already exists at ' + chalk.bold(name) + ', exiting...'));
             this.exit(1);
         }
-        logStep('Initializing Astro project...', Astro.step, Astro.totalSteps);
-        const isWindows = os.platform() === 'win32';
-        const astroCmd = isWindows
-            ? `./${path.join('scripts', 'astro.bat')} ${name}`
-            : `sh ${path.join('scripts', 'astro.sh')} ${name}`;
-        const astroPS = spawn(astroCmd, {
-            stdio: 'inherit', // This ensures the child process's stdio is piped directly to the parent process's stdio
-        });
-        astroPS.on('close', (code) => {
-            console.log(`child process close all stdio with code ${code}`);
-            this.astroFileManip(args, flags);
-        });
-        astroPS.on('exit', (code) => {
-            console.log(`child process exited with code ${code}`);
-        });
+        Astro.step = logStep('Initializing Astro project...', Astro.step, Astro.totalSteps);
+        await checkUnixShellAndSpawn('sh', [path.posix.join('dist', 'scripts', 'astro.sh'), name], path.join('dist', 'scripts', 'astro.bat'), [name], () => this.astroFileManip(args, flags));
     }
     astroFileManip(args, flags) {
         const { name } = flags;
-        logStep('Manipulating project files.', Astro.step, Astro.totalSteps);
+        Astro.step = logStep('Manipulating project files.', Astro.step, Astro.totalSteps);
         const componentsJSONFilePath = path.join(name, 'components.json');
         const tsConfigFilePath = path.join(name, 'tsconfig.json');
         const tailwindConfigFilePath = path.join(name, 'tailwind.config.mjs');
@@ -82,9 +68,18 @@ export default class Astro extends Command {
             recursive: true,
         });
     }
+    finished(args, flags) {
+        const { name } = flags;
+        this.log('');
+        this.log(chalk.bgCyan.black('FINISHED!'));
+        this.log('');
+        this.log(`cd ${name}`);
+        this.log(`pnpm run dev`);
+    }
     async run() {
         const { args, flags } = await this.parse(Astro);
         // const {name} = flags;
         await this.astroCreate(args, flags);
+        this.finished(args, flags);
     }
 }

package/dist/log/index.d.ts

@@ -1 +1 @@
-export declare function logStep(msg: string, step: number, totalSteps?: number): void;
+export declare function logStep(msg: string, step: number, totalSteps?: number): number;

package/dist/log/index.js

@@ -1,6 +1,7 @@
 import chalk from 'chalk';
 export function logStep(msg, step, totalSteps = 0) {
     const stepDisplay = totalSteps > 0 ? `(${step}/${totalSteps})` : `(${step})`;
-    console.log(chalk.bgCyan.black.bold(stepDisplay) + ' ' + chalk.cyan.bold(msg));
+    console.log('\n' + chalk.bgCyan.black.bold(stepDisplay) + ' ' + chalk.cyan.bold(msg));
     step += 1;
+    return step;
 }

package/dist/utils/shell.d.ts

@@ -0,0 +1 @@
+export declare function checkUnixShellAndSpawn(unixCmd: string, unixArgs: string[], windowsCmd: string, windowsArgs: string[], callback?: Function | null): Promise<void>;

package/dist/utils/shell.js

@@ -0,0 +1,20 @@
+import { exec, spawn } from 'node:child_process';
+export async function checkUnixShellAndSpawn(unixCmd, unixArgs, windowsCmd, windowsArgs, callback = null) {
+    exec('sh -c "echo $SHELL"', (error, stdout, stderr) => {
+        const isWindows = !!error;
+        const cmd = isWindows ? windowsCmd : unixCmd;
+        const args = isWindows ? windowsArgs : unixArgs;
+        const ps = spawn(cmd, args, {
+            stdio: 'inherit', // This ensures the child process's stdio is piped directly to the parent process's stdio
+        });
+        ps.on('close', (code) => {
+            console.log(`child process close all stdio with code ${code}`);
+            if (callback) {
+                callback();
+            }
+        });
+        ps.on('exit', (code) => {
+            console.log(`child process exited with code ${code}`);
+        });
+    });
+}

package/oclif.manifest.json

@@ -77,5 +77,5 @@
       ]
     }
   },
-  "version": "0.1.4"
+  "version": "0.1.6"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@springmicro/cli",
   "description": "A new CLI generated with oclif",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "author": "David Buckley",
   "private": false,
   "publishConfig": {
@@ -76,5 +76,5 @@
     "version": "oclif readme && git add README.md"
   },
   "types": "dist/index.d.ts",
-  "gitHead": "e5d6158a967da3d0df7ed29fc1d06755ffa240b8"
+  "gitHead": "5b3b9598d14078814db999b63a68e7cffaecfdf2"
 }