@sitecore-content-sdk/cli 1.3.0-canary.7 → 1.3.0

package/dist/esm/scripts/project/component/generate-map.js

@@ -1,60 +1,62 @@
-import { watchItems } from '../../../utils/watch-items';
-import loadCliConfig from '../../../utils/load-config';
-/**
- * @param {Argv} yargs
- */
-export function builder(yargs) {
-    return yargs.command('generate-map', 'Generates component map based on provided paths', args, handler);
-}
-/**
- * @param {Argv} yargs
- */
-export function args(yargs) {
-    return yargs
-        .option('watch', {
-        requiresArg: false,
-        type: 'boolean',
-        describe: 'If true, watches for changes in the specified paths and updates the component map accordingly.',
-        default: false,
-    })
-        .option('config', {
-        requiresArg: false,
-        type: 'string',
-        describe: 'Path to the `sitecore.cli.config` file. Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats',
-    });
-}
-/**
- * Handler for the `generate-map` command.
- * @param {GenerateMapCliArgs} argv Cli arguments for the command
- */
-export function handler(argv) {
-    const cliConfig = loadCliConfig(argv.config);
-    if (!cliConfig.componentMap) {
-        console.error('The `sitecore.cli.config` file is missing a `componentMap` configuration. Please add it to use this command.');
-        return;
-    }
-    const componentMapGenerator = cliConfig.componentMap.generator;
-    const { paths, destination, componentImports, exclude, clientComponentMap, includeVariants } = cliConfig.componentMap;
-    if (argv.watch) {
-        console.log(`Watching for component changes to component builder sources in:\n ${paths.join('\n')}`);
-        watchItems(paths, componentMapGenerator.bind(null, {
-            paths,
-            destination,
-            componentImports,
-            exclude,
-            clientComponentMap,
-            includeVariants,
-        }));
-    }
-    else {
-        console.log(`Generating component map for:\n ${paths.join('\n')}`);
-        componentMapGenerator({
-            paths,
-            destination,
-            componentImports,
-            exclude,
-            clientComponentMap,
-            includeVariants,
-        });
-    }
-}
+import { watchItems } from '../../../utils/watch-items';
+import loadCliConfig from '../../../utils/load-config';
+/**
+ * @param {Argv} yargs
+ */
+export function builder(yargs) {
+    return yargs.command(['generate-map', 'g'], 'Generates component map based on provided paths', args, handler);
+}
+/**
+ * @param {Argv} yargs
+ */
+export function args(yargs) {
+    return yargs
+        .option('watch', {
+        requiresArg: false,
+        type: 'boolean',
+        describe: 'If true, watches for changes in the specified paths and updates the component map accordingly.',
+        default: false,
+        alias: 'w',
+    })
+        .option('config', {
+        requiresArg: false,
+        type: 'string',
+        describe: 'Path to the `sitecore.cli.config` file. Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats',
+        alias: 'c',
+    });
+}
+/**
+ * Handler for the `generate-map` command.
+ * @param {GenerateMapCliArgs} argv Cli arguments for the command
+ */
+export function handler(argv) {
+    const cliConfig = loadCliConfig(argv.config);
+    if (!cliConfig.componentMap) {
+        console.error('The `sitecore.cli.config` file is missing a `componentMap` configuration. Please add it to use this command.');
+        return;
+    }
+    const componentMapGenerator = cliConfig.componentMap.generator;
+    const { paths, destination, componentImports, exclude, clientComponentMap, includeVariants } = cliConfig.componentMap;
+    if (argv.watch) {
+        console.log(`Watching for component changes to component builder sources in:\n ${paths.join('\n')}`);
+        watchItems(paths, componentMapGenerator.bind(null, {
+            paths,
+            destination,
+            componentImports,
+            exclude,
+            clientComponentMap,
+            includeVariants,
+        }));
+    }
+    else {
+        console.log(`Generating component map for:\n ${paths.join('\n')}`);
+        componentMapGenerator({
+            paths,
+            destination,
+            componentImports,
+            exclude,
+            clientComponentMap,
+            includeVariants,
+        });
+    }
+}

package/dist/esm/scripts/project/component/index.js

@@ -1,21 +1,21 @@
-import * as scaffold from './scaffold';
-import * as generateMap from './generate-map';
-/**
- * @param {Argv} yargs
- */
-export function builder(yargs) {
-    return yargs.command({
-        command: 'component',
-        describe: 'Performs component level operations',
-        builder: (_yargs) => {
-            _yargs = _yargs
-                .command([scaffold, generateMap])
-                .strict()
-                .demandCommand(1, 'You need to specify a command to run');
-            _yargs = scaffold.builder(_yargs);
-            _yargs = generateMap.builder(_yargs);
-            return _yargs;
-        },
-        handler: () => { },
-    });
-}
+import * as scaffold from './scaffold';
+import * as generateMap from './generate-map';
+/**
+ * @param {Argv} yargs
+ */
+export function builder(yargs) {
+    return yargs.command({
+        command: ['component', 'c'],
+        describe: 'Performs component level operations',
+        builder: (_yargs) => {
+            _yargs = _yargs
+                .command([scaffold, generateMap])
+                .strict()
+                .demandCommand(1, 'You need to specify a command to run');
+            _yargs = scaffold.builder(_yargs);
+            _yargs = generateMap.builder(_yargs);
+            return _yargs;
+        },
+        handler: () => { },
+    });
+}

package/dist/esm/scripts/project/component/scaffold.js

@@ -1,60 +1,63 @@
-import { scaffoldComponent } from '@sitecore-content-sdk/core/tools';
-import loadCliConfig from '../../../utils/load-config';
-import { ComponentTemplateType } from '@sitecore-content-sdk/core/config';
-/**
- * @param {Argv} yargs
- */
-export function builder(yargs) {
-    return yargs.command('scaffold <componentName>', 'Scaffolds a new component', args, handler);
-}
-/**
- * @param {Argv} yargs
- */
-export function args(yargs) {
-    return yargs
-        .positional('componentName', {
-        requiresArg: true,
-        positional: true,
-        type: 'string',
+import { scaffoldComponent } from '@sitecore-content-sdk/core/tools';
+import loadCliConfig from '../../../utils/load-config';
+import { ComponentTemplateType } from '@sitecore-content-sdk/core/config';
+/**
+ * @param {Argv} yargs
+ */
+export function builder(yargs) {
+    return yargs.command(['scaffold <componentName>', 's <componentName>'], 'Scaffolds a new component', args, handler);
+}
+/**
+ * @param {Argv} yargs
+ */
+export function args(yargs) {
+    return yargs
+        .positional('componentName', {
+        requiresArg: true,
+        positional: true,
+        type: 'string',
         describe: `Name of the component to scaffold. Component name should start with an uppercase letter and contain only letters, numbers,
-dashes, or underscores. It can also contain slashes to indicate a subfolder. Example: MyComponent or MyFolder/MyComponent. If no subfolder is specified, the component will be created under 'src/components'.`,
-    })
-        .option('config', {
-        requiresArg: false,
-        type: 'string',
-        describe: 'Path to the `sitecore.cli.config` file. Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats',
-    })
-        .option('templateName', {
-        requiresArg: false,
-        type: 'string',
-        describe: 'Name of the template that will be used to scaffold the component. Can be configured in the cli.config.',
-    })
-        .option('byoc', {
-        requiresArg: false,
-        type: 'boolean',
-        describe: 'If true, scaffolds a byoc component.',
-        default: false,
-    });
-}
-/**
- * Handler for the scaffold command.
- * @param {ScaffoldArgs} argv - The arguments passed to the command.
- */
-export function handler(argv) {
-    var _a;
-    if (!argv.componentName) {
-        throw new Error('Component name is required. Usage: sitecore-tools scaffold <ComponentName>');
-    }
-    const nameParamFormat = new RegExp(/^((?:[\w\-]+\/)*)([A-Z][\w-]+)$/);
-    const regExResult = nameParamFormat.exec(argv.componentName);
-    if (regExResult === null) {
+dashes, or underscores. It can also contain slashes to indicate a subfolder. Example: MyComponent or MyFolder/MyComponent. If no subfolder is specified, the component will be created under 'src/components'.`,
+    })
+        .option('config', {
+        requiresArg: false,
+        type: 'string',
+        describe: 'Path to the `sitecore.cli.config` file. Supports both JavaScript (`.js`) and TypeScript (`.ts`) formats',
+        alias: 'c',
+    })
+        .option('templateName', {
+        requiresArg: false,
+        type: 'string',
+        describe: 'Name of the template that will be used to scaffold the component. Can be configured in the cli.config.',
+        alias: 't',
+    })
+        .option('byoc', {
+        requiresArg: false,
+        type: 'boolean',
+        describe: 'If true, scaffolds a byoc component.',
+        default: false,
+        alias: 'b',
+    });
+}
+/**
+ * Handler for the scaffold command.
+ * @param {ScaffoldArgs} argv - The arguments passed to the command.
+ */
+export function handler(argv) {
+    var _a;
+    if (!argv.componentName) {
+        throw new Error('Component name is required. Usage: sitecore-tools scaffold <ComponentName>');
+    }
+    const nameParamFormat = new RegExp(/^((?:[\w\-]+\/)*)([A-Z][\w-]+)$/);
+    const regExResult = nameParamFormat.exec(argv.componentName);
+    if (regExResult === null) {
         throw new Error(`Component name should start with an uppercase letter and contain only letters, numbers,
-dashes, or underscores. It can also contain slashes to indicate a subfolder`);
-    }
-    const cliConfig = loadCliConfig(argv.config);
-    const componentPath = regExResult[1];
-    const componentName = regExResult[2];
-    const outputFolder = componentPath || 'src/components';
-    const templateName = (_a = argv.templateName) !== null && _a !== void 0 ? _a : (argv.byoc ? ComponentTemplateType.BYOC : ComponentTemplateType.DEFAULT);
-    scaffoldComponent(outputFolder, componentName, templateName, cliConfig.scaffold.templates);
-}
+dashes, or underscores. It can also contain slashes to indicate a subfolder`);
+    }
+    const cliConfig = loadCliConfig(argv.config);
+    const componentPath = regExResult[1];
+    const componentName = regExResult[2];
+    const outputFolder = componentPath || 'src/components';
+    const templateName = (_a = argv.templateName) !== null && _a !== void 0 ? _a : (argv.byoc ? ComponentTemplateType.BYOC : ComponentTemplateType.DEFAULT);
+    scaffoldComponent(outputFolder, componentName, templateName, cliConfig.scaffold.templates);
+}

package/dist/esm/scripts/project/index.js

@@ -1,20 +1,20 @@
-import * as build from './build';
-import * as component from './component';
-/**
- * @param {Argv} yargs
- */
-export function builder(yargs) {
-    return yargs.command({
-        command: 'project',
-        describe: 'Performs project level operations',
-        builder: (_yargs) => {
-            _yargs = _yargs
-                .command([build, component])
-                .strict()
-                .demandCommand(1, 'You need to specify a command to run');
-            _yargs = component.builder(_yargs);
-            return _yargs;
-        },
-        handler: () => { },
-    });
-}
+import * as build from './build';
+import * as component from './component';
+/**
+ * @param {Argv} yargs
+ */
+export function builder(yargs) {
+    return yargs.command({
+        command: ['project', 'p'],
+        describe: 'Performs project level operations',
+        builder: (_yargs) => {
+            _yargs = _yargs
+                .command([build, component])
+                .strict()
+                .demandCommand(1, 'You need to specify a command to run');
+            _yargs = component.builder(_yargs);
+            return _yargs;
+        },
+        handler: () => { },
+    });
+}

package/dist/esm/utils/load-config.js

@@ -1,36 +1,36 @@
-import path from 'path';
-import fs from 'fs';
-import processEnv from './process-env';
-const tsx = require('tsx/cjs/api');
-/**
- * Loads Sitecore Content SDK CLI configuration from the specified file.
- * @param {string} [configFile] - The path to the configuration file.
- * @returns {SitecoreCliConfig} The default export from the configuration file.
- * @throws Will throw an error if the configuration file does not exist or does not have a default export.
- */
-export default function loadCliConfig(configFile) {
-    // If no config file is provided, try to load the default config file.
-    if (!configFile) {
-        configFile = './sitecore.cli.config.ts';
-        if (!fs.existsSync(path.resolve(process.cwd(), configFile))) {
-            configFile = './sitecore.cli.config.js';
-        }
-    }
-    else {
-        // configuration file/filepath has been provided
-        // the env variables have been already loaded from the current working directory, however the current command may be running outside of a context of a project
-        // if so try loading the env vars from the directory of the provided config file
-        const configFileDirectory = path.dirname(path.resolve(process.cwd(), configFile));
-        if (process.cwd() !== configFileDirectory) {
-            processEnv(configFileDirectory);
-        }
-    }
-    let cliConfig;
-    try {
-        cliConfig = tsx.require(path.resolve(process.cwd(), configFile), __filename);
-    }
-    catch (e) {
-        throw `Error while trying to load the cli configuration from ${configFile}. Error message: ${e.message}`;
-    }
-    return cliConfig.default;
-}
+import path from 'path';
+import fs from 'fs';
+import processEnv from './process-env';
+const tsx = require('tsx/cjs/api');
+/**
+ * Loads Sitecore Content SDK CLI configuration from the specified file.
+ * @param {string} [configFile] - The path to the configuration file.
+ * @returns {SitecoreCliConfig} The default export from the configuration file.
+ * @throws Will throw an error if the configuration file does not exist or does not have a default export.
+ */
+export default function loadCliConfig(configFile) {
+    // If no config file is provided, try to load the default config file.
+    if (!configFile) {
+        configFile = './sitecore.cli.config.ts';
+        if (!fs.existsSync(path.resolve(process.cwd(), configFile))) {
+            configFile = './sitecore.cli.config.js';
+        }
+    }
+    else {
+        // configuration file/filepath has been provided
+        // the env variables have been already loaded from the current working directory, however the current command may be running outside of a context of a project
+        // if so try loading the env vars from the directory of the provided config file
+        const configFileDirectory = path.dirname(path.resolve(process.cwd(), configFile));
+        if (process.cwd() !== configFileDirectory) {
+            processEnv(configFileDirectory);
+        }
+    }
+    let cliConfig;
+    try {
+        cliConfig = tsx.require(path.resolve(process.cwd(), configFile), __filename);
+    }
+    catch (e) {
+        throw `Error while trying to load the cli configuration from ${configFile}. Error message: ${e.message}`;
+    }
+    return cliConfig.default;
+}

package/dist/esm/utils/process-env.js

@@ -1,31 +1,31 @@
-import path from 'path';
-import * as dotenv from 'dotenv';
-import dotenvExpand from 'dotenv-expand';
-import { SITECORE_CLI_MODE_ENV_VAR } from '@sitecore-content-sdk/core/config-cli';
-/**
- * Loads and processes environment variables from `.env` files in the specified directory.
- * It supports multiple `.env` files, including
- * environment-specific files (e.g., `.env.development`, `.env.production`) and local overrides
- * (e.g., `.env.local`, `.env.development.local`).
- * @param {string} dir - The directory to search for `.env` files.
- */
-export default function processEnv(dir) {
-    // replicate Next.js handling/behavior, but without a default NODE_ENV
-    // https://github.com/vercel/next.js/blob/v10.0.5/packages/next-env/index.ts#L80-L90
-    const mode = process.env.NODE_ENV;
-    const dotenvFiles = [
-        mode && `.env.${mode}.local`,
-        // Don't include `.env.local` for `test` environment
-        // since normally you expect tests to produce the same
-        // results for everyone
-        mode !== 'test' && '.env.local',
-        mode && `.env.${mode}`,
-        '.env',
-    ].filter(Boolean);
-    // Set the environment variable to indicate that the application is running in CLI mode
-    process.env[SITECORE_CLI_MODE_ENV_VAR] = 'true';
-    // inspired by https://github.com/entropitor/dotenv-cli/blob/v4.0.0/cli.js#L53-L55
-    dotenvFiles.forEach(function (env) {
-        dotenvExpand.expand(dotenv.config({ path: path.resolve(dir, env) }));
-    });
-}
+import path from 'path';
+import * as dotenv from 'dotenv';
+import dotenvExpand from 'dotenv-expand';
+import { SITECORE_CLI_MODE_ENV_VAR } from '@sitecore-content-sdk/core/config-cli';
+/**
+ * Loads and processes environment variables from `.env` files in the specified directory.
+ * It supports multiple `.env` files, including
+ * environment-specific files (e.g., `.env.development`, `.env.production`) and local overrides
+ * (e.g., `.env.local`, `.env.development.local`).
+ * @param {string} dir - The directory to search for `.env` files.
+ */
+export default function processEnv(dir) {
+    // replicate Next.js handling/behavior, but without a default NODE_ENV
+    // https://github.com/vercel/next.js/blob/v10.0.5/packages/next-env/index.ts#L80-L90
+    const mode = process.env.NODE_ENV;
+    const dotenvFiles = [
+        mode && `.env.${mode}.local`,
+        // Don't include `.env.local` for `test` environment
+        // since normally you expect tests to produce the same
+        // results for everyone
+        mode !== 'test' && '.env.local',
+        mode && `.env.${mode}`,
+        '.env',
+    ].filter(Boolean);
+    // Set the environment variable to indicate that the application is running in CLI mode
+    process.env[SITECORE_CLI_MODE_ENV_VAR] = 'true';
+    // inspired by https://github.com/entropitor/dotenv-cli/blob/v4.0.0/cli.js#L53-L55
+    dotenvFiles.forEach(function (env) {
+        dotenvExpand.expand(dotenv.config({ path: path.resolve(dir, env) }));
+    });
+}

package/dist/esm/utils/watch-items.js

@@ -1,12 +1,12 @@
-import chokidar from 'chokidar';
-/**
- * Run watch mode, watching on @var paths
- * @param {string[]} paths paths to watch by chokidar
- * @param {Function<void>} cb callback to run on file change
- */
-export function watchItems(paths, cb) {
-    chokidar
-        .watch(paths, { ignoreInitial: true, awaitWriteFinish: true })
-        .on('add', cb)
-        .on('unlink', cb);
-}
+import chokidar from 'chokidar';
+/**
+ * Run watch mode, watching on @var paths
+ * @param {string[]} paths paths to watch by chokidar
+ * @param {Function<void>} cb callback to run on file change
+ */
+export function watchItems(paths, cb) {
+    chokidar
+        .watch(paths, { ignoreInitial: true, awaitWriteFinish: true })
+        .on('add', cb)
+        .on('unlink', cb);
+}