@sapphire/cli 0.0.2-next.1c6703c.0 → 0.0.2-next.326520a.0

package/README.md

@@ -8,7 +8,6 @@
 
 [![GitHub](https://img.shields.io/github/license/sapphiredev/cli)](https://github.com/sapphiredev/cli/blob/main/LICENSE.md)
 [![npm](https://img.shields.io/npm/v/@sapphire/cli?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/@sapphire/cli)
-[![Depfu](https://badges.depfu.com/badges/5086e1d7764d4a0e53b443a9d86cc11b/count.svg)](https://depfu.com/github/sapphiredev/cli?project_id=31779)
 
 </div>
 

package/dist/commands/generate.js

@@ -9,16 +9,21 @@ const fs_1 = require("fs");
 const promises_1 = require("fs/promises");
 const ora_1 = (0, tslib_1.__importDefault)(require("ora"));
 const path_1 = require("path");
+const promises_2 = require("timers/promises");
 class Generate extends command_1.Command {
     async run() {
         const { args } = this.parse(Generate);
         const spinner = (0, ora_1.default)(`Creating a ${args.component.toLowerCase()}`).start();
-        const configLoc = await (0, find_up_1.default)('.sapphirerc.json', { cwd: '.' });
+        const fail = (error) => {
+            spinner.fail(error);
+            process.exit(1);
+        };
+        const configLoc = await this.fetchConfig();
         if (!configLoc)
-            return;
+            return fail("Can't find the Sapphire CLI config.");
         const config = JSON.parse(await (0, promises_1.readFile)(configLoc, 'utf8'));
         if (!config)
-            return;
+            return fail("Can't parse the Sapphire CLI config.");
         await this.createComponent(args.component, args.name, config, configLoc.replace('.sapphirerc.json', '')).catch((err) => {
             spinner.fail();
             console.log((0, chalk_1.red)(err.message));
@@ -36,15 +41,30 @@ class Generate extends command_1.Command {
             const corePath = `${__dirname}/../../templates/components/${template}`;
             const userPath = config.customFileTemplates.enabled ? (0, path_1.join)(configLoc, config.customFileTemplates.location, template) : null;
             const target = (0, path_1.join)(configLoc, config.locations.base, '%L%', `${name}.${projectLanguage}`);
+            const params = { name: (0, path_1.basename)(name) };
             if (userPath && (0, fs_1.existsSync)(userPath)) {
-                return (0, _functions_1.CreateFileFromTemplate)(userPath, target, config, { name }, true, true).then(resolve).catch(reject);
+                return (0, _functions_1.CreateFileFromTemplate)(userPath, target, config, params, true, true).then(resolve).catch(reject);
             }
             else if ((0, fs_1.existsSync)(corePath)) {
-                return (0, _functions_1.CreateFileFromTemplate)(`components/${template}`, target, config, { name }, false, true).then(resolve).catch(reject);
+                return (0, _functions_1.CreateFileFromTemplate)(`components/${template}`, target, config, params, false, true).then(resolve).catch(reject);
             }
             return reject(new Error("Can't find the template."));
         });
     }
+    timeout(ms) {
+        return new Promise((resolve, reject) => {
+            // false positive
+            // eslint-disable-next-line @typescript-eslint/no-implied-eval
+            return (0, promises_2.setTimeout)(ms)
+                .then(() => {
+                resolve(null);
+            })
+                .catch(reject);
+        });
+    }
+    fetchConfig() {
+        return Promise.race([(0, find_up_1.default)('.sapphirerc.json', { cwd: '.' }), this.timeout(5000)]);
+    }
 }
 exports.default = Generate;
 Object.defineProperty(Generate, "description", {

package/dist/functions/CreateFileFromTemplate.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CreateFileFromTemplate = void 0;
+const tslib_1 = require("tslib");
 const fs_1 = require("fs");
 const promises_1 = require("fs/promises");
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
 function CreateFileFromTemplate(template, target, config, params, custom = false, component = false) {
     return new Promise(async (resolve, reject) => {
         const location = custom ? template : `${__dirname}/../../templates/${template}`;
@@ -26,7 +28,7 @@ function CreateFileFromTemplate(template, target, config, params, custom = false
         const ta = component ? target.replace('%L%', dir) : target;
         if ((0, fs_1.existsSync)(ta))
             reject(new Error('Component already exists'));
-        await (0, promises_1.writeFile)(ta, output.f).catch(reject);
+        await writeFileRecursive(ta, output.f).catch(reject);
         return resolve(true);
     });
 }
@@ -37,4 +39,11 @@ function getComponentTemplateWithConfig(path) {
         return [JSON.parse(fa[0]), fa[2]];
     });
 }
+function writeFileRecursive(target, data) {
+    return new Promise(async (resolve, reject) => {
+        const dir = path_1.default.dirname(path_1.default.resolve(target));
+        await (0, promises_1.mkdir)(dir, { recursive: true }).catch(reject);
+        return (0, promises_1.writeFile)(path_1.default.resolve(target), data).then(resolve).catch(reject);
+    });
+}
 //# sourceMappingURL=CreateFileFromTemplate.js.map

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.0.2-next.1c6703c.0","commands":{"generate":{"id":"generate","description":"generate a component (command, listener, etc.)","pluginName":"@sapphire/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"component","required":true},{"name":"name","required":true}]},"new":{"id":"new","description":"create a new Sapphire project","pluginName":"@sapphire/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"verbose":{"name":"verbose","type":"boolean","char":"v","allowNo":false}},"args":[{"name":"ProjectName","default":"NewSapphireProject"}]}}}
+{"version":"0.0.2-next.326520a.0","commands":{"generate":{"id":"generate","description":"generate a component (command, listener, etc.)","pluginName":"@sapphire/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"component","required":true},{"name":"name","required":true}]},"new":{"id":"new","description":"create a new Sapphire project","pluginName":"@sapphire/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"verbose":{"name":"verbose","type":"boolean","char":"v","allowNo":false}},"args":[{"name":"ProjectName","default":"NewSapphireProject"}]}}}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapphire/cli",
-	"version": "0.0.2-next.1c6703c.0",
+	"version": "0.0.2-next.326520a.0",
 	"description": "CLI for Sapphire Framework",
 	"author": "@sapphire",
 	"license": "MIT",
@@ -20,7 +20,8 @@
 		"!dist/**/*.js.map",
 		"!dist/**/*.d.ts",
 		"!dist/**/*.d.ts.map",
-		"oclif.manifest.json"
+		"oclif.manifest.json",
+		"templates"
 	],
 	"scripts": {
 		"lint": "eslint src --ext ts --fix",
@@ -54,7 +55,7 @@
 		"@sapphire/eslint-config": "^3.2.3",
 		"@sapphire/prettier-config": "^1.1.6",
 		"@sapphire/ts-config": "^3.0.0",
-		"@types/node": "^16.9.6",
+		"@types/node": "^16.10.1",
 		"@types/prompts": "^2.0.14",
 		"@typescript-eslint/eslint-plugin": "^4.31.2",
 		"@typescript-eslint/parser": "^4.31.2",
@@ -68,7 +69,7 @@
 		"prettier": "^2.4.1",
 		"pretty-quick": "^3.1.1",
 		"standard-version": "^9.3.1",
-		"ts-node": "^10.2.0",
+		"ts-node": "^10.2.1",
 		"typescript": "^4.4.2"
 	},
 	"engines": {
@@ -115,7 +116,7 @@
 		"kind-of": "^6.0.3",
 		"dot-prop": "^6.0.1",
 		"lodash": "^4.17.21",
-		"marked": "^2.0.3",
+		"marked": "^2.1.3",
 		"merge": "^2.1.1",
 		"trim": "^1.0.1",
 		"trim-newlines": "^3.0.1"

package/templates/.sapphirerc.json.sapphire

@@ -0,0 +1,14 @@
+{
+  "projectLanguage": "{{language}}",
+  "locations": {
+    "base": "src",
+    "arguments": "arguments",
+    "commands": "commands",
+    "listeners": "listeners",
+    "preconditions": "preconditions"
+  },
+  "customFileTemplates": {
+    "enabled": false,
+    "location": ""
+  }
+}

package/templates/components/argument.js.sapphire

@@ -0,0 +1,15 @@
+{ "category": "arguments" }
+---
+import { Argument } from "@sapphire/framework";
+
+export class UserArgument extends Argument {
+    constructor(context, options) {
+        super(context, {
+            ...options
+        });
+    }
+
+    async run(parameter) {
+        return this.ok(parameter);
+    }
+}

package/templates/components/argument.ts.sapphire

@@ -0,0 +1,11 @@
+{ "category": "arguments" }
+---
+import { ApplyOptions } from '@sapphire/decorators';
+import { Argument, ArgumentOptions } from "@sapphire/framework";
+
+@ApplyOptions<ArgumentOptions>({})
+export class UserArgument extends Argument<string> {
+  async run(parameter: string) {
+    return this.ok(parameter);
+  }
+}

package/templates/components/command.js.sapphire

@@ -0,0 +1,17 @@
+{ "category": "commands" }
+---
+const { SubCommandPluginCommand } = require('@sapphire/plugin-subcommands');
+
+class UserCommand extends SubCommandPluginCommand {
+    constructor(context, options) {
+        super(context, {
+            ...options
+        });
+    }
+
+    async run(message) {
+        return msg.channel.send('Hello world!');
+    }
+}
+
+exports.UserCommand = UserCommand;

package/templates/components/command.ts.sapphire

@@ -0,0 +1,14 @@
+{ "category": "commands" }
+---
+import { ApplyOptions } from '@sapphire/decorators';
+import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';
+import { Message } from 'discord.js';
+
+@ApplyOptions<SubCommandPluginCommandOptions>({
+	description: 'A basic command'
+})
+export class UserCommand extends SubCommandPluginCommand {
+	public async run(message: Message) {
+		return message.channel.send('Hello world!');
+	}
+}

package/templates/components/listener.js.sapphire

@@ -0,0 +1,15 @@
+{ "category": "listeners" }
+---
+const { Listener } = require('@sapphire/framework');
+
+class UserEvent extends Listener {
+    constructor(context, options = {}) {
+        super(context, {
+            ...options
+        });
+    }
+
+    run() {}
+}
+
+exports.UserEvent = UserEvent;

package/templates/components/listener.ts.sapphire

@@ -0,0 +1,9 @@
+{ "category": "listeners" }
+---
+import { ApplyOptions } from '@sapphire/decorators';
+import { Listener, ListenerOptions } from '@sapphire/framework';
+
+@ApplyOptions<ListenerOptions>({})
+export class UserEvent extends Listener {
+  public run() {}
+}

package/templates/components/precondition.js.sapphire

@@ -0,0 +1,11 @@
+{ "category": "preconditions" }
+---
+const { Precondition } = require('@sapphire/framework');
+
+class UserPrecondition extends Precondition {
+	run(message) {
+		return this.ok();
+	}
+}
+
+module.exports.UserPrecondition = UserPrecondition;

package/templates/components/precondition.ts.sapphire

@@ -0,0 +1,16 @@
+{ "category": "preconditions" }
+---
+import { Precondition } from '@sapphire/framework';
+import type { Message } from 'discord.js';
+
+export class UserPrecondition extends Precondition {
+  public run(message: Message) {
+    return this.ok();
+  }
+}
+
+declare module '@sapphire/framework' {
+  interface Preconditions {
+    {{name}}: never;
+  }
+}