directus-template-cli 0.7.0-beta.5 → 0.7.0-beta.7

package/bin/dev.js

@@ -1,3 +1,6 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+// eslint-disable-next-line n/shebang
 import {execute} from '@oclif/core'
 
 await execute({development: true, dir: import.meta.url})

package/dist/commands/apply.js

@@ -1,8 +1,9 @@
 import { Command, Flags, ux } from '@oclif/core';
-import { text, select, password } from '@clack/prompts';
+import { text, select, password, log, intro } from '@clack/prompts';
 import * as path from 'pathe';
+import { animatedBunny } from '../lib/utils/animated-bunny.js';
 import * as customFlags from '../flags/common.js';
-import { DIRECTUS_PINK, SEPARATOR } from '../lib/constants.js';
+import { DIRECTUS_PINK, DIRECTUS_PURPLE, SEPARATOR } from '../lib/constants.js';
 import { validateInteractiveFlags, validateProgrammaticFlags } from '../lib/load/apply-flags.js';
 import apply from '../lib/load/index.js';
 import { getDirectusToken, getDirectusUrl, initializeDirectusApi } from '../lib/utils/auth.js';
@@ -10,6 +11,7 @@ import catchError from '../lib/utils/catch-error.js';
 import { getCommunityTemplates, getGithubTemplate, getInteractiveLocalTemplate, getLocalTemplate } from '../lib/utils/get-template.js';
 import { logger } from '../lib/utils/logger.js';
 import openUrl from '../lib/utils/open-url.js';
+import chalk from 'chalk';
 export default class ApplyCommand extends Command {
     static description = 'Apply a template to a blank Directus instance.';
     static examples = [
@@ -102,7 +104,9 @@ export default class ApplyCommand extends Command {
      */
     async runInteractive(flags) {
         const validatedFlags = validateInteractiveFlags(flags);
-        // /* TODO: Replace with custom styledHeader function */ ux.styledHeader(ux.colorize(DIRECTUS_PURPLE, 'Directus Template CLI - Apply'))
+        // Show animated intro
+        await animatedBunny('Let\'s apply a template!');
+        intro(`${chalk.bgHex(DIRECTUS_PURPLE).white.bold('Directus Template CLI')} - Apply Template`);
         const templateType = await select({
             options: [
                 { label: 'Community templates', value: 'community' },
@@ -139,12 +143,11 @@ export default class ApplyCommand extends Command {
             }
             case 'directus-plus': {
                 openUrl('https://directus.io/plus?utm_source=directus-template-cli&utm_content=apply-command');
-                ux.stdout('Redirecting to Directus website.');
+                log.info('Redirecting to Directus website.');
                 ux.exit(0);
             }
         }
-        ux.stdout(`You selected ${ux.colorize(DIRECTUS_PINK, template.templateName)}`);
-        ux.stdout(SEPARATOR);
+        log.info(`You selected ${ux.colorize(DIRECTUS_PINK, template.templateName)}`);
         // Get Directus URL
         const directusUrl = await getDirectusUrl();
         validatedFlags.directusUrl = directusUrl;

package/dist/commands/base.d.ts

@@ -0,0 +1,15 @@
+import { Command, type Config } from '@oclif/core';
+interface UserConfig {
+    distinctId?: string | null;
+}
+export declare abstract class BaseCommand extends Command {
+    runId: string;
+    userConfig: UserConfig;
+    constructor(argv: string[], config: Config);
+    private loadUserConfig;
+    /**
+     * Save the current user configuration to disk
+     */
+    protected saveUserConfig(): void;
+}
+export {};

package/dist/commands/base.js

@@ -0,0 +1,45 @@
+import { Command } from '@oclif/core';
+import { randomUUID } from 'node:crypto';
+import fs from 'node:fs';
+import path from 'pathe';
+export class BaseCommand extends Command {
+    runId;
+    userConfig = {};
+    constructor(argv, config) {
+        super(argv, config);
+        this.runId = randomUUID();
+        this.loadUserConfig();
+    }
+    loadUserConfig() {
+        try {
+            const configPath = path.join(this.config.configDir, 'config.json');
+            if (fs.existsSync(configPath)) {
+                this.userConfig = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+            }
+            else {
+                // Create default config if it doesn't exist
+                const defaultConfig = {
+                    distinctId: randomUUID(),
+                };
+                fs.mkdirSync(this.config.configDir, { recursive: true });
+                fs.writeFileSync(configPath, JSON.stringify(defaultConfig, null, 2));
+                this.userConfig = defaultConfig;
+            }
+        }
+        catch (error) {
+            this.warn(`Failed to load user config: ${error}`);
+        }
+    }
+    /**
+     * Save the current user configuration to disk
+     */
+    saveUserConfig() {
+        try {
+            const configPath = path.join(this.config.configDir, 'config.json');
+            fs.writeFileSync(configPath, JSON.stringify(this.userConfig, null, 2));
+        }
+        catch (error) {
+            this.warn(`Failed to save user config: ${error}`);
+        }
+    }
+}

package/dist/commands/extract.d.ts

@@ -1,4 +1,13 @@
 import { Command } from '@oclif/core';
+export interface ExtractFlags {
+    directusToken: string;
+    directusUrl: string;
+    programmatic: boolean;
+    templateLocation: string;
+    templateName: string;
+    userEmail: string;
+    userPassword: string;
+}
 export default class ExtractCommand extends Command {
     static description: string;
     static examples: string[];
@@ -36,12 +45,6 @@ export default class ExtractCommand extends Command {
      * @returns {Promise<void>} - Returns nothing
      */
     private runProgrammatic;
-    /**
-     * Helper function to create styled headers since ux.styledHeader is removed in v4
-     * @param text - The text to style as a header
-     * @returns {void}
-     */
-    private styledHeader;
     /**
      * Validates the flags for programmatic mode
      * @param {ExtractFlags} flags - The command flags to validate

package/dist/commands/extract.js

@@ -1,4 +1,4 @@
-import { text, password, select } from '@clack/prompts';
+import { text, password, select, intro } from '@clack/prompts';
 import { Command, ux } from '@oclif/core';
 import slugify from '@sindresorhus/slugify';
 import chalk from 'chalk';
@@ -6,6 +6,7 @@ import fs from 'node:fs';
 import path from 'pathe';
 import * as customFlags from '../flags/common.js';
 import { DIRECTUS_PINK, DIRECTUS_PURPLE, SEPARATOR } from '../lib/constants.js';
+import { animatedBunny } from '../lib/utils/animated-bunny.js';
 import extract from '../lib/extract/index.js';
 import { getDirectusToken, getDirectusUrl, initializeDirectusApi, validateAuthFlags } from '../lib/utils/auth.js';
 import catchError from '../lib/utils/catch-error.js';
@@ -74,7 +75,8 @@ export default class ExtractCommand extends Command {
      * @returns {Promise<void>} - Returns nothing
      */
     async runInteractive(flags) {
-        this.styledHeader(chalk.hex(DIRECTUS_PURPLE)('Directus Template CLI - Extract'));
+        await animatedBunny('Let\'s extract a template!');
+        intro(`${chalk.bgHex(DIRECTUS_PURPLE).white.bold('Directus Template CLI')} - Extract Template`);
         const templateName = await text({
             message: 'What is the name of the template you would like to extract?',
             placeholder: 'My Template',
@@ -126,17 +128,6 @@ export default class ExtractCommand extends Command {
         await initializeDirectusApi(flags);
         await this.extractTemplate(templateName, templateLocation, flags);
     }
-    /**
-     * Helper function to create styled headers since ux.styledHeader is removed in v4
-     * @param text - The text to style as a header
-     * @returns {void}
-     */
-    styledHeader(text) {
-        const padding = '═'.repeat(Math.max(0, text.length));
-        ux.stdout(`\n${padding}`);
-        ux.stdout(`${text}`);
-        ux.stdout(`${padding}\n`);
-    }
     /**
      * Validates the flags for programmatic mode
      * @param {ExtractFlags} flags - The command flags to validate

package/dist/commands/init.d.ts

@@ -1,5 +1,16 @@
-import { Command } from '@oclif/core';
-export default class InitCommand extends Command {
+import { BaseCommand } from './base.js';
+export interface InitFlags {
+    frontend?: string;
+    gitInit?: boolean;
+    installDeps?: boolean;
+    overrideDir?: boolean;
+    template?: string;
+    disableTelemetry?: boolean;
+}
+export interface InitArgs {
+    directory: string;
+}
+export default class InitCommand extends BaseCommand {
     static args: {
         directory: import("@oclif/core/interfaces").Arg<string, {
             exists?: boolean;
@@ -12,8 +23,8 @@ export default class InitCommand extends Command {
         gitInit: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         installDeps: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         overrideDir: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        programmatic: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         template: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        disableTelemetry: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     private targetDir;
     /**
@@ -28,10 +39,4 @@ export default class InitCommand extends Command {
      * @returns void
      */
     private runInteractive;
-    /**
-     * Programmatic mode: relies on flags only, with checks for template existence and valid frontend.
-     * @param flags - The flags passed to the command.
-     * @returns void
-     */
-    private runProgrammatic;
 }

package/dist/commands/init.js

@@ -1,12 +1,20 @@
-import { confirm, intro, select, text } from '@clack/prompts';
-import { Args, Command, Flags, ux } from '@oclif/core';
+import { confirm, intro, select, text, isCancel, cancel } from '@clack/prompts';
+import { Args, Flags, ux } from '@oclif/core';
 import chalk from 'chalk';
+import fs from 'node:fs';
+import os from 'node:os';
 import path from 'pathe';
+import { disableTelemetry } from '../flags/common.js';
 import { DIRECTUS_PURPLE } from '../lib/constants.js';
-import { init } from '../lib/init.js';
+import { init } from '../lib/init/index.js';
 import { animatedBunny } from '../lib/utils/animated-bunny.js';
 import { createGitHub } from '../services/github.js';
-export default class InitCommand extends Command {
+import { readTemplateConfig } from '../lib/utils/template-config.js';
+import { createGigetString, parseGitHubUrl } from '../lib/utils/parse-github-url.js';
+import { downloadTemplate } from 'giget';
+import { BaseCommand } from './base.js';
+import { track, shutdown } from '../services/posthog.js';
+export default class InitCommand extends BaseCommand {
     static args = {
         directory: Args.directory({
             default: '.',
@@ -18,8 +26,8 @@ export default class InitCommand extends Command {
     static examples = [
         '$ directus-template-cli init',
         '$ directus-template-cli init my-project',
-        '$ directus-template-cli init --frontend=nextjs --template=simple-cms --programmatic',
-        '$ directus-template-cli init my-project --frontend=nextjs --template=simple-cms --programmatic',
+        '$ directus-template-cli init --frontend=nextjs --template=simple-cms',
+        '$ directus-template-cli init my-project --frontend=nextjs --template=simple-cms',
     ];
     static flags = {
         frontend: Flags.string({
@@ -41,14 +49,10 @@ export default class InitCommand extends Command {
             default: false,
             description: 'Override the default directory',
         }),
-        programmatic: Flags.boolean({
-            char: 'p',
-            default: false,
-            description: 'Run in programmatic mode (non-interactive)',
-        }),
         template: Flags.string({
             description: 'Template name (e.g., simple-cms) or GitHub URL (e.g., https://github.com/directus-labs/starters/tree/main/simple-cms)',
         }),
+        disableTelemetry: disableTelemetry,
     };
     targetDir = '.';
     /**
@@ -61,10 +65,7 @@ export default class InitCommand extends Command {
         const typedArgs = args;
         // Set the target directory and create it if it doesn't exist
         this.targetDir = path.resolve(args.directory);
-        // if (!fs.existsSync(this.targetDir)) {
-        //   fs.mkdirSync(this.targetDir, {recursive: true})
-        // }
-        await (typedFlags.programmatic ? this.runProgrammatic(typedFlags) : this.runInteractive(typedFlags, typedArgs));
+        await this.runInteractive(typedFlags, typedArgs);
     }
     /**
      * Interactive mode: prompts the user for each piece of info, with added template checks.
@@ -73,104 +74,168 @@ export default class InitCommand extends Command {
      * @returns void
      */
     async runInteractive(flags, args) {
+        // Show animated intro
         await animatedBunny('Let\'s create a new Directus project!');
         intro(`${chalk.bgHex(DIRECTUS_PURPLE).white.bold('Directus Template CLI')} - Create Project`);
         // Create GitHub service
         const github = createGitHub();
         // If no dir is provided, ask for it
         if (!args.directory || args.directory === '.') {
-            this.targetDir = await text({
+            const dirResponse = await text({
                 message: 'Enter the directory to create the project in:',
                 placeholder: './my-directus-project',
-            }).then(ans => ans);
+            });
+            if (isCancel(dirResponse)) {
+                cancel('Project creation cancelled.');
+                process.exit(0);
+            }
+            this.targetDir = dirResponse;
+        }
+        if (fs.existsSync(this.targetDir) && !flags.overrideDir) {
+            const overrideDirResponse = await confirm({
+                message: 'Directory already exists. Would you like to overwrite it?',
+            });
+            if (isCancel(overrideDirResponse)) {
+                cancel('Project creation cancelled.');
+                process.exit(0);
+            }
+            if (overrideDirResponse) {
+                flags.overrideDir = true;
+            }
         }
         // 1. Fetch available templates
         const availableTemplates = await github.getTemplates();
         // 2. Prompt for template if not provided
         let { template } = flags;
         if (!template) {
-            template = await select({
+            const templateResponse = await select({
                 message: 'Which Directus backend template would you like to use?',
                 options: availableTemplates.map(template => ({
                     label: template,
                     value: template,
                 })),
-            }).then(ans => ans);
+            });
+            if (isCancel(templateResponse)) {
+                cancel('Project creation cancelled.');
+                process.exit(0);
+            }
+            template = templateResponse;
         }
         // 3. Validate that the template exists, fetch subdirectories
         let directories = await github.getTemplateDirectories(template);
-        while (directories.length === 0) {
+        const isDirectUrl = template?.startsWith('http');
+        while (!isDirectUrl && directories.length === 0) {
             this.log(`Template "${template}" doesn't seem to exist in directus-labs/directus-starters.`);
-            // ts-ignore no-await-in-loop
-            const templateName = await text({
+            const templateNameResponse = await text({
                 message: 'Please enter a valid template name, or Ctrl+C to cancel:',
             });
-            template = templateName;
-            // ts-ignore no-await-in-loop
+            if (isCancel(templateNameResponse)) {
+                cancel('Project creation cancelled.');
+                process.exit(0);
+            }
+            template = templateNameResponse;
             directories = await github.getTemplateDirectories(template);
         }
         flags.template = template;
-        // Filter out the 'directus' folder; the rest are potential frontends
-        const potentialFrontends = directories.filter(dir => dir !== 'directus');
-        if (potentialFrontends.length === 0) {
-            this.error(`No frontends found for template "${template}". Exiting.`);
+        // Download the template to a temporary directory to read its configuration
+        const tempDir = path.join(os.tmpdir(), `directus-template-${Date.now()}`);
+        let chosenFrontend = flags.frontend;
+        try {
+            await downloadTemplate(createGigetString(parseGitHubUrl(template)), {
+                dir: tempDir,
+                force: true,
+            });
+            // Read template configuration
+            const templateInfo = readTemplateConfig(tempDir);
+            // 4. If template has frontends and user hasn't specified a valid one, ask from the list
+            if (templateInfo?.frontendOptions.length > 0 && (!chosenFrontend || !templateInfo.frontendOptions.find(f => f.id === chosenFrontend))) {
+                const frontendResponse = await select({
+                    message: 'Which frontend framework do you want to use?',
+                    options: [
+                        ...templateInfo.frontendOptions.map(frontend => ({
+                            label: frontend.name,
+                            value: frontend.id,
+                        })),
+                        // { label: 'No frontend', value: '' },
+                    ],
+                });
+                if (isCancel(frontendResponse)) {
+                    cancel('Project creation cancelled.');
+                    process.exit(0);
+                }
+                chosenFrontend = frontendResponse;
+            }
+            flags.frontend = chosenFrontend;
         }
-        // 4. If user hasn't specified a valid flags.frontend, ask from the list
-        let { frontend: chosenFrontend } = flags;
-        if (!chosenFrontend || !potentialFrontends.includes(chosenFrontend)) {
-            chosenFrontend = await select({
-                message: 'Which frontend framework do you want to use?',
-                options: potentialFrontends.map(frontend => ({
-                    label: frontend,
-                    value: frontend,
-                })),
-            }).then(ans => ans);
+        finally {
+            // Clean up temporary directory
+            if (fs.existsSync(tempDir)) {
+                fs.rmSync(tempDir, { recursive: true, force: true });
+            }
         }
-        flags.frontend = chosenFrontend;
-        const installDeps = await confirm({
+        const installDepsResponse = await confirm({
             initialValue: true,
             message: 'Would you like to install project dependencies automatically?',
-        }).then(ans => ans);
-        const initGit = await confirm({
+        });
+        if (isCancel(installDepsResponse)) {
+            cancel('Project creation cancelled.');
+            process.exit(0);
+        }
+        const installDeps = installDepsResponse;
+        const initGitResponse = await confirm({
             initialValue: true,
             message: 'Initialize a new Git repository?',
-        }).then(ans => ans);
-        await init(this.targetDir, {
-            frontend: chosenFrontend,
-            gitInit: initGit,
-            installDeps,
-            template,
         });
-        ux.exit(0);
-    }
-    /**
-     * Programmatic mode: relies on flags only, with checks for template existence and valid frontend.
-     * @param flags - The flags passed to the command.
-     * @returns void
-     */
-    async runProgrammatic(flags) {
-        const github = createGitHub();
-        if (!flags.template) {
-            ux.error('Missing --template parameter for programmatic mode.');
+        if (isCancel(initGitResponse)) {
+            cancel('Project creation cancelled.');
+            process.exit(0);
         }
-        if (!flags.frontend) {
-            ux.error('Missing --frontend parameter for programmatic mode.');
-        }
-        const template = flags.template;
-        const directories = await github.getTemplateDirectories(template);
-        if (directories.length === 0) {
-            ux.error(`Template "${template}" doesn't seem to exist in directus-labs/directus-starters.`);
-        }
-        const potentialFrontends = directories.filter(dir => dir !== 'directus');
-        const frontend = flags.frontend;
-        if (!potentialFrontends.includes(frontend)) {
-            ux.error(`Frontend "${frontend}" doesn't exist in template "${template}". Available frontends: ${potentialFrontends.join(', ')}`);
+        const initGit = initGitResponse;
+        // Track the command start unless telemetry is disabled
+        if (!flags.disableTelemetry) {
+            await track({
+                lifecycle: 'start',
+                distinctId: this.userConfig.distinctId,
+                command: 'init',
+                flags: {
+                    frontend: chosenFrontend,
+                    gitInit: initGit,
+                    installDeps,
+                    template,
+                },
+                runId: this.runId,
+                config: this.config,
+            });
         }
-        await init(this.targetDir, {
-            frontend,
-            installDeps: true,
-            template,
+        // Initialize the project
+        await init({
+            dir: this.targetDir,
+            flags: {
+                frontend: chosenFrontend,
+                gitInit: initGit,
+                installDeps,
+                template,
+                overrideDir: flags.overrideDir,
+            },
         });
+        // Track the command completion unless telemetry is disabled
+        if (!flags.disableTelemetry) {
+            await track({
+                command: 'init',
+                lifecycle: 'complete',
+                distinctId: this.userConfig.distinctId,
+                flags: {
+                    frontend: chosenFrontend,
+                    gitInit: initGit,
+                    installDeps,
+                    template,
+                    overrideDir: flags.overrideDir,
+                },
+                runId: this.runId,
+                config: this.config,
+            });
+            await shutdown();
+        }
         ux.exit(0);
     }
 }

package/dist/flags/common.d.ts

@@ -5,3 +5,4 @@ export declare const userPassword: import("@oclif/core/interfaces").OptionFlag<s
 export declare const programmatic: import("@oclif/core/interfaces").BooleanFlag<boolean>;
 export declare const templateLocation: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
 export declare const templateName: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+export declare const disableTelemetry: import("@oclif/core/interfaces").BooleanFlag<boolean>;

package/dist/flags/common.js

@@ -36,3 +36,8 @@ export const templateName = Flags.string({
     description: 'Name of the template',
     env: 'TEMPLATE_NAME',
 });
+export const disableTelemetry = Flags.boolean({
+    default: false,
+    description: 'Disable telemetry',
+    env: 'DISABLE_TELEMETRY',
+});

package/dist/lib/constants.d.ts

@@ -5,11 +5,6 @@ export declare const COMMUNITY_TEMPLATE_REPO: {
     string: string;
     url: string;
 };
-export declare const STARTERS_TEMPLATE_REPO: {
-    branch: string;
-    string: string;
-    url: string;
-};
 export declare const DEFAULT_REPO: {
     owner: string;
     path: string;
@@ -17,3 +12,6 @@ export declare const DEFAULT_REPO: {
     repo: string;
     url: string;
 };
+export declare const POSTHOG_PUBLIC_KEY = "phc_STopE6gj6LDIjYonVF7493kQJK8S4v0Xrl6YPr2z9br";
+export declare const POSTHOG_HOST = "https://us.i.posthog.com";
+export declare const DEFAULT_BRANCH = "main";

package/dist/lib/constants.js

@@ -5,11 +5,6 @@ export const COMMUNITY_TEMPLATE_REPO = {
     string: 'github:directus-labs/directus-templates',
     url: 'https://github.com/directus-labs/directus-templates',
 };
-export const STARTERS_TEMPLATE_REPO = {
-    branch: 'cms-template',
-    string: 'github:directus-labs/starters',
-    url: 'https://github.com/directus-labs/starters',
-};
 export const DEFAULT_REPO = {
     owner: 'directus-labs',
     path: '',
@@ -17,3 +12,6 @@ export const DEFAULT_REPO = {
     repo: 'starters',
     url: 'https://github.com/directus-labs/starters',
 };
+export const POSTHOG_PUBLIC_KEY = 'phc_STopE6gj6LDIjYonVF7493kQJK8S4v0Xrl6YPr2z9br';
+export const POSTHOG_HOST = 'https://us.i.posthog.com';
+export const DEFAULT_BRANCH = 'main';

package/dist/lib/init/config.js

@@ -7,6 +7,6 @@ export const DIRECTUS_CONFIG = {
 export const DOCKER_CONFIG = {
     composeFile: 'docker-compose.yml',
     healthCheckEndpoint: '/server/health',
-    interval: 5000,
+    interval: 3000,
     maxAttempts: 30,
 };

package/dist/lib/init/index.d.ts

@@ -1,14 +1,10 @@
 import { type DownloadTemplateResult } from 'giget';
-interface InitFlags {
-    frontend?: string;
-    gitInit?: boolean;
-    installDeps?: boolean;
-    overrideDir?: boolean;
-    template?: string;
-}
-export declare function init(dir: string, flags: InitFlags): Promise<{
+import type { InitFlags } from '../../commands/init.js';
+export declare function init({ dir, flags }: {
+    dir: string;
+    flags: InitFlags;
+}): Promise<{
     directusDir: string;
     frontendDir: string;
     template: DownloadTemplateResult;
 }>;
-export {};