@iconoma/cli 0.0.1-beta.1

package/README.md

@@ -0,0 +1,374 @@
+@iconoma/cli
+=================
+
+A developer-friendly tool to manage and organize icons through CLI and web studio
+
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/@iconoma/cli.svg)](https://npmjs.org/package/@iconoma/cli)
+[![Downloads/week](https://img.shields.io/npm/dw/@iconoma/cli.svg)](https://npmjs.org/package/@iconoma/cli)
+
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @iconoma/cli
+$ iconoma COMMAND
+running command...
+$ iconoma (--version)
+@iconoma/cli/0.0.1-beta.1 linux-x64 node-v20.19.6
+$ iconoma --help [COMMAND]
+USAGE
+  $ iconoma COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`iconoma help [COMMAND]`](#iconoma-help-command)
+* [`iconoma plugins`](#iconoma-plugins)
+* [`iconoma plugins add PLUGIN`](#iconoma-plugins-add-plugin)
+* [`iconoma plugins:inspect PLUGIN...`](#iconoma-pluginsinspect-plugin)
+* [`iconoma plugins install PLUGIN`](#iconoma-plugins-install-plugin)
+* [`iconoma plugins link PATH`](#iconoma-plugins-link-path)
+* [`iconoma plugins remove [PLUGIN]`](#iconoma-plugins-remove-plugin)
+* [`iconoma plugins reset`](#iconoma-plugins-reset)
+* [`iconoma plugins uninstall [PLUGIN]`](#iconoma-plugins-uninstall-plugin)
+* [`iconoma plugins unlink [PLUGIN]`](#iconoma-plugins-unlink-plugin)
+* [`iconoma plugins update`](#iconoma-plugins-update)
+* [`iconoma studio`](#iconoma-studio)
+
+## `iconoma help [COMMAND]`
+
+Display help for iconoma.
+
+```
+USAGE
+  $ iconoma 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 iconoma.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_
+
+## `iconoma plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ iconoma plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ iconoma plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/index.ts)_
+
+## `iconoma plugins add PLUGIN`
+
+Installs a plugin into iconoma.
+
+```
+USAGE
+  $ iconoma 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 iconoma.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the ICONOMA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the ICONOMA_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ iconoma plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ iconoma plugins add myplugin
+
+  Install a plugin from a github url.
+
+    $ iconoma plugins add https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ iconoma plugins add someuser/someplugin
+```
+
+## `iconoma plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ iconoma 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
+  $ iconoma plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/inspect.ts)_
+
+## `iconoma plugins install PLUGIN`
+
+Installs a plugin into iconoma.
+
+```
+USAGE
+  $ iconoma 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 iconoma.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the ICONOMA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the ICONOMA_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ iconoma plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ iconoma plugins install myplugin
+
+  Install a plugin from a github url.
+
+    $ iconoma plugins install https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ iconoma plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/install.ts)_
+
+## `iconoma plugins link PATH`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ iconoma 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
+  $ iconoma plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/link.ts)_
+
+## `iconoma plugins remove [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ iconoma 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
+  $ iconoma plugins unlink
+  $ iconoma plugins remove
+
+EXAMPLES
+  $ iconoma plugins remove myplugin
+```
+
+## `iconoma plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ iconoma 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.4.54/src/commands/plugins/reset.ts)_
+
+## `iconoma plugins uninstall [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ iconoma 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
+  $ iconoma plugins unlink
+  $ iconoma plugins remove
+
+EXAMPLES
+  $ iconoma plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/uninstall.ts)_
+
+## `iconoma plugins unlink [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ iconoma 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
+  $ iconoma plugins unlink
+  $ iconoma plugins remove
+
+EXAMPLES
+  $ iconoma plugins unlink myplugin
+```
+
+## `iconoma plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ iconoma 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.4.54/src/commands/plugins/update.ts)_
+
+## `iconoma studio`
+
+Start the Iconoma Studio
+
+```
+USAGE
+  $ iconoma studio [-p <value>]
+
+FLAGS
+  -p, --port=<value>  port to listen on
+
+DESCRIPTION
+  Start the Iconoma Studio
+
+EXAMPLES
+  $ iconoma studio
+```
+
+_See code: [src/commands/studio.ts](https://github.com/theryston/iconoma/blob/v0.0.1-beta.1/src/commands/studio.ts)_
+<!-- commandsstop -->

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { execute } from "@oclif/core";
+
+await execute({ dir: import.meta.url });

package/dist/commands/studio.d.ts

@@ -0,0 +1,11 @@
+import { Command } from "@oclif/core";
+export default class Studio extends Command {
+    static args: {};
+    static description: string;
+    static examples: string[];
+    static flags: {
+        port: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}
+//# sourceMappingURL=studio.d.ts.map

package/dist/commands/studio.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"studio.d.ts","sourceRoot":"","sources":["../../src/commands/studio.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAS,MAAM,aAAa,CAAC;AAO7C,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,OAAO;IACzC,OAAgB,IAAI,KAAM;IAC1B,OAAgB,WAAW,SAA8B;IACzD,OAAgB,QAAQ,WAA2C;IACnE,OAAgB,KAAK;;MAEnB;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CA8BlC"}

package/dist/commands/studio.js

@@ -0,0 +1,34 @@
+import { Command, Flags } from "@oclif/core";
+import { getStudio } from "../get-studio.js";
+import figlet from "figlet";
+import gradient from "gradient-string";
+import { createSpinner } from "nanospinner";
+import open from "open";
+export default class Studio extends Command {
+    static args = {};
+    static description = "Start the Iconoma Studio";
+    static examples = ["<%= config.bin %> <%= command.id %>"];
+    static flags = {
+        port: Flags.string({ char: "p", description: "port to listen on" }),
+    };
+    async run() {
+        const { flags } = await this.parse(Studio);
+        const port = Number(flags.port) || undefined;
+        console.clear();
+        await new Promise((resolve) => setTimeout(resolve, 100));
+        const text = await figlet.text("Iconoma Studio");
+        const coolGradient = gradient(["#e5e5e5", "#1447e6"]);
+        console.log(coolGradient.multiline(text));
+        const spinner = createSpinner("Starting Studio...").start();
+        try {
+            const { createServer } = await getStudio();
+            const { url } = await createServer({ port });
+            await open(url, { wait: true });
+            spinner.success({ text: `Studio started at ${url}` });
+        }
+        catch {
+            spinner.error({ text: `Failed to start Studio` });
+            process.exit(1);
+        }
+    }
+}

package/dist/get-studio.d.ts

@@ -0,0 +1,9 @@
+export declare function getStudio(): Promise<{
+    createServer: (options: {
+        port?: number;
+    }) => Promise<{
+        url: string;
+        close: () => Promise<void>;
+    }>;
+}>;
+//# sourceMappingURL=get-studio.d.ts.map

package/dist/get-studio.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-studio.d.ts","sourceRoot":"","sources":["../src/get-studio.ts"],"names":[],"mappings":"AAAA,wBAAsB,SAAS,IAAI,OAAO,CAAC;IACzC,YAAY,EAAE,CAAC,OAAO,EAAE;QACtB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,KAAK,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC,CAAC;CAC5D,CAAC,CAGD"}

package/dist/get-studio.js

@@ -0,0 +1,4 @@
+export async function getStudio() {
+    const studioPath = "./studio/index.js";
+    return import(studioPath);
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { run } from '@oclif/core';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,EAAC,MAAM,aAAa,CAAA"}

package/dist/index.js

@@ -0,0 +1 @@
+export { run } from '@oclif/core';