@sapphire/cli 1.5.1-next.6fe3d0c.0 → 1.6.0-next.afa4afb.0

package/dist/commands/generate.js

@@ -25,15 +25,26 @@ async function createComponent(component, name, config, configLoc) {
     else if (await fileExists(corePath)) {
         return CreateFileFromTemplate(`components/${template}`, target, config, params, false, true);
     }
-    throw new Error("Can't find the template.");
+    throw new Error(`Couldn't find a template file for that component type.${parseCommonHints(component)}`);
 }
 async function fetchConfig() {
-    const a = await Promise.race([findUp('.sapphirerc.json', { cwd: '.' }), sleep(5000)]);
-    if (a) {
-        return a;
+    const configFileAsJson = await Promise.race([findUp('.sapphirerc.json', { cwd: '.' }), sleep(5000)]);
+    if (configFileAsJson) {
+        return configFileAsJson;
     }
     return Promise.race([findUp('.sapphirerc.yml', { cwd: '.' }), sleep(5000)]);
 }
+/**
+ * Parses common hints for the user
+ * @param component Component name
+ * @returns A string with a hint for the user
+ */
+function parseCommonHints(component) {
+    if (component.toLowerCase() === 'command' || component.toLowerCase() === 'commands') {
+        return `\nHint: You wrote "${component}", instead of "messagecommand", "slashcommand", or "contextmenucommand"`;
+    }
+    return '';
+}
 export default async (component, name) => {
     const spinner = new Spinner(`Creating a ${component.toLowerCase()}`).start();
     const fail = (error, additionalExecution) => {

package/dist/commands/new.js

@@ -45,11 +45,15 @@ async function configureYarnRc(location, name, value) {
     return true;
 }
 async function installYarnV3(location, verbose) {
-    const value = await execa('yarn', ['set', 'version', 'berry'], {
+    const valueSetVersion = await execa('yarn', ['set', 'version', 'berry'], {
         stdio: verbose ? 'inherit' : undefined,
         cwd: `./${location}/`
     });
-    if (value.exitCode !== 0) {
+    const valueInstallPlugins = await execa('yarn', ['plugin', 'import', 'interactive-tools'], {
+        stdio: verbose ? 'inherit' : undefined,
+        cwd: `./${location}/`
+    });
+    if (valueSetVersion.exitCode !== 0 || valueInstallPlugins.exitCode !== 0) {
         throw new Error('An unknown error occurred while installing Yarn v3. Try running Sapphire CLI with "--verbose" flag.');
     }
     await Promise.all([

package/dist/functions/CreateFileFromTemplate.js

@@ -6,35 +6,45 @@ export async function CreateFileFromTemplate(template, target, config, params, c
     const location = custom ? template : `${templatesFolder}${template}`;
     const output = {};
     if (component) {
-        const [c, f] = await getComponentTemplateWithConfig(location);
-        output.c = c;
-        output.f = f;
+        const [config, templateContent] = await getComponentTemplateWithConfig(location);
+        output.config = config;
+        output.templateContent = templateContent;
     }
-    output.f ??= await readFile(location, 'utf8');
-    if (!output.f) {
-        throw new Error("Can't read file.");
+    output.templateContent ??= await readFile(location, 'utf8');
+    if (!output.templateContent) {
+        throw new Error("Couldn't read the template file. Are you sure it exists, the name is correct, and the content is valid?");
     }
     if (params) {
         for (const param of Object.entries(params)) {
-            output.f = output.f.replaceAll(`{{${param[0]}}}`, param[1]);
+            output.templateContent = output.templateContent.replaceAll(`{{${param[0]}}}`, param[1]);
         }
     }
-    if (!output || (component && (!output.c || !output.c.category))) {
-        throw new Error('Invalid template.');
+    if (!output || (component && (!output.config || !output.config.category))) {
+        throw new Error('The template is invalid. Please create a valid template structure.');
     }
-    const dir = component ? config.locations[output.c.category] : null;
-    const ta = component ? target.replace('%L%', dir) : target;
-    if (await fileExists(ta)) {
-        throw new Error('Component already exists');
+    const directoryForOutput = component ? config?.locations[output.config.category] : null;
+    const targetPath = component ? target.replace('%L%', directoryForOutput) : target;
+    if (await fileExists(targetPath)) {
+        throw new Error('A component with the provided name already exists. Please provide a unique name.');
     }
-    await writeFileRecursive(ta, output.f);
+    await writeFileRecursive(targetPath, output.templateContent);
     return true;
 }
+/**
+ * Gets the template and the config from a component template
+ * @param path Path to the template
+ * @returns [config, template] The config and the template
+ */
 async function getComponentTemplateWithConfig(path) {
     const file = await readFile(path, 'utf8');
     const fa = file.split(/---(\r\n|\r|\n|)/gm);
     return [JSON.parse(fa[0]), fa[2]];
 }
+/**
+ * Writes a file recursively
+ * @param target Target path
+ * @param data Data to write
+ */
 async function writeFileRecursive(target, data) {
     const resolvedTarget = resolve(target);
     const dir = dirname(resolvedTarget);

package/dist/lib/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/prompts/PromptNew.js

@@ -63,7 +63,8 @@ export const PromptNew = (projectName, yarn, pnpm) => {
         {
             type: (prev) => (prev === 'Yarn' ? 'confirm' : false),
             name: 'yarnV3',
-            message: 'Do you want to use Yarn v3?'
+            message: 'Do you want to use Yarn v3?',
+            initial: true
         },
         {
             type: 'confirm',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire/cli",
-  "version": "1.5.1-next.6fe3d0c.0",
+  "version": "1.6.0-next.afa4afb.0",
   "description": "CLI for Sapphire Framework",
   "author": "@sapphire",
   "license": "MIT",