@sapphire/cli 1.2.1-next.ff0796a.0 → 1.3.0-next.b97aeac.0

package/dist/commands/generate.js

@@ -1,8 +1,8 @@
 import { componentsFolder } from '#constants';
 import { CreateFileFromTemplate } from '#functions/CreateFileFromTemplate';
 import { fileExists } from '#functions/FileExists';
-import { Spinner } from '#functions/Spinner';
-import { fromAsync, isErr } from '@sapphire/result';
+import { Spinner } from '@favware/colorette-spinner';
+import { Result } from '@sapphire/result';
 import { blueBright, red } from 'colorette';
 import findUp from 'find-up';
 import { load } from 'js-yaml';
@@ -38,8 +38,7 @@ export default async (component, name) => {
     const spinner = new Spinner(`Creating a ${component.toLowerCase()}`).start();
     const fail = (error, additionalExecution) => {
         spinner.error({ text: error });
-        if (additionalExecution)
-            additionalExecution();
+        additionalExecution?.();
         process.exit(1);
     };
     const configLoc = await fetchConfig();
@@ -50,12 +49,14 @@ export default async (component, name) => {
     if (!config) {
         return fail("Can't parse the Sapphire CLI config.");
     }
-    const result = await fromAsync(async () => createComponent(component, name, config, configLoc.replace(/.sapphirerc.(json|yml)/g, '')));
-    if (isErr(result)) {
-        return fail(result.error.message, () => console.log(red(result.error.message)));
-    }
-    spinner.success();
-    console.log(blueBright('Done!'));
-    process.exit(0);
+    const result = await Result.fromAsync(() => createComponent(component, name, config, configLoc.replace(/.sapphirerc.(json|yml)/g, '')));
+    return result.match({
+        ok: () => {
+            spinner.success();
+            console.log(blueBright('Done!'));
+            process.exit(0);
+        },
+        err: (error) => fail(error.message, () => console.log(red(error.message)))
+    });
 };
 //# sourceMappingURL=generate.js.map

package/dist/commands/new.js

@@ -2,9 +2,9 @@ import { repoUrl } from '#constants';
 import { CommandExists } from '#functions/CommandExists';
 import { CreateFileFromTemplate } from '#functions/CreateFileFromTemplate';
 import { fileExists } from '#functions/FileExists';
-import { Spinner } from '#functions/Spinner';
 import { PromptNew } from '#prompts/PromptNew';
-import { fromAsync, isErr, isOk } from '@sapphire/result';
+import { Spinner } from '@favware/colorette-spinner';
+import { Result } from '@sapphire/result';
 import { blueBright, red } from 'colorette';
 import { execa } from 'execa';
 import { cp, readFile, rm, writeFile } from 'node:fs/promises';
@@ -16,18 +16,15 @@ async function editPackageJson(location, name) {
     if (!output)
         throw new Error("Can't read file.");
     output.name = name;
-    const result = await fromAsync(() => writeFile(pjLocation, JSON.stringify(output, null, 2)));
-    return isOk(result);
+    const result = await Result.fromAsync(() => writeFile(pjLocation, JSON.stringify(output, null, 2)));
+    return result.isOk();
 }
 async function installDeps(location, pm, verbose) {
-    const result = await fromAsync(() => execa(pm.toLowerCase(), ['install'], {
+    const value = await execa(pm.toLowerCase(), ['install'], {
         stdio: verbose ? 'inherit' : undefined,
         cwd: `./${location}/`
-    }));
-    if (isErr(result)) {
-        throw result.error;
-    }
-    if (result.value.exitCode !== 0) {
+    });
+    if (value.exitCode !== 0) {
         throw new Error('An unknown error occurred while installing the dependencies. Try running Sapphire CLI with "--verbose" flag.');
     }
     const oppositeLockfile = `./${location}/${pm === 'npm' ? 'yarn.lock' : 'package-lock.json'}`;
@@ -41,14 +38,11 @@ async function configureYarnRc(location, name, value) {
     return true;
 }
 async function installYarnV3(location, verbose) {
-    const result = await fromAsync(() => execa('yarn', ['set', 'version', 'berry'], {
+    const value = await execa('yarn', ['set', 'version', 'berry'], {
         stdio: verbose ? 'inherit' : undefined,
         cwd: `./${location}/`
-    }));
-    if (isErr(result)) {
-        throw result.error;
-    }
-    if (result.value.exitCode !== 0) {
+    });
+    if (value.exitCode !== 0) {
         throw new Error('An unknown error occurred while installing Yarn v3. Try running Sapphire CLI with "--verbose" flag.');
     }
     await Promise.all([
@@ -68,23 +62,22 @@ async function initializeGitRepo(location) {
 }
 async function runJob(job, name) {
     const spinner = new Spinner(name).start();
-    const result = await fromAsync(async () => job());
-    if (isErr(result)) {
-        spinner.error({ text: red(result.error.message) });
-        console.error(red(result.error.message));
-        throw result.error;
-    }
-    spinner.success();
-    return true;
+    const result = await Result.fromAsync(() => job());
+    return result.match({
+        ok: () => {
+            spinner.success();
+            return true;
+        },
+        err: (error) => {
+            spinner.error({ text: red(error.message) });
+            console.error(red(error.message));
+            throw error;
+        }
+    });
 }
 async function cloneRepo(location, verbose) {
-    const result = await fromAsync(async () => execa('git', ['clone', repoUrl, `${location}/ghr`], {
-        stdio: verbose ? 'inherit' : undefined
-    }));
-    if (isErr(result)) {
-        throw result.error;
-    }
-    if (result.value.exitCode !== 0) {
+    const value = await execa('git', ['clone', repoUrl, `${location}/ghr`], { stdio: verbose ? 'inherit' : undefined });
+    if (value.exitCode !== 0) {
         throw new Error('An unknown error occurred while cloning the repository. Try running Sapphire CLI with "--verbose" flag.');
     }
     return true;

package/dist/functions/CommandExists.js

@@ -22,14 +22,14 @@
     SOFTWARE.
 */
 import { fileExists } from '#functions/FileExists';
-import { fromAsync, isErr } from '@sapphire/result';
+import { Result } from '@sapphire/result';
 import { execa } from 'execa';
 import { constants } from 'node:fs';
 import { access } from 'node:fs/promises';
 const windows = process.platform === 'win32';
 async function isExecutable(command) {
-    const result = await fromAsync(() => access(command, constants.X_OK));
-    return isErr(result);
+    const result = await Result.fromAsync(() => access(command, constants.X_OK));
+    return result.isErr();
 }
 function cleanWindowsCommand(input) {
     if (/[^A-Za-z0-9_\/:=-]/.test(input)) {
@@ -44,22 +44,22 @@ async function commandExistsUnix(command) {
             return true;
         }
     }
-    const result = await fromAsync(() => execa('which', [command]));
-    if (isErr(result)) {
-        return false;
-    }
-    return Boolean(result.value.stdout);
+    const result = await Result.fromAsync(() => execa('which', [command]));
+    return result.match({
+        err: () => false,
+        ok: (value) => Boolean(value.stdout)
+    });
 }
 const invalidWindowsCommandNameRegex = /[\x00-\x1f<>:"|?*]/;
 async function commandExistsWindows(command) {
     if (invalidWindowsCommandNameRegex.test(command)) {
         return false;
     }
-    const result = await fromAsync(async () => execa('where', [cleanWindowsCommand(command)]));
-    if (isErr(result)) {
-        return fileExists(command);
-    }
-    return true;
+    const result = await Result.fromAsync(async () => execa('where', [cleanWindowsCommand(command)]));
+    return result.match({
+        err: () => fileExists(command),
+        ok: () => true
+    });
 }
 export async function CommandExists(command) {
     return windows ? commandExistsWindows(command) : commandExistsUnix(command);

package/dist/functions/FileExists.js

@@ -1,7 +1,7 @@
-import { fromAsync, isOk } from '@sapphire/result';
+import { Result } from '@sapphire/result';
 import { access } from 'node:fs/promises';
 export async function fileExists(filePath) {
-    const result = await fromAsync(() => access(filePath));
-    return isOk(result);
+    const result = await Result.fromAsync(() => access(filePath));
+    return result.isOk();
 }
 //# sourceMappingURL=FileExists.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire/cli",
-  "version": "1.2.1-next.ff0796a.0",
+  "version": "1.3.0-next.b97aeac.0",
   "description": "CLI for Sapphire Framework",
   "author": "@sapphire",
   "license": "MIT",
@@ -38,9 +38,10 @@
     "postpack": "pinst --enable"
   },
   "dependencies": {
-    "@sapphire/result": "^1.1.1",
-    "colorette": "^2.0.16",
-    "commander": "^9.2.0",
+    "@favware/colorette-spinner": "^1.0.0",
+    "@sapphire/result": "^2.0.1",
+    "colorette": "^2.0.19",
+    "commander": "^9.4.0",
     "execa": "^6.1.0",
     "find-up": "^5.0.0",
     "js-yaml": "^4.1.0",
@@ -48,30 +49,30 @@
     "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.3.0",
-    "@commitlint/config-conventional": "^16.2.4",
-    "@favware/cliff-jumper": "^1.8.0",
+    "@commitlint/cli": "^17.0.3",
+    "@commitlint/config-conventional": "^17.0.3",
+    "@favware/cliff-jumper": "^1.8.5",
     "@favware/npm-deprecate": "^1.0.4",
-    "@sapphire/eslint-config": "^4.3.5",
+    "@sapphire/eslint-config": "^4.3.7",
     "@sapphire/prettier-config": "^1.4.3",
     "@sapphire/ts-config": "^3.3.4",
     "@types/js-yaml": "^4.0.5",
-    "@types/node": "^17.0.33",
-    "@types/prompts": "^2.0.14",
-    "@typescript-eslint/eslint-plugin": "^5.23.0",
-    "@typescript-eslint/parser": "^5.23.0",
+    "@types/node": "^18.0.1",
+    "@types/prompts": "^2.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.30.7",
+    "@typescript-eslint/parser": "^5.30.7",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^8.15.0",
+    "eslint": "^8.20.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "globby": "^13.1.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "globby": "^13.1.2",
     "husky": "^8.0.1",
-    "lint-staged": "^12.4.1",
+    "lint-staged": "^13.0.3",
     "pinst": "^3.0.0",
-    "prettier": "^2.6.2",
+    "prettier": "^2.7.1",
     "pretty-quick": "^3.1.3",
-    "ts-node": "^10.7.0",
-    "typescript": "^4.6.4"
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
   },
   "resolutions": {
     "ansi-regex": "^5.0.1",
@@ -116,5 +117,5 @@
     "access": "public"
   },
   "prettier": "@sapphire/prettier-config",
-  "packageManager": "yarn@3.2.1"
+  "packageManager": "yarn@3.2.2"
 }

package/templates/components/contextmenucommand.js.sapphire

@@ -0,0 +1,25 @@
+{ "category": "commands" }
+---
+const { Command } = require('@sapphire/framework')
+
+class UserCommand extends Command {
+    constructor(context, options) {
+        super(context, {
+            ...options,
+			name: 'command'
+        });
+    }
+
+    registerApplicationCommands(registry) {
+		registry.registerContextMenuCommand({
+			name: this.name,
+			type: 'MESSAGE'
+		})
+	}
+
+	async contextMenuRun(interaction) {
+		return await interaction.reply({content: "Hello world!"})
+	}
+}
+
+exports.UserCommand = UserCommand;

package/templates/components/contextmenucommand.ts.sapphire

@@ -0,0 +1,20 @@
+{ "category": "commands" }
+---
+import { ApplyOptions } from '@sapphire/decorators';
+import { Command } from '@sapphire/framework';
+
+@ApplyOptions<Command.Options>({
+	description: 'A basic contextMenu command'
+})
+export class UserCommand extends Command {
+	public override registerApplicationCommands(registry: Command.Registry) {
+		registry.registerContextMenuCommand({
+			name: this.name,
+			type: 'MESSAGE'
+		})
+	}
+
+	public async contextMenuRun(interaction: Command.ContextMenuInteraction) {
+		return await interaction.reply({content: "Hello world!"});
+	}
+}

package/templates/components/slashcommand.js.sapphire

@@ -0,0 +1,26 @@
+{ "category": "commands" }
+---
+const { Command } = require('@sapphire/framework')
+
+class UserCommand extends Command {
+    constructor(context, options) {
+        super(context, {
+            ...options,
+			name: 'command',
+			description: 'A basic slash command'
+        });
+    }
+
+    registerApplicationCommands(registry) {
+		registry.registerChatInputCommand({
+			name: this.name,
+			description: this.description
+		})
+	}
+
+	async chatInputRun(interaction) {
+		return await interaction.reply({content: "Hello world!"})
+	}
+}
+
+exports.UserCommand = UserCommand;

package/templates/components/slashcommand.ts.sapphire

@@ -0,0 +1,20 @@
+{ "category": "commands" }
+---
+import { ApplyOptions } from '@sapphire/decorators';
+import { Command } from '@sapphire/framework';
+
+@ApplyOptions<Command.Options>({
+	description: 'A basic slash command'
+})
+export class UserCommand extends Command {
+	public override registerApplicationCommands(registry: Command.Registry) {
+		registry.registerChatInputCommand({
+			name: this.name,
+			description: this.description
+		})
+	}
+
+	public async chatInputRun(interaction: Command.ChatInputInteraction) {
+		return await interaction.reply({content: "Hello world!"});
+	}
+}

package/dist/functions/Spinner.js

@@ -1,122 +0,0 @@
-import * as colorette from 'colorette';
-import tty from 'node:tty';
-/**
- * A very minimal terminal spinner
- *
- * @license ISC
- * @copyright 2021 Usman Yunusov <usman.iunusov@gmail.com>
- * @see https://github.com/usmanyunusov/nanospinner/blob/master/index.js
- */
-export class Spinner {
-    #isCI = process.env.CI ||
-        process.env.WT_SESSION ||
-        process.env.ConEmuTask === '{cmd::Cmder}' ||
-        process.env.TERM_PROGRAM === 'vscode' ||
-        process.env.TERM === 'xterm-256color' ||
-        process.env.TERM === 'alacritty';
-    #isTTY = tty.isatty(1) && process.env.TERM !== 'dumb' && !('CI' in process.env);
-    #supportUnicode = process.platform === 'win32' ? this.#isCI : process.env.TERM !== 'linux';
-    #symbols = {
-        frames: this.#isTTY ? (this.#supportUnicode ? ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'] : ['-', '\\', '|', '/']) : ['-'],
-        tick: this.#supportUnicode ? '✔' : '√',
-        cross: this.#supportUnicode ? '✖' : '×'
-    };
-    #text = '';
-    #current = 0;
-    #interval = 50;
-    #stream = process.stderr;
-    #frames = this.#symbols.frames;
-    #color = 'greenBright';
-    #lines = 0;
-    #timer;
-    constructor(text, options) {
-        this.#text = text ?? this.#text;
-        this.#interval = options?.interval ?? this.#interval;
-        this.#stream = options?.stream ?? this.#stream;
-        if (options?.frames && options?.frames.length) {
-            this.#frames = options.frames;
-        }
-        this.#color = options?.color ?? this.#color;
-    }
-    clear() {
-        this.write('\x1b[1G');
-        for (let i = 0; i < this.#lines; i++) {
-            i > 0 && this.write('\x1b[1A');
-            this.write('\x1b[2K\x1b[1G');
-        }
-        this.#lines = 0;
-        return this;
-    }
-    error(options) {
-        const mark = colorette.red(this.#symbols.cross);
-        return this.stop({ mark, ...options });
-    }
-    reset() {
-        this.#current = 0;
-        this.#lines = 0;
-        if (this.#timer) {
-            clearTimeout(this.#timer);
-        }
-        return this;
-    }
-    spin() {
-        this.render();
-        this.#current = ++this.#current % this.#frames.length;
-        return this;
-    }
-    start(opts = {}) {
-        this.#timer && this.reset();
-        return this.update({ text: opts.text, color: opts.color }).loop();
-    }
-    stop(opts = {}) {
-        if (this.#timer) {
-            clearTimeout(this.#timer);
-        }
-        const mark = colorette[opts.color || this.#color](this.#frames[this.#current]);
-        const optsMark = opts.mark && opts.color ? colorette[opts.color](opts.mark) : opts.mark;
-        this.write(`${optsMark || mark} ${opts.text || this.#text}\n`, true);
-        return this.#isTTY ? this.write(`\x1b[?25h`) : this;
-    }
-    success(opts = {}) {
-        const mark = colorette.green(this.#symbols.tick);
-        return this.stop({ mark, ...opts });
-    }
-    update(opts = {}) {
-        this.#text = opts.text || this.#text;
-        this.#interval = opts?.interval ?? this.#interval;
-        this.#stream = opts?.stream ?? this.#stream;
-        if (opts?.frames && opts?.frames.length) {
-            this.#frames = opts.frames;
-        }
-        this.#color = opts?.color ?? this.#color;
-        if (this.#frames.length - 1 < this.#current) {
-            this.#current = 0;
-        }
-        return this;
-    }
-    loop() {
-        this.#isTTY && (this.#timer = setTimeout(() => this.loop(), this.#interval));
-        return this.spin();
-    }
-    write(str, clear = false) {
-        if (clear && this.#isTTY) {
-            this.clear();
-        }
-        this.#stream.write(str);
-        return this;
-    }
-    render() {
-        const mark = colorette[this.#color](this.#frames[this.#current]);
-        let str = `${mark} ${this.#text}`;
-        this.#isTTY ? this.write(`\x1b[?25l`) : (str += '\n');
-        this.write(str, true);
-        this.#isTTY && (this.#lines = this.getLines(str, this.#stream.columns));
-    }
-    getLines(str = '', width = 80) {
-        return str
-            .replace(/\u001b[^m]*?m/g, '')
-            .split('\n')
-            .reduce((col, line) => (col += Math.max(1, Math.ceil(line.length / width))), 0);
-    }
-}
-//# sourceMappingURL=Spinner.js.map