@trayai/tray-sync-cli 0.0.6 → 0.0.8

package/README.md

@@ -11,12 +11,26 @@ CLI tool to clone tray projects and related assets on local machine which then c
 npm install -g @trayai/tray-sync-cli
 ```
 
-## Usage
-
-```bash
-tray --version
-tray --help
-```
+## CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `tray init -r <region> -w <workspace-id>` | Scaffold a new tray-sync-cli repository |
+| `tray pull` | Export tracked projects from Tray and materialise them on disk |
+| `tray promote <env>` | Reconstruct local projects and import them into a target Tray environment |
+| `tray status` | Local checksum-based drift detection (zero API calls) |
+| `tray project add <project-id>` | Track a project (project scope only) |
+| `tray project remove <project-id>` | Untrack a project and delete its local directory (project scope only) |
+| `tray project list` | List managed projects with directory names and last-pulled timestamps |
+| `tray env add <name>` | Add a target environment |
+| `tray env list` | List source and target environments with connectivity status |
+| `tray env remove <name>` | Remove a target environment and its per-project mappings |
+| `tray env resolve <env-name>` | Report unresolved auth requirements for a target env, with candidate matches |
+| `tray auth set -w <workspace-id> -r <region> -t <token>` | Set (or overwrite) a workspace's token |
+| `tray auth remove -w <workspace-id>` | Remove a workspace's stored token |
+| `tray auth list` | List workspaces with stored credentials |
+| `tray --version` | Print the installed CLI version |
+| `tray --help` | Show help for the CLI or a specific command |
 
 ## Getting started: a first promotion, end to end
 

package/dist/commands/env.js

@@ -18,9 +18,10 @@ import { OutputFormats, parseFormat } from "../lib/outputFormat.js";
 import { listWorkspaceAuthentications, matchAuthCandidates, prioritizeAuths, } from "../lib/authDiscovery.js";
 import { isFullyResolved, resolveProjectRequirements, } from "../lib/promoteTarget.js";
 import { checkProjectDrift, DriftStatuses } from "./status.js";
-import { printAddedEnvironment, printConnectivityCheck, printEnvAlreadyExists, printEnvNotConfigured, printEnvResolveProject, printEnvResolveProjectFullyResolved, printInvalidEnvName, printNoTargetEnvironments, printNoTokenSkippingConnectivity, printRemovedCredentials, printRemovedEnvironment, printEnvResolveProjectError, printRemovedMapping, printSourceEnvHeader, printSourceEnvLine, printTargetEnvHeader, printTargetEnvLine, printTokenNotSaved, printTrayYamlNotFound, } from "../views/env/env.js";
+import { printAddedEnvironment, printConnectivityCheck, printEnvAlreadyExists, printEnvNotConfigured, printEnvResolveProject, printEnvResolveProjectFullyResolved, printInvalidEnvName, printNoTargetEnvironments, printNoTokenSkippingConnectivity, printRemovedCredentials, printRemovedEnvironment, printEnvResolveProjectError, printRemovedMapping, printSourceEnvTable, printTargetEnvHeader, printTargetEnvTable, printTokenNotSaved, printTrayYamlNotFound, } from "../views/env/env.v2.js";
 import { printEnvListJson, printEnvResolveResultJson, } from "../views/env/shared.js";
-import { printError, printInvalidAuthMappings, printLocalDrift, printNoTargetProjectMapped, printProjectError, printProjectNoStateFile, printProjectNotPulledLocally, printTargetEnvNotFound, } from "../views/promote/promote.js";
+import { printError, printInvalidAuthMappings, printLocalDrift, printNoTargetProjectMapped, printProjectError, printProjectNoStateFile, printProjectNotPulledLocally, printTargetEnvNotFound, } from "../views/promote/promote.v2.js";
+import { FAILURE_ICON, SUCCESS_ICON } from "../views/icons.js";
 const ENV_NAME_RE = /^[a-zA-Z0-9_-]+$/;
 function emptyMapping() {
     return { authentications: {}, config: {}, connectors: [], services: [] };
@@ -46,11 +47,11 @@ async function checkConnectivity(deps, region, workspaceId, tokenFlag) {
 function describeConnectivity(result) {
     switch (result.status) {
         case "ok":
-            return "✅ connected";
+            return `${SUCCESS_ICON} connected`;
         case "no-token":
-            return "no token available";
+            return `${FAILURE_ICON} no token available`;
         case "failed":
-            return `❌ (${result.message})`;
+            return `${FAILURE_ICON} ${result.message}`;
     }
 }
 export async function runEnvAdd(deps, options) {
@@ -128,19 +129,25 @@ export async function runEnvList(deps, options) {
         });
         return 0;
     }
-    printSourceEnvHeader(stdout);
     const sourceResult = await checkConnectivity(deps, trayYaml.region, trayYaml.workspace_id);
-    printSourceEnvLine(stdout, describeRegion(trayYaml.region), trayYaml.workspace_id, describeConnectivity(sourceResult));
+    printSourceEnvTable(stdout, describeRegion(trayYaml.region), trayYaml.workspace_id, describeConnectivity(sourceResult));
     printTargetEnvHeader(stdout);
     if (names.length === 0) {
         printNoTargetEnvironments(stdout);
         return 0;
     }
+    const targetRows = [];
     for (const name of names) {
         const entry = environments.environments[name];
         const result = await checkConnectivity(deps, entry.region, entry.workspace_id);
-        printTargetEnvLine(stdout, name, describeRegion(entry.region), entry.workspace_id, describeConnectivity(result));
+        targetRows.push({
+            name,
+            regionDescription: describeRegion(entry.region),
+            workspaceId: entry.workspace_id,
+            connectivityDescription: describeConnectivity(result),
+        });
     }
+    printTargetEnvTable(stdout, targetRows);
     return 0;
 }
 export async function runEnvRemove(deps, options) {

package/dist/commands/promote.js

@@ -18,7 +18,7 @@ import { resolveToken } from "../lib/tokenResolution.js";
 import { isUuid } from "../lib/uuid.js";
 import { OutputFormats, parseFormat } from "../lib/outputFormat.js";
 import { checkProjectDrift, DriftStatuses } from "./status.js";
-import { printError, printInvalidAuthMappings, printLocalDrift, printMutuallyExclusiveResumeAndProject, printNoTargetProjectMapped, printProjectError, printProjectNoStateFile, printProjectNotPulledLocally, printPromoted, printTargetEnvNotFound, printTrayYamlNotFound, printUnresolvedRequirements, } from "../views/promote/promote.js";
+import { printError, printInvalidAuthMappings, printLocalDrift, printMutuallyExclusiveResumeAndProject, printNoTargetProjectMapped, printProjectError, printProjectNoStateFile, printProjectNotPulledLocally, printPromoted, printTargetEnvNotFound, printTrayYamlNotFound, printUnresolvedRequirements, } from "../views/promote/promote.v2.js";
 import { printPromoteResultJson } from "../views/promote/shared.js";
 function findProjectDir(existingDirs, projectId) {
     return existingDirs.find((name) => name.split("--")[0] === projectId);

package/dist/views/env/env.v2.js

@@ -0,0 +1,115 @@
+import ansis from "ansis";
+import Table from "cli-table3";
+import { FAILURE_ICON, INFO_ICON, WARNING_ICON } from "../icons.js";
+export function printInvalidEnvName(stderr, nameRe, name) {
+    stderr(`${FAILURE_ICON} Environment name must match ${nameRe}: "${name}"`);
+}
+export function printEnvAlreadyExists(stderr, name) {
+    stderr(`${FAILURE_ICON} Environment "${ansis.bold(name)}" already exists. Run \`${ansis.bold("tray env remove")}\` first to replace it.`);
+}
+export function printAddedEnvironment(stdout, name, regionDescription, workspaceId) {
+    const table = new Table({
+        head: ["Environment", "Region", "Workspace ID"].map((h) => ansis.bold(h)),
+        style: { head: [] },
+    });
+    table.push([ansis.bold(name), regionDescription, workspaceId]);
+    stdout(table.toString());
+}
+export function printTokenNotSaved(stderr, workspaceId) {
+    stderr(`${WARNING_ICON} ${ansis.bold("--token")} was NOT saved: credentials.json already has a token for workspace ${workspaceId}, and the existing one was kept.\n` +
+        `    Re-run this same \`${ansis.bold("tray env add")}\` command with ${ansis.bold("--force-token")} to replace it with the ${ansis.bold("--token")} you just provided.`);
+}
+export function printNoTokenSkippingConnectivity(stdout) {
+    stdout(`${WARNING_ICON} No token available — skipping connectivity check.`);
+}
+const LEADING_STATUS_MARKER_RE = /^((?:\x1b\[[0-9;]*m)*[✓✗](?:\x1b\[[0-9;]*m)*)\s*/;
+export function printConnectivityCheck(stdout, description) {
+    const match = description.match(LEADING_STATUS_MARKER_RE);
+    if (match) {
+        stdout(`${match[1]} Connectivity check: ${description.slice(match[0].length)}`);
+        return;
+    }
+    stdout(`Connectivity check: ${description}`);
+}
+export function printTrayYamlNotFound(stderr) {
+    stderr(`${FAILURE_ICON} tray.yaml not found. Run \`${ansis.bold("tray init")}\` first.`);
+}
+function envTable() {
+    return new Table({
+        head: ["Environment", "Region", "Workspace ID", "Status"].map((h) => ansis.bold(h)),
+        style: { head: [] },
+    });
+}
+export function printSourceEnvTable(stdout, regionDescription, workspaceId, connectivityDescription) {
+    stdout(ansis.bold("SOURCE ENV"));
+    const table = envTable();
+    table.push([ansis.bold("source"), regionDescription, workspaceId, connectivityDescription]);
+    stdout(table.toString());
+}
+export function printTargetEnvHeader(stdout) {
+    stdout("");
+    stdout(ansis.bold("TARGET ENV"));
+}
+export function printNoTargetEnvironments(stdout) {
+    stdout(`${INFO_ICON} No target environments configured.`);
+}
+export function printTargetEnvTable(stdout, rows) {
+    const table = envTable();
+    for (const row of rows) {
+        table.push([ansis.bold(row.name), row.regionDescription, row.workspaceId, row.connectivityDescription]);
+    }
+    stdout(table.toString());
+}
+export function printEnvNotConfigured(stdout, name) {
+    stdout(`${INFO_ICON} Environment "${ansis.bold(name)}" is not configured. Nothing to remove.`);
+}
+export function printRemovedEnvironment(stdout, name) {
+    stdout(`${ansis.bold("Removed")} environment "${ansis.bold(name)}" from environments.json.`);
+}
+export function printRemovedMapping(stdout, name, dirName) {
+    stdout(`${ansis.bold("Removed")} "${ansis.bold(name)}" mapping from ${dirName}/mappings.json.`);
+}
+export function printRemovedCredentials(stdout, workspaceId) {
+    stdout(`${ansis.bold("Removed")} credentials for workspace ${workspaceId}.`);
+}
+export function printEnvResolveProjectFullyResolved(stdout, projectId, sourceProjectName) {
+    stdout(`${ansis.bold(`${sourceProjectName} (${projectId})`)}: fully resolved, nothing to do`);
+}
+export function printEnvResolveProjectError(stdout, projectId, sourceProjectName, error) {
+    stdout(`${ansis.bold(`${sourceProjectName} (${projectId})`)}:`);
+    if (error.reason === "no_target_project_mapped") {
+        stdout(`  no target project mapped yet — see ${error.mappingsPath}`);
+        return;
+    }
+    if (error.reason === "project_error") {
+        const target = error.targetProjectId ? ` (target project ${error.targetProjectId})` : "";
+        stdout(`  ${error.message}${target}`);
+        return;
+    }
+    stdout(`  invalid authentication mappings:`);
+    for (const invalid of error.invalidAuthMappings) {
+        stdout(`    ${invalid.authExportId}: "${invalid.value}" is not a valid target authentication id`);
+    }
+}
+export function printEnvResolveProject(stdout, project) {
+    stdout(`${ansis.bold(`${project.sourceProjectName} (${project.projectId})`)}:`);
+    for (const auth of project.autoResolvedAuthentications) {
+        stdout(`  auto-resolved: ${auth.title} -> "${auth.chosen.name}" (id: ${auth.chosen.id}, ${auth.chosen.matchKind} match), written to mappings.json`);
+    }
+    for (const auth of project.unresolvedAuthentications) {
+        stdout(`  unresolved: ${auth.title} (${auth.service.name} v${auth.service.version})`);
+        if (auth.candidates.length === 0) {
+            stdout(`    no candidates found in the target workspace`);
+        }
+        for (const candidate of auth.candidates) {
+            stdout(`    candidate (${candidate.matchKind}): "${candidate.name}" (id: ${candidate.id}, created ${candidate.created})`);
+        }
+        stdout(`    to resolve: set mappings.json's environments.<env>.authentications["${auth.authExportId}"] to a target auth id${auth.candidates.length > 0
+            ? `, or re-run with ${ansis.bold("--auto-resolve")} to pick the top candidate automatically`
+            : ""}`);
+    }
+    if (project.hasNewConfigKeys) {
+        stdout(`  new config keys require mapping — see mappings.json's config entry`);
+    }
+}
+//# sourceMappingURL=env.v2.js.map

package/dist/views/icons.js

@@ -0,0 +1,6 @@
+import ansis from "ansis";
+export const SUCCESS_ICON = ansis.bold.green("✓");
+export const FAILURE_ICON = ansis.bold.red("✗");
+export const WARNING_ICON = ansis.bold.hex("#D98C2B")("(!)");
+export const INFO_ICON = ansis.bold.hex("#5C7A99")("(i)");
+//# sourceMappingURL=icons.js.map

package/dist/views/promote/promote.v2.js

@@ -0,0 +1,46 @@
+import ansis from "ansis";
+import { FAILURE_ICON } from "../icons.js";
+import { printIssueBlock } from "../shared.js";
+export function printMutuallyExclusiveResumeAndProject(stderr) {
+    stderr("--resume and --project are mutually exclusive.");
+}
+export function printTrayYamlNotFound(stderr) {
+    stderr("tray.yaml not found. Run `tray init` first.");
+}
+export function printTargetEnvNotFound(stderr, envName) {
+    stderr(`${FAILURE_ICON} Target environment "${ansis.bold(envName)}" not found. Run \`${ansis.bold(`tray env add ${envName} ...`)}\` first.`);
+}
+export function printError(stderr, message) {
+    stderr(message);
+}
+export function printProjectNotPulledLocally(stderr, projectId) {
+    stderr(`Project ${projectId} has not been pulled locally. Run \`tray pull\` first.`);
+}
+export function printProjectNoStateFile(stderr, projectId) {
+    stderr(`Project ${projectId} has no state.json. Run \`tray pull\` first.`);
+}
+export function printLocalDrift(stderr, projectId, dirName, dirty) {
+    printIssueBlock(stderr, `Project ${projectId} (${dirName}) has local drift; refusing to promote:`, dirty.map((d) => `${d.status}\t${d.path}`), "Run `tray pull` to refresh, or resolve the drift, then retry.");
+}
+export function printNoTargetProjectMapped(stderr, sourceProjectName, projectId, envName, mappingsPath) {
+    stderr(`"${sourceProjectName}" (${projectId}) has no target project mapped for "${envName}".`);
+    stderr(`Fill in target_project_id in ${mappingsPath}, or re-run with --auto-create-projects.`);
+}
+export function printInvalidAuthMappings(stderr, projectId, sourceProjectName, invalidAuthMappings) {
+    printIssueBlock(stderr, `Project ${projectId} (${sourceProjectName}) has unresolved authentication mappings:`, invalidAuthMappings.map((invalid) => `${invalid.authExportId}: "${invalid.value}" is not a valid target authentication id`), "Fill in a real target authentication id for each entry above, then retry.");
+}
+export function printUnresolvedRequirements(stderr, projectId, sourceProjectName, envName, unresolved) {
+    const bulletLines = unresolved.unresolvedAuthentications.map((auth) => `unresolved authentication: ${auth.title} (${auth.authExportId})`);
+    if (unresolved.hasNewConfigKeys) {
+        bulletLines.push("new config keys require mapping");
+    }
+    printIssueBlock(stderr, `Project ${projectId} (${sourceProjectName}) has unresolved import requirements:`, bulletLines, `Run \`tray env resolve ${envName}\` to resolve, then retry.`);
+}
+export function printPromoted(stdout, projectId, sourceProjectName, envName) {
+    stdout(`Promoted project ${projectId} (${sourceProjectName}) to "${envName}"`);
+}
+export function printProjectError(stderr, projectId, sourceProjectName, message, targetProjectId) {
+    const target = targetProjectId ? ` -> target project ${targetProjectId}` : "";
+    stderr(`Project ${projectId} (${sourceProjectName})${target}: ${message}`);
+}
+//# sourceMappingURL=promote.v2.js.map

package/node_modules/@colors/colors/LICENSE

@@ -0,0 +1,26 @@
+MIT License
+
+Original Library
+  - Copyright (c) Marak Squires
+
+Additional Functionality
+ - Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+ - Copyright (c) DABH (https://github.com/DABH)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/node_modules/@colors/colors/README.md

@@ -0,0 +1,219 @@
+# @colors/colors ("colors.js")
+[![Build Status](https://github.com/DABH/colors.js/actions/workflows/ci.yml/badge.svg)](https://github.com/DABH/colors.js/actions/workflows/ci.yml)
+[![version](https://img.shields.io/npm/v/@colors/colors.svg)](https://www.npmjs.org/package/@colors/colors)
+
+Please check out the [roadmap](ROADMAP.md) for upcoming features and releases.  Please open Issues to provide feedback.
+
+## get color and style in your node.js console
+
+![Demo](https://raw.githubusercontent.com/DABH/colors.js/master/screenshots/colors.png)
+
+## Installation
+
+    npm install @colors/colors
+
+## colors and styles!
+
+### text colors
+
+  - black
+  - red
+  - green
+  - yellow
+  - blue
+  - magenta
+  - cyan
+  - white
+  - gray
+  - grey
+
+### bright text colors
+
+  - brightRed
+  - brightGreen
+  - brightYellow
+  - brightBlue
+  - brightMagenta
+  - brightCyan
+  - brightWhite
+
+### background colors
+
+  - bgBlack
+  - bgRed
+  - bgGreen
+  - bgYellow
+  - bgBlue
+  - bgMagenta
+  - bgCyan
+  - bgWhite
+  - bgGray
+  - bgGrey
+
+### bright background colors
+
+  - bgBrightRed
+  - bgBrightGreen
+  - bgBrightYellow
+  - bgBrightBlue
+  - bgBrightMagenta
+  - bgBrightCyan
+  - bgBrightWhite
+
+### styles
+
+  - reset
+  - bold
+  - dim
+  - italic
+  - underline
+  - inverse
+  - hidden
+  - strikethrough
+
+### extras
+
+  - rainbow
+  - zebra
+  - america
+  - trap
+  - random
+
+
+## Usage
+
+By popular demand, `@colors/colors` now ships with two types of usages!
+
+The super nifty way
+
+```js
+var colors = require('@colors/colors');
+
+console.log('hello'.green); // outputs green text
+console.log('i like cake and pies'.underline.red); // outputs red underlined text
+console.log('inverse the color'.inverse); // inverses the color
+console.log('OMG Rainbows!'.rainbow); // rainbow
+console.log('Run the trap'.trap); // Drops the bass
+
+```
+
+or a slightly less nifty way which doesn't extend `String.prototype`
+
+```js
+var colors = require('@colors/colors/safe');
+
+console.log(colors.green('hello')); // outputs green text
+console.log(colors.red.underline('i like cake and pies')); // outputs red underlined text
+console.log(colors.inverse('inverse the color')); // inverses the color
+console.log(colors.rainbow('OMG Rainbows!')); // rainbow
+console.log(colors.trap('Run the trap')); // Drops the bass
+
+```
+
+I prefer the first way. Some people seem to be afraid of extending `String.prototype` and prefer the second way. 
+
+If you are writing good code you will never have an issue with the first approach. If you really don't want to touch `String.prototype`, the second usage will not touch `String` native object.
+
+## Enabling/Disabling Colors
+
+The package will auto-detect whether your terminal can use colors and enable/disable accordingly. When colors are disabled, the color functions do nothing. You can override this with a command-line flag:
+
+```bash
+node myapp.js --no-color
+node myapp.js --color=false
+
+node myapp.js --color
+node myapp.js --color=true
+node myapp.js --color=always
+
+FORCE_COLOR=1 node myapp.js
+```
+
+Or in code:
+
+```javascript
+var colors = require('@colors/colors');
+colors.enable();
+colors.disable();
+```
+
+## Console.log [string substitution](http://nodejs.org/docs/latest/api/console.html#console_console_log_data)
+
+```js
+var name = 'Beowulf';
+console.log(colors.green('Hello %s'), name);
+// outputs -> 'Hello Beowulf'
+```
+
+## Custom themes
+
+### Using standard API
+
+```js
+
+var colors = require('@colors/colors');
+
+colors.setTheme({
+  silly: 'rainbow',
+  input: 'grey',
+  verbose: 'cyan',
+  prompt: 'grey',
+  info: 'green',
+  data: 'grey',
+  help: 'cyan',
+  warn: 'yellow',
+  debug: 'blue',
+  error: 'red'
+});
+
+// outputs red text
+console.log("this is an error".error);
+
+// outputs yellow text
+console.log("this is a warning".warn);
+```
+
+### Using string safe API
+
+```js
+var colors = require('@colors/colors/safe');
+
+// set single property
+var error = colors.red;
+error('this is red');
+
+// set theme
+colors.setTheme({
+  silly: 'rainbow',
+  input: 'grey',
+  verbose: 'cyan',
+  prompt: 'grey',
+  info: 'green',
+  data: 'grey',
+  help: 'cyan',
+  warn: 'yellow',
+  debug: 'blue',
+  error: 'red'
+});
+
+// outputs red text
+console.log(colors.error("this is an error"));
+
+// outputs yellow text
+console.log(colors.warn("this is a warning"));
+
+```
+
+### Combining Colors
+
+```javascript
+var colors = require('@colors/colors');
+
+colors.setTheme({
+  custom: ['red', 'underline']
+});
+
+console.log('test'.custom);
+```
+
+*Protip: There is a secret undocumented style in `colors`. If you find the style you can summon him.*

package/node_modules/@colors/colors/examples/normal-usage.js

@@ -0,0 +1,83 @@
+var colors = require('../lib/index');
+
+console.log('First some yellow text'.yellow);
+
+console.log('Underline that text'.yellow.underline);
+
+console.log('Make it bold and red'.red.bold);
+
+console.log(('Double Raindows All Day Long').rainbow);
+
+console.log('Drop the bass'.trap);
+
+console.log('DROP THE RAINBOW BASS'.trap.rainbow);
+
+// styles not widely supported
+console.log('Chains are also cool.'.bold.italic.underline.red);
+
+// styles not widely supported
+console.log('So '.green + 'are'.underline + ' ' + 'inverse'.inverse
+  + ' styles! '.yellow.bold);
+console.log('Zebras are so fun!'.zebra);
+
+//
+// Remark: .strikethrough may not work with Mac OS Terminal App
+//
+console.log('This is ' + 'not'.strikethrough + ' fun.');
+
+console.log('Background color attack!'.black.bgWhite);
+console.log('Use random styles on everything!'.random);
+console.log('America, Heck Yeah!'.america);
+
+// eslint-disable-next-line max-len
+console.log('Blindingly '.brightCyan + 'bright? '.brightRed + 'Why '.brightYellow + 'not?!'.brightGreen);
+
+console.log('Setting themes is useful');
+
+//
+// Custom themes
+//
+console.log('Generic logging theme as JSON'.green.bold.underline);
+// Load theme with JSON literal
+colors.setTheme({
+  silly: 'rainbow',
+  input: 'grey',
+  verbose: 'cyan',
+  prompt: 'grey',
+  info: 'green',
+  data: 'grey',
+  help: 'cyan',
+  warn: 'yellow',
+  debug: 'blue',
+  error: 'red',
+});
+
+// outputs red text
+console.log('this is an error'.error);
+
+// outputs yellow text
+console.log('this is a warning'.warn);
+
+// outputs grey text
+console.log('this is an input'.input);
+
+console.log('Generic logging theme as file'.green.bold.underline);
+
+// Load a theme from file
+try {
+  colors.setTheme(require(__dirname + '/../themes/generic-logging.js'));
+} catch (err) {
+  console.log(err);
+}
+
+// outputs red text
+console.log('this is an error'.error);
+
+// outputs yellow text
+console.log('this is a warning'.warn);
+
+// outputs grey text
+console.log('this is an input'.input);
+
+// console.log("Don't summon".zalgo)
+

package/node_modules/@colors/colors/examples/safe-string.js

@@ -0,0 +1,80 @@
+var colors = require('../safe');
+
+console.log(colors.yellow('First some yellow text'));
+
+console.log(colors.yellow.underline('Underline that text'));
+
+console.log(colors.red.bold('Make it bold and red'));
+
+console.log(colors.rainbow('Double Raindows All Day Long'));
+
+console.log(colors.trap('Drop the bass'));
+
+console.log(colors.rainbow(colors.trap('DROP THE RAINBOW BASS')));
+
+// styles not widely supported
+console.log(colors.bold.italic.underline.red('Chains are also cool.'));
+
+// styles not widely supported
+console.log(colors.green('So ') + colors.underline('are') + ' '
+  + colors.inverse('inverse') + colors.yellow.bold(' styles! '));
+
+console.log(colors.zebra('Zebras are so fun!'));
+
+console.log('This is ' + colors.strikethrough('not') + ' fun.');
+
+
+console.log(colors.black.bgWhite('Background color attack!'));
+console.log(colors.random('Use random styles on everything!'));
+console.log(colors.america('America, Heck Yeah!'));
+
+// eslint-disable-next-line max-len
+console.log(colors.brightCyan('Blindingly ') + colors.brightRed('bright? ') + colors.brightYellow('Why ') + colors.brightGreen('not?!'));
+
+console.log('Setting themes is useful');
+
+//
+// Custom themes
+//
+// console.log('Generic logging theme as JSON'.green.bold.underline);
+// Load theme with JSON literal
+colors.setTheme({
+  silly: 'rainbow',
+  input: 'blue',
+  verbose: 'cyan',
+  prompt: 'grey',
+  info: 'green',
+  data: 'grey',
+  help: 'cyan',
+  warn: 'yellow',
+  debug: 'blue',
+  error: 'red',
+});
+
+// outputs red text
+console.log(colors.error('this is an error'));
+
+// outputs yellow text
+console.log(colors.warn('this is a warning'));
+
+// outputs blue text
+console.log(colors.input('this is an input'));
+
+
+// console.log('Generic logging theme as file'.green.bold.underline);
+
+// Load a theme from file
+colors.setTheme(require(__dirname + '/../themes/generic-logging.js'));
+
+// outputs red text
+console.log(colors.error('this is an error'));
+
+// outputs yellow text
+console.log(colors.warn('this is a warning'));
+
+// outputs grey text
+console.log(colors.input('this is an input'));
+
+// console.log(colors.zalgo("Don't summon him"))
+
+