@sapphire/cli 1.9.0-pr-274.95d19e9.0 → 1.9.0

package/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file.
 
+# [1.9.0](https://github.com/sapphiredev/cli/compare/v1.9.0...v1.9.0) - (2023-12-03)
+
+## 🐛 Bug Fixes
+
+- Specify schema for both template schema files ([30a80bb](https://github.com/sapphiredev/cli/commit/30a80bb561f61b8fba78c8cfc4157ca579e73f7c))
+- **json schema:** Specify enum for projectLanguage ([2f1ba0d](https://github.com/sapphiredev/cli/commit/2f1ba0d7fb4597c82581601ee60391898a3b100f))
+- **json schema:** Fixed base schema url ([bd37a6c](https://github.com/sapphiredev/cli/commit/bd37a6c5b590de90c2a1efa7cb19f16f38403273))
+- Install yarn v4, not v3 ([938ca99](https://github.com/sapphiredev/cli/commit/938ca99fe6dedea04978ca1ac38ac9a4505f0651))
+
+## 📝 Documentation
+
+- **readme:** Update readme to mention virtual components ([23aa8c5](https://github.com/sapphiredev/cli/commit/23aa8c5e6b0f07e4b8028c21ecb243e81d845e03))
+
+## 🚀 Features
+
+- Add generator for virtual piece loader (#274) ([f9fa2a3](https://github.com/sapphiredev/cli/commit/f9fa2a359c9a1bdb3b512a7484e0da12e20f6c8b))
+
 # [1.8.0](https://github.com/sapphiredev/cli/compare/v1.8.0...v1.8.0) - (2023-11-16)
 
 ## 🚀 Features

package/README.md

@@ -17,6 +17,7 @@
 -   Generate Sapphire projects easily
 -   Generate components (commands, listeners, etc.)
 -   Create your own templates for components
+-   Generate loaders for [virtual components](https://www.sapphirejs.dev/docs/Guide/additional-information/registering-virtual-pieces)
 
 ## [Get Started with the CLI](https://www.sapphirejs.dev/docs/Guide/CLI/introduction)
 

package/dist/cli.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 import generateCmd from '#commands/generate';
+import generateLoaderCmd from '#commands/generate-loader';
 import initCmd from '#commands/init';
 import newCmd from '#commands/new';
 import { createColors } from 'colorette';
@@ -27,6 +28,11 @@ sapphire
     .argument('<component>', 'component/piece name')
     .argument('<name>', 'file name')
     .action(generateCmd);
+sapphire //
+    .command('generate-loader')
+    .description('generates a piece loader')
+    .alias('gl')
+    .action(generateLoaderCmd);
 sapphire //
     .command('init')
     .description('creates a config file on an existing Sapphire project')

package/dist/commands/generate-loader.js

@@ -1,59 +1,27 @@
-import { componentsFolder } from '#constants';
-import { fileExists } from '#functions/FileExists';
-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';
-import { readFile } from 'node:fs/promises';
+import { locationReplacement } from '#constants';
+import { CreateComponentLoaders } from '#functions/CreateComponentLoader';
+import { generateCommandFlow } from '#functions/generateCommandFlow';
 import { join } from 'node:path';
-import { setTimeout as sleep } from 'node:timers/promises';
-import { CreateComponentLoaders } from '../functions/CreateComponentLoader.js';
-async function createLoader(config, configLoc) {
-    const component = '_load';
-    const name = '_load';
+/**
+ * Generates loaders based on the Sapphire CLI config.
+ * @returns A promise that resolves when the loaders are created.
+ */
+export default async () => {
+    return generateCommandFlow('Creating loaders...', (config, configLocation) => createLoader(config, configLocation));
+};
+/**
+ * Creates a loader component based on the provided configuration.
+ * @param config - The configuration object.
+ * @param configLoc - The location of the configuration file.
+ * @returns A promise that resolves to the created loader component.
+ * @throws An error if the 'projectLanguage' field is missing in the configuration file or if a template file for the loader component cannot be found.
+ */
+export async function createLoader(config, configLoc) {
     const { projectLanguage } = config;
     if (!projectLanguage) {
         throw new Error("There is no 'projectLanguage' field in .sapphirerc.json");
     }
-    const template = `${component.toLowerCase()}.${projectLanguage}.sapphire`;
-    const corePath = `${componentsFolder}${template}`;
-    const target = join(configLoc, config.locations.base, '%L%', `${name}.${projectLanguage}`);
-    if (await fileExists(corePath)) {
-        return CreateComponentLoaders(target, config);
-    }
-    throw new Error(`Couldn't find a template file for loader component.`);
-}
-async function fetchConfig() {
-    const configFileAsJson = await Promise.race([findUp('.sapphirerc.json', { cwd: '.' }), sleep(5000)]);
-    if (configFileAsJson) {
-        return configFileAsJson;
-    }
-    return Promise.race([findUp('.sapphirerc.yml', { cwd: '.' }), sleep(5000)]);
+    const targetDir = join(configLoc, config.locations.base, locationReplacement);
+    return CreateComponentLoaders(targetDir, config);
 }
-export default async () => {
-    const spinner = new Spinner(`Creating loaders...`).start();
-    const fail = (error, additionalExecution) => {
-        spinner.error({ text: error });
-        additionalExecution?.();
-        process.exit(1);
-    };
-    const configLoc = await fetchConfig();
-    if (!configLoc) {
-        return fail("Can't find the Sapphire CLI config.");
-    }
-    const config = configLoc.endsWith('json') ? JSON.parse(await readFile(configLoc, 'utf8')) : load(await readFile(configLoc, 'utf8'));
-    if (!config) {
-        return fail("Can't parse the Sapphire CLI config.");
-    }
-    const result = await Result.fromAsync(() => createLoader(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-loader.js.map

package/dist/commands/generate.js

@@ -1,15 +1,39 @@
-import { componentsFolder } from '#constants';
+import { componentsFolder, locationReplacement } from '#constants';
 import { CreateFileFromTemplate } from '#functions/CreateFileFromTemplate';
 import { fileExists } from '#functions/FileExists';
+import { generateCommandFlow } from '#functions/generateCommandFlow';
 import { commandNames, componentCommandNames, componentInteractionHandlerNames, interactionHandlerNames } from '#lib/aliases';
-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';
-import { readFile } from 'node:fs/promises';
 import { basename, join } from 'node:path';
-import { setTimeout as sleep } from 'node:timers/promises';
+/**
+ * Generates a component based on the given component type and name.
+ * @param component The type of component to generate.
+ * @param name The name of the component.
+ * @returns A Promise that resolves when the component generation is complete.
+ */
+export default async (component, name) => {
+    return generateCommandFlow('Creating loaders...', (config, configLocation) => createComponent(component, name, config, configLocation));
+};
+/**
+ * Joins an array of component names into a single string.
+ *
+ * @param components - An array of component names.
+ * @returns The joined string with component names.
+ */
+function joinComponentNames(components) {
+    const lastComponent = components.pop();
+    return `"${components.join('", "')}" or "${lastComponent}"`;
+}
+/**
+ * Creates a component based on the specified parameters.
+ *
+ * @param component - The type of component to create.
+ * @param name - The name of the component.
+ * @param config - The configuration object.
+ * @param configLoc - The location of the configuration file.
+ * @returns A Promise that resolves when the component is created.
+ * @throws An error if the 'projectLanguage' field is missing in the configuration file,
+ * or if a template file for the component type cannot be found.
+ */
 async function createComponent(component, name, config, configLoc) {
     const { projectLanguage } = config;
     if (!projectLanguage) {
@@ -18,7 +42,7 @@ async function createComponent(component, name, config, configLoc) {
     const template = `${component.toLowerCase()}.${projectLanguage}.sapphire`;
     const corePath = `${componentsFolder}${template}`;
     const userPath = config.customFileTemplates.enabled ? join(configLoc, config.customFileTemplates.location, template) : null;
-    const target = join(configLoc, config.locations.base, '%L%', `${name}.${projectLanguage}`);
+    const target = join(configLoc, config.locations.base, locationReplacement, `${name}.${projectLanguage}`);
     const params = { name: basename(name) };
     if (userPath && (await fileExists(userPath))) {
         return CreateFileFromTemplate(userPath, target, config, params, true, true);
@@ -28,17 +52,6 @@ async function createComponent(component, name, config, configLoc) {
     }
     throw new Error(`Couldn't find a template file for that component type.${parseCommonHints(component)}`);
 }
-async function fetchConfig() {
-    const configFileAsJson = await Promise.race([findUp('.sapphirerc.json', { cwd: '.' }), sleep(5000)]);
-    if (configFileAsJson) {
-        return configFileAsJson;
-    }
-    return Promise.race([findUp('.sapphirerc.yml', { cwd: '.' }), sleep(5000)]);
-}
-function joinComponentNames(components) {
-    const lastComponent = components.pop();
-    return `"${components.join('", "')}" or "${lastComponent}"`;
-}
 /**
  * Parses common hints for the user
  * @param component Component name
@@ -56,29 +69,4 @@ function parseCommonHints(component) {
     }
     return '';
 }
-export default async (component, name) => {
-    const spinner = new Spinner(`Creating a ${component.toLowerCase()}`).start();
-    const fail = (error, additionalExecution) => {
-        spinner.error({ text: error });
-        additionalExecution?.();
-        process.exit(1);
-    };
-    const configLoc = await fetchConfig();
-    if (!configLoc) {
-        return fail("Can't find the Sapphire CLI config.");
-    }
-    const config = configLoc.endsWith('json') ? JSON.parse(await readFile(configLoc, 'utf8')) : load(await readFile(configLoc, 'utf8'));
-    if (!config) {
-        return fail("Can't parse the Sapphire CLI config.");
-    }
-    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/init.js

@@ -4,6 +4,10 @@ import findUp from 'find-up';
 import { dump } from 'js-yaml';
 import { writeFile } from 'node:fs/promises';
 import prompts from 'prompts';
+/**
+ * Initializes the project by prompting the user for configuration options and generating a configuration file.
+ * @returns A promise that resolves when the initialization is complete.
+ */
 export default async () => {
     const packageJson = await findUp('package.json');
     if (!packageJson) {

package/dist/commands/new.js

@@ -10,6 +10,60 @@ import { execa } from 'execa';
 import { cp, readFile, rm, writeFile } from 'node:fs/promises';
 import { resolve } from 'node:path';
 import prompts from 'prompts';
+/**
+ * Creates a new project with the given name and flags.
+ * @param name - The name of the project.
+ * @param flags - The flags for the project.
+ * @returns A promise that resolves when the project setup is complete.
+ */
+export default async (name, flags) => {
+    const response = await prompts(PromptNew(name, await CommandExists('yarn'), await CommandExists('pnpm')));
+    if (!response.projectName || !response.projectLang || !response.projectTemplate || !response.packageManager) {
+        process.exit(1);
+    }
+    const projectName = response.projectName === '.' ? '' : response.projectName;
+    const stpJob = async () => {
+        await cp(`./${response.projectName}/ghr/examples/${response.projectTemplate}/.`, `./${response.projectName}/`, { recursive: true });
+        for (const p of ['.gitignore', '.prettierignore']) {
+            await cp(`./${response.projectName}/ghr/${p}`, `./${response.projectName}/${p}`, { recursive: true });
+        }
+        await rm(`./${response.projectName}/ghr`, { recursive: true, force: true });
+        await CreateFileFromTemplate(`.sapphirerc.${response.configFormat}.sapphire`, resolve(`./${response.projectName}/.sapphirerc.${response.configFormat}`), null, {
+            language: response.projectLang
+        });
+        await editPackageJson(response.projectName, projectName);
+        if (response.packageManager === 'pnpm') {
+            await writeFile(`./${response.projectName}/.npmrc`, '# pnpm only\nshamefully-hoist=true\npublic-hoist-pattern[]=@sapphire/*');
+        }
+    };
+    const jobs = [
+        [() => cloneRepo(response.projectName, flags.verbose), 'Cloning the repository'],
+        [stpJob, 'Setting up the project']
+    ];
+    if (response.git) {
+        jobs.push([() => initializeGitRepo(response.projectName), 'Initializing git repo']);
+    }
+    if (response.yarnV4) {
+        jobs.push([() => installYarnV4(response.projectName, flags.verbose), 'Installing Yarn v4']);
+        jobs.push([() => configureYarnRc(response.projectName, 'enableGlobalCache', 'true'), 'Enabling Yarn v4 global cache']);
+        jobs.push([() => configureYarnRc(response.projectName, 'nodeLinker', 'node-modules'), 'Configuring Yarn v4 to use node-modules']);
+    }
+    jobs.push([
+        () => installDeps(response.projectName, response.packageManager, flags.verbose),
+        `Installing dependencies using ${response.packageManager}`
+    ]);
+    for (const [job, name] of jobs) {
+        await runJob(job, name).catch(() => process.exit(1));
+    }
+    console.log(blueBright('Done!'));
+    process.exit(0);
+};
+/**
+ * Edits the package.json file at the specified location by updating the "name" field.
+ * @param location - The location of the package.json file.
+ * @param name - The new value for the "name" field.
+ * @returns A boolean indicating whether the operation was successful.
+ */
 async function editPackageJson(location, name) {
     const pjLocation = `./${location}/package.json`;
     const output = JSON.parse(await readFile(pjLocation, 'utf8'));
@@ -19,6 +73,13 @@ async function editPackageJson(location, name) {
     const result = await Result.fromAsync(() => writeFile(pjLocation, JSON.stringify(output, null, 2)));
     return result.isOk();
 }
+/**
+ * Installs dependencies using the specified package manager.
+ * @param location The location where the dependencies should be installed.
+ * @param pm The package manager to use ('npm', 'Yarn', or 'pnpm').
+ * @param verbose Whether to display the installation output.
+ * @returns A boolean indicating whether the installation was successful.
+ */
 async function installDeps(location, pm, verbose) {
     const value = await execa(pm.toLowerCase(), ['install'], {
         stdio: verbose ? 'inherit' : undefined,
@@ -40,32 +101,52 @@ async function installDeps(location, pm, verbose) {
     }
     return true;
 }
+/**
+ * Configures the yarnrc file with the specified name and value.
+ *
+ * @param location - The location of the yarnrc file.
+ * @param name - The name of the configuration to set.
+ * @param value - The value to set for the configuration.
+ * @returns A promise that resolves to true if the configuration was successfully set, otherwise false.
+ */
 async function configureYarnRc(location, name, value) {
     await execa('yarn', ['config', 'set', name, value], { cwd: `./${location}/` });
     return true;
 }
-async function installYarnV3(location, verbose) {
+/**
+ * Installs Yarn v4 at the specified location.
+ *
+ * @param location - The location where Yarn v4 will be installed.
+ * @param verbose - Whether to display verbose output during installation.
+ * @returns A boolean indicating whether the installation was successful.
+ * @throws An error if an unknown error occurs during installation.
+ */
+async function installYarnV4(location, verbose) {
     const valueSetVersion = await execa('yarn', ['set', 'version', 'berry'], {
         stdio: verbose ? 'inherit' : undefined,
         cwd: `./${location}/`
     });
-    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.');
+    if (valueSetVersion.exitCode !== 0) {
+        throw new Error('An unknown error occurred while installing Yarn v4. Try running Sapphire CLI with "--verbose" flag.');
     }
     return true;
 }
-async function installYarnTypescriptPlugin(location) {
-    await execa('yarn', ['plugin', 'import', 'typescript'], { cwd: `./${location}/` });
-    return true;
-}
+/**
+ * Initializes a Git repository at the specified location.
+ * @param location - The location where the Git repository should be initialized.
+ * @returns A boolean indicating whether the Git repository was successfully initialized.
+ */
 async function initializeGitRepo(location) {
     await execa('git', ['init'], { cwd: `./${location}/` });
     return true;
 }
+/**
+ * Runs a job asynchronously and handles the result.
+ *
+ * @param job - The job to be executed.
+ * @param name - The name of the job.
+ * @returns A boolean indicating whether the job was successful or not.
+ */
 async function runJob(job, name) {
     const spinner = new Spinner(name).start();
     const result = await Result.fromAsync(() => job());
@@ -81,6 +162,13 @@ async function runJob(job, name) {
         }
     });
 }
+/**
+ * Clones a repository to the specified location.
+ * @param location - The location where the repository will be cloned.
+ * @param verbose - Whether to display the output of the cloning process.
+ * @returns A boolean indicating whether the cloning was successful.
+ * @throws An error if an unknown error occurred while cloning the repository.
+ */
 async function cloneRepo(location, verbose) {
     const value = await execa('git', ['clone', repoUrl, `${location}/ghr`], { stdio: verbose ? 'inherit' : undefined });
     if (value.exitCode !== 0) {
@@ -88,48 +176,4 @@ async function cloneRepo(location, verbose) {
     }
     return true;
 }
-export default async (name, flags) => {
-    const response = await prompts(PromptNew(name, await CommandExists('yarn'), await CommandExists('pnpm')));
-    if (!response.projectName || !response.projectLang || !response.projectTemplate || !response.packageManager) {
-        process.exit(1);
-    }
-    const projectName = response.projectName === '.' ? '' : response.projectName;
-    const stpJob = async () => {
-        await cp(`./${response.projectName}/ghr/examples/${response.projectTemplate}/.`, `./${response.projectName}/`, { recursive: true });
-        for (const p of ['.gitignore', '.prettierignore']) {
-            await cp(`./${response.projectName}/ghr/${p}`, `./${response.projectName}/${p}`, { recursive: true });
-        }
-        await rm(`./${response.projectName}/ghr`, { recursive: true, force: true });
-        await CreateFileFromTemplate(`.sapphirerc.${response.configFormat}.sapphire`, resolve(`./${response.projectName}/.sapphirerc.${response.configFormat}`), null, {
-            language: response.projectLang
-        });
-        await editPackageJson(response.projectName, projectName);
-        if (response.packageManager === 'pnpm') {
-            await writeFile(`./${response.projectName}/.npmrc`, '# pnpm only\nshamefully-hoist=true\npublic-hoist-pattern[]=@sapphire/*');
-        }
-    };
-    const jobs = [
-        [() => cloneRepo(response.projectName, flags.verbose), 'Cloning the repository'],
-        [stpJob, 'Setting up the project']
-    ];
-    if (response.git) {
-        jobs.push([() => initializeGitRepo(response.projectName), 'Initializing git repo']);
-    }
-    if (response.yarnV3) {
-        jobs.push([() => installYarnV3(response.projectName, flags.verbose), 'Installing Yarn v3']);
-        if (response.projectLang === 'ts')
-            jobs.push([() => installYarnTypescriptPlugin(response.projectName), 'Installing Yarn Typescript Plugin']);
-        jobs.push([() => configureYarnRc(response.projectName, 'enableGlobalCache', 'true'), 'Enabling Yarn v3 global cache']);
-        jobs.push([() => configureYarnRc(response.projectName, 'nodeLinker', 'node-modules'), 'Configuring Yarn v3 to use node-modules']);
-    }
-    jobs.push([
-        () => installDeps(response.projectName, response.packageManager, flags.verbose),
-        `Installing dependencies using ${response.packageManager}`
-    ]);
-    for (const [job, name] of jobs) {
-        await runJob(job, name).catch(() => process.exit(1));
-    }
-    console.log(blueBright('Done!'));
-    process.exit(0);
-};
 //# sourceMappingURL=new.js.map

package/dist/constants.js

@@ -6,4 +6,5 @@ export const rootFolder = fileURLToPath(rootURL);
 export const templatesFolder = fileURLToPath(templatesURL);
 export const componentsFolder = fileURLToPath(componentsURL);
 export const repoUrl = 'https://github.com/sapphiredev/examples.git';
+export const locationReplacement = '{{LOCATION_REPLACEMENT}}';
 //# sourceMappingURL=constants.js.map

package/dist/functions/CreateComponentLoader.js

@@ -1,68 +1,80 @@
-import { mkdir, readFile, readdir, writeFile } from 'node:fs/promises';
-import { dirname, resolve } from 'node:path';
-import { lstatSync } from 'fs';
-import { join, relative } from 'path';
-import { templatesFolder } from '../constants.js';
+import { locationReplacement } from '#constants';
+import { findFilesRecursivelyRegex } from '@sapphire/node-utilities';
+import { Result } from '@sapphire/result';
+import { accessSync } from 'node:fs';
+import { mkdir, writeFile } from 'node:fs/promises';
+import { dirname, join, relative, resolve } from 'node:path';
 /**
- * Returns an array of JS/TS files in a folder
- * @param {string} dir
- * @returns {string[]}
+ * Regular expression pattern for matching files ending with JavaScript-like extensions.
+ * - `.js`
+ * - `.ts`
+ * - `.mjs`
+ * - `.cjs`
+ * - `.mts`
+ * - `.cts`
  */
-async function getJSTSfiles(dir, baseDir = dir) {
-    const files = await readdir(dir);
-    const tsFiles = files.flatMap((file) => {
-        const fullPath = join(dir, file);
-        if (lstatSync(fullPath).isDirectory()) {
-            return getJSTSfiles(fullPath, baseDir);
-        }
-        if (file.endsWith('.ts') || file.endsWith('.js')) {
-            return relative(baseDir, fullPath);
-        }
-        return [];
-    });
-    return (await Promise.all(tsFiles).then((files) => files.flat()))
-        .filter((file) => !file.includes('_load'))
-        .map((file) => file.replace(/.ts|.js/gimu, ''))
-        .sort();
-}
+const regexForFilesEndingWithJavaScriptLikeExtensions = /\.([mc])?[jt]s$/;
+/**
+ * Regular expression used to match loader files.
+ */
+const regexForLoaderFiles = new RegExp(`_load${regexForFilesEndingWithJavaScriptLikeExtensions.source}`);
 /**
  * Generates loader file content
- * @param {string} dir
+ * @param dir The directory to generate the loader for
+ * @param targetDir The directory that the `_load.<ext>` file will be written to
  */
-async function generateVirtualPieceLoader(dir) {
-    console.info(`Generating virtual piece loader for ${dir}`);
-    const files = await getJSTSfiles(dir);
-    console.info(`Found ${files.length} files`);
+async function generateVirtualPieceLoader(dir, targetDir) {
+    console.log(`Generating virtual piece loader for ${targetDir}`);
+    const files = [];
+    for await (const file of findFilesRecursivelyRegex(targetDir, regexForFilesEndingWithJavaScriptLikeExtensions)) {
+        if (regexForLoaderFiles.test(file))
+            continue;
+        files.push(relative(targetDir, file).replace(regexForFilesEndingWithJavaScriptLikeExtensions, '.$1js'));
+    }
+    console.log(`Found ${files.length} ${dir} files`);
     return `${files.map((file) => `import './${file}';`).join('\n')}\n`;
 }
-export async function CreateComponentLoaders(target, config) {
-    if (!config) {
-        throw new Error('There is no sapphire config. Please run `sapphire init` to create one.');
-    }
-    const location = `${templatesFolder}/_load`;
-    const [, templateContent] = await getComponentTemplateWithConfig(location);
-    const dirs = Object.values(config.locations);
-    dirs.map(async (dir) => {
-        const content = `${templateContent}\n${await generateVirtualPieceLoader(dir)}`;
-        return writeFileRecursive(target, content);
-    });
-    await Promise.all(dirs);
-    return true;
+/**
+ * Creates component loaders
+ *
+ * We wrap the bulk of this function in a {@link Result.fromAsync} so that if any of the file writing fails
+ * that will bubble up as a failure overall.
+ *
+ * @param targetDir The directory that the `_load.<ext>` file will be written to
+ * @param config The config
+ * @returns Whether the loaders were created successfully
+ */
+export async function CreateComponentLoaders(targetDir, config) {
+    const templateHeader = `// import this file in your entry point (index.${config.projectLanguage}) to load respective pieces`;
+    return (await Result.fromAsync(async () => {
+        const dirs = Object.entries(config.locations)
+            .filter(([key]) => key !== 'base')
+            .map(([, value]) => value)
+            .filter((dir) => Result.from(() => accessSync(injectDirIntoTargetDir(dir, targetDir))).isOk());
+        for (const dir of dirs) {
+            const dirInjectedTarget = injectDirIntoTargetDir(dir, targetDir);
+            const target = join(targetDir, `_load.${config.projectLanguage}`);
+            const content = `${templateHeader}\n${await generateVirtualPieceLoader(dir, dirInjectedTarget)}`;
+            await writeFileRecursive(target, content);
+        }
+    })).isOk();
 }
 /**
- * Gets the template and the config from a component template
- * @param path Path to the template
- * @returns [config, template] The config and the template
+ * Replaces the placeholder {@link locationReplacement} in the target directory with the specified directory.
+ *
+ * @param dir The directory to be injected into the target directory.
+ * @param targetDir The target directory containing the placeholder {@link locationReplacement}.
+ * @returns The target directory with the placeholder replaced by the specified directory.
  */
-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]];
+function injectDirIntoTargetDir(dir, targetDir) {
+    return targetDir.replace(locationReplacement, dir);
 }
 /**
- * Writes a file recursively
- * @param target Target path
- * @param data Data to write
+ * Writes data to a file recursively.
+ *
+ * @param target - The target file path.
+ * @param data - The data to write to the file.
+ * @returns A promise that resolves when the file is written.
  */
 async function writeFileRecursive(target, data) {
     const resolvedTarget = resolve(target);

package/dist/functions/CreateFileFromTemplate.js

@@ -1,9 +1,9 @@
-import { templatesFolder } from '#constants';
+import { locationReplacement, templatesFolder } from '#constants';
 import { fileExists } from '#functions/FileExists';
 import { mkdir, readFile, writeFile } from 'node:fs/promises';
-import { dirname, resolve } from 'node:path';
+import { dirname, join, resolve } from 'node:path';
 export async function CreateFileFromTemplate(template, target, config, params, custom = false, component = false) {
-    const location = custom ? template : `${templatesFolder}${template}`;
+    const location = custom ? template : join(templatesFolder, template);
     const output = {};
     if (component) {
         const [config, templateContent] = await getComponentTemplateWithConfig(location);
@@ -23,7 +23,7 @@ export async function CreateFileFromTemplate(template, target, config, params, c
         throw new Error('The template is invalid. Please create a valid template structure.');
     }
     const directoryForOutput = component ? config?.locations[output.config.category] : null;
-    const targetPath = component ? target.replace('%L%', directoryForOutput) : target;
+    const targetPath = component ? target.replace(locationReplacement, directoryForOutput) : target;
     if (await fileExists(targetPath)) {
         throw new Error('A component with the provided name already exists. Please provide a unique name.');
     }

package/dist/functions/fetchConfig.js

@@ -0,0 +1,17 @@
+import findUp from 'find-up';
+import { setTimeout as sleep } from 'node:timers/promises';
+/**
+ * Fetches the configuration file asynchronously.
+ * It first tries to find the '.sapphirerc.json' file in the current working directory.
+ * If not found, it then tries to find the '.sapphirerc.yml' file.
+ * Returns a Promise that resolves to the configuration file as JSON if found, otherwise resolves to null.
+ * @returns A Promise that resolves to the configuration file as JSON if found, otherwise resolves to null.
+ */
+export async function fetchConfig() {
+    const configFileAsJson = await Promise.race([findUp('.sapphirerc.json', { cwd: '.' }), sleep(5000)]);
+    if (configFileAsJson) {
+        return configFileAsJson;
+    }
+    return Promise.race([findUp('.sapphirerc.yml', { cwd: '.' }), sleep(5000)]);
+}
+//# sourceMappingURL=fetchConfig.js.map

package/dist/functions/generateCommandFlow.js

@@ -0,0 +1,49 @@
+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';
+import { readFile } from 'node:fs/promises';
+import { setTimeout as sleep } from 'node:timers/promises';
+export async function generateCommandFlow(spinnerMessage, callback) {
+    const spinner = new Spinner(spinnerMessage).start();
+    const fail = (error, additionalExecution) => {
+        spinner.error({ text: error });
+        additionalExecution?.();
+        process.exit(1);
+    };
+    const configLocation = await fetchConfig();
+    if (!configLocation) {
+        return fail("Can't find the Sapphire CLI config.");
+    }
+    const config = configLocation.endsWith('json')
+        ? JSON.parse(await readFile(configLocation, 'utf8'))
+        : load(await readFile(configLocation, 'utf8'));
+    if (!config) {
+        return fail("Can't parse the Sapphire CLI config.");
+    }
+    const result = await Result.fromAsync(() => callback(config, configLocation.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)))
+    });
+}
+/**
+ * Fetches the configuration file asynchronously.
+ * It first tries to find the '.sapphirerc.json' file in the current working directory.
+ * If not found, it then tries to find the '.sapphirerc.yml' file.
+ * Returns a Promise that resolves to the configuration file as JSON if found, otherwise resolves to null.
+ * @returns A Promise that resolves to the configuration file as JSON if found, otherwise resolves to null.
+ */
+async function fetchConfig() {
+    const configFileAsJson = await Promise.race([findUp('.sapphirerc.json', { cwd: '.' }), sleep(5000)]);
+    if (configFileAsJson) {
+        return configFileAsJson;
+    }
+    return Promise.race([findUp('.sapphirerc.yml', { cwd: '.' }), sleep(5000)]);
+}
+//# sourceMappingURL=generateCommandFlow.js.map

package/dist/prompts/PromptNew.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire/cli",
-  "version": "1.9.0-pr-274.95d19e9.0",
+  "version": "1.9.0",
   "description": "CLI for Sapphire Framework",
   "author": "@sapphire",
   "license": "MIT",
@@ -34,6 +34,7 @@
   },
   "dependencies": {
     "@favware/colorette-spinner": "^1.0.1",
+    "@sapphire/node-utilities": "^1.0.0",
     "@sapphire/result": "^2.6.4",
     "colorette": "^2.0.20",
     "commander": "^11.1.0",
@@ -44,8 +45,8 @@
     "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^18.4.2",
-    "@commitlint/config-conventional": "^18.4.2",
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
     "@favware/cliff-jumper": "^2.2.3",
     "@favware/npm-deprecate": "^1.0.7",
     "@sapphire/decorators": "*",
@@ -55,20 +56,20 @@
     "@sapphire/prettier-config": "^2.0.0",
     "@sapphire/ts-config": "^5.0.0",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^20.9.2",
-    "@types/prompts": "^2.4.8",
-    "@typescript-eslint/eslint-plugin": "^6.11.0",
-    "@typescript-eslint/parser": "^6.11.0",
+    "@types/node": "^20.10.2",
+    "@types/prompts": "^2.4.9",
+    "@typescript-eslint/eslint-plugin": "^6.13.1",
+    "@typescript-eslint/parser": "^6.13.1",
     "cz-conventional-changelog": "^3.3.0",
     "discord.js": "*",
-    "eslint": "^8.54.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint": "^8.55.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.0.1",
     "globby": "^14.0.0",
     "lint-staged": "^15.1.0",
     "prettier": "^3.1.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.2"
   },
   "resolutions": {
     "ansi-regex": "^5.0.1",

package/templates/.sapphirerc.json.sapphire

@@ -1,4 +1,5 @@
 {
+	"$schema": "https://raw.githubusercontent.com/sapphiredev/cli/main/templates/schemas/.sapphirerc.scheme.json",
 	"projectLanguage": "{{language}}",
 	"locations": {
 		"base": "src",

package/templates/.sapphirerc.yml.sapphire

@@ -1,3 +1,4 @@
+$schema: "./node_modules/@sapphire/cli/templates/schemas/.sapphirerc.scheme.json"
 projectLanguage: "{{language}}"
 locations:
   base: src

package/templates/schemas/.sapphirerc.scheme.json

@@ -1,12 +1,13 @@
 {
-	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$schema": "https://json-schema.org/draft-04/schema#",
 	"title": "Sapphire CLI Config",
 	"description": "Scheme for Sapphire CLI Config (@sapphire/cli)",
 	"type": "object",
 	"properties": {
 		"projectLanguage": {
 			"description": "Project language (ts | js)",
-			"type": "string"
+			"type": "string",
+			"enum": ["ts", "js"]
 		},
 		"locations": {
 			"description": "Categories and their locations",

package/templates/components/_load.js.sapphire

@@ -1,3 +0,0 @@
-{ "category": "_load" }
----
-// import this file in your entry point (index.js) to load respective pieces

package/templates/components/_load.ts.sapphire

@@ -1,3 +0,0 @@
-{ "category": "_load" }
----
-// import this file in your entry point (index.js) to load respective pieces