directus-template-cli 0.7.0-beta.1 → 0.7.0-beta.11

package/dist/commands/init.js

@@ -1,16 +1,60 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const core_1 = require("@oclif/core");
-const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
-const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const init_1 = require("../lib/init");
-const github_1 = require("../services/github");
-class InitCommand extends core_1.Command {
-    constructor() {
-        super(...arguments);
-        this.targetDir = '.';
-    }
+import { confirm, intro, select, text, isCancel, cancel, log as clackLog } 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/index.js';
+import { animatedBunny } from '../lib/utils/animated-bunny.js';
+import { createGitHub } from '../services/github.js';
+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: '.',
+            description: 'Directory to create the project in',
+            required: false,
+        }),
+    };
+    static description = 'Initialize a new Directus + Frontend monorepo using official or community starters.';
+    static examples = [
+        '$ directus-template-cli init',
+        '$ directus-template-cli init my-project',
+        '$ 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({
+            description: 'Frontend framework to use (e.g., nextjs, nuxt, astro)',
+        }),
+        gitInit: Flags.boolean({
+            aliases: ['git-init'],
+            allowNo: true,
+            default: true,
+            description: 'Initialize a new Git repository',
+        }),
+        installDeps: Flags.boolean({
+            aliases: ['install-deps'],
+            allowNo: true,
+            default: true,
+            description: 'Install dependencies automatically',
+        }),
+        overrideDir: Flags.boolean({
+            default: false,
+            description: 'Override the default directory',
+        }),
+        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 = '.';
     /**
      * Entrypoint for the command.
      * @returns Promise that resolves when the command is complete.
@@ -18,175 +62,185 @@ class InitCommand extends core_1.Command {
     async run() {
         const { args, flags } = await this.parse(InitCommand);
         const typedFlags = flags;
+        const typedArgs = args;
         // Set the target directory and create it if it doesn't exist
-        this.targetDir = node_path_1.default.resolve(args.directory);
-        // if (!fs.existsSync(this.targetDir)) {
-        //   fs.mkdirSync(this.targetDir, {recursive: true})
-        // }
-        await (typedFlags.programmatic ? this.runProgrammatic(typedFlags) : this.runInteractive(typedFlags));
+        this.targetDir = path.resolve(args.directory);
+        await this.runInteractive(typedFlags, typedArgs);
     }
     /**
      * Interactive mode: prompts the user for each piece of info, with added template checks.
      * @param flags - The flags passed to the command.
+     * @param args - The arguments passed to the command.
      * @returns void
      */
-    async runInteractive(flags) {
-        core_1.ux.styledHeader('Directus Template CLI - Init');
+    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 = (0, github_1.createGitHub)();
+        const github = createGitHub();
+        // If no dir is provided, ask for it
+        if (!args.directory || args.directory === '.') {
+            let dirResponse = await text({
+                message: 'Enter the directory to create the project in:',
+                placeholder: './my-directus-project',
+            });
+            if (isCancel(dirResponse)) {
+                cancel('Project creation cancelled.');
+                process.exit(0);
+            }
+            // If there's no response, set a default
+            if (!dirResponse) {
+                clackLog.warn('No directory provided, using default: ./my-directus-project');
+                dirResponse = './my-directus-project';
+            }
+            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 inquirer_1.default
-                .prompt([
-                {
-                    choices: availableTemplates,
-                    message: 'Which Directus starters template would you like to use?',
-                    name: 'template',
-                    type: 'list',
-                },
-            ])
-                .then(ans => ans.template);
+            const templateResponse = await select({
+                message: 'Which Directus backend template would you like to use?',
+                options: availableTemplates.map(template => ({
+                    label: template,
+                    value: template,
+                })),
+            });
+            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.`);
-            template = await core_1.ux.prompt('Please enter a valid template name, or Ctrl+C to cancel:');
+            const templateNameResponse = await text({
+                message: 'Please enter a valid template name, or Ctrl+C to cancel:',
+            });
+            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.`);
-        }
-        // 4. If user hasn't specified a valid flags.frontend, ask from the list
+        // 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;
-        if (!chosenFrontend || !potentialFrontends.includes(chosenFrontend)) {
-            chosenFrontend = await inquirer_1.default
-                .prompt([
-                {
-                    choices: potentialFrontends,
+        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?',
-                    name: 'chosenFrontend',
-                    type: 'list',
-                },
-            ])
-                .then(ans => ans.chosenFrontend);
+                    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;
         }
-        flags.frontend = chosenFrontend;
-        // 5. Continue with the rest of the interactive flow:
-        // if (!this.checkDockerInstalled()) {
-        //   const {installDocker} = await inquirer.prompt<{ installDocker: boolean }>([
-        //     {
-        //       default: false,
-        //       message: 'Docker is not installed. Do you want to install Docker?',
-        //       name: 'installDocker',
-        //       type: 'confirm',
-        //     },
-        //   ])
-        //   if (installDocker) {
-        //     ux.log('Please follow Docker\'s official instructions to install Docker, then re-run the init command.')
-        //     this.exit(0)
-        //   }
-        // }
-        const { installDeps } = await inquirer_1.default.prompt([
-            {
-                default: true,
-                message: 'Would you like to install project dependencies automatically?',
-                name: 'installDeps',
-                type: 'confirm',
-            },
-        ]);
-        const { initGit } = await inquirer_1.default.prompt([
-            {
-                default: true,
-                message: 'Initialize a new Git repository?',
-                name: 'initGit',
-                type: 'confirm',
-            },
-        ]);
-        await (0, init_1.init)(this.targetDir, {
-            frontend: chosenFrontend,
-            gitInit: initGit,
-            installDeps,
-            template,
-        });
-    }
-    /**
-     * 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 = (0, github_1.createGitHub)();
-        if (!flags.template) {
-            core_1.ux.error('Missing --template parameter for programmatic mode.');
+        finally {
+            // Clean up temporary directory
+            if (fs.existsSync(tempDir)) {
+                fs.rmSync(tempDir, { recursive: true, force: true });
+            }
         }
-        if (!flags.frontend) {
-            core_1.ux.error('Missing --frontend parameter for programmatic mode.');
+        const installDepsResponse = await confirm({
+            initialValue: true,
+            message: 'Would you like to install project dependencies automatically?',
+        });
+        if (isCancel(installDepsResponse)) {
+            cancel('Project creation cancelled.');
+            process.exit(0);
         }
-        const template = flags.template;
-        const directories = await github.getTemplateDirectories(template);
-        if (directories.length === 0) {
-            core_1.ux.error(`Template "${template}" doesn't seem to exist in directus-labs/directus-starters.`);
+        const installDeps = installDepsResponse;
+        const initGitResponse = await confirm({
+            initialValue: true,
+            message: 'Initialize a new Git repository?',
+        });
+        if (isCancel(initGitResponse)) {
+            cancel('Project creation cancelled.');
+            process.exit(0);
         }
-        const potentialFrontends = directories.filter(dir => dir !== 'directus');
-        const frontend = flags.frontend;
-        if (!potentialFrontends.includes(frontend)) {
-            core_1.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 (0, init_1.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);
     }
 }
-InitCommand.args = {
-    directory: core_1.Args.directory({
-        default: '.',
-        description: 'Directory to create the project in',
-        required: false,
-    }),
-};
-InitCommand.description = 'Initialize a new Directus + Frontend monorepo using official or community starters.';
-InitCommand.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',
-];
-InitCommand.flags = {
-    frontend: core_1.Flags.string({
-        description: 'Frontend framework to use (e.g., nextjs, nuxt, astro)',
-    }),
-    gitInit: core_1.Flags.boolean({
-        aliases: ['git-init'],
-        allowNo: true,
-        default: true,
-        description: 'Initialize a new Git repository',
-    }),
-    installDeps: core_1.Flags.boolean({
-        aliases: ['install-deps'],
-        allowNo: true,
-        default: true,
-        description: 'Install dependencies automatically',
-    }),
-    overrideDir: core_1.Flags.boolean({
-        default: false,
-        description: 'Override the default directory',
-    }),
-    programmatic: core_1.Flags.boolean({
-        char: 'p',
-        default: false,
-        description: 'Run in programmatic mode (non-interactive)',
-    }),
-    template: core_1.Flags.string({
-        description: 'Template name (e.g., simple-cms) or GitHub URL (e.g., https://github.com/directus-labs/starters/tree/main/simple-cms)',
-    }),
-};
-exports.default = InitCommand;

package/dist/flags/common.d.ts

@@ -1,7 +1,8 @@
-export declare const directusToken: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-export declare const directusUrl: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-export declare const userEmail: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-export declare const userPassword: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-export declare const programmatic: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-export declare const templateLocation: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-export declare const templateName: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+export declare const directusToken: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+export declare const directusUrl: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+export declare const userEmail: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+export declare const userPassword: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+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

@@ -1,41 +1,43 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.templateName = exports.templateLocation = exports.programmatic = exports.userPassword = exports.userEmail = exports.directusUrl = exports.directusToken = void 0;
-const core_1 = require("@oclif/core");
-exports.directusToken = core_1.Flags.string({
+import { Flags } from '@oclif/core';
+export const directusToken = Flags.string({
     description: 'Token to use for the Directus instance',
     env: 'DIRECTUS_TOKEN',
     exclusive: ['userEmail', 'userPassword'],
 });
-exports.directusUrl = core_1.Flags.string({
+export const directusUrl = Flags.string({
     description: 'URL of the Directus instance',
     env: 'DIRECTUS_URL',
 });
-exports.userEmail = core_1.Flags.string({
+export const userEmail = Flags.string({
     dependsOn: ['userPassword'],
     description: 'Email for Directus authentication',
     env: 'DIRECTUS_EMAIL',
     exclusive: ['directusToken'],
 });
-exports.userPassword = core_1.Flags.string({
+export const userPassword = Flags.string({
     dependsOn: ['userEmail'],
     description: 'Password for Directus authentication',
     env: 'DIRECTUS_PASSWORD',
     exclusive: ['directusToken'],
 });
-exports.programmatic = core_1.Flags.boolean({
+export const programmatic = Flags.boolean({
     char: 'p',
     default: false,
     description: 'Run in programmatic mode (non-interactive) for use cases such as CI/CD pipelines.',
     summary: 'Run in programmatic mode',
 });
-exports.templateLocation = core_1.Flags.string({
+export const templateLocation = Flags.string({
     dependsOn: ['programmatic'],
     description: 'Location of the template',
     env: 'TEMPLATE_LOCATION',
 });
-exports.templateName = core_1.Flags.string({
+export const templateName = Flags.string({
     dependsOn: ['programmatic'],
     description: 'Name of the template',
     env: 'TEMPLATE_NAME',
 });
+export const disableTelemetry = Flags.boolean({
+    default: false,
+    description: 'Disable telemetry',
+    env: 'DISABLE_TELEMETRY',
+});

package/dist/index.js

@@ -1,5 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = void 0;
-var core_1 = require("@oclif/core");
-Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });
+export { run } from '@oclif/core';

package/dist/lib/constants.d.ts

@@ -1,15 +1,12 @@
 export declare const DIRECTUS_PURPLE = "#6644ff";
 export declare const DIRECTUS_PINK = "#FF99DD";
 export declare const SEPARATOR = "------------------";
+export declare const pinkText: import("chalk").ChalkInstance;
+export declare const purpleText: import("chalk").ChalkInstance;
 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 +14,8 @@ 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";
+export declare const BSL_LICENSE_URL = "https://directus.io/bsl";
+export declare const BSL_LICENSE_TEXT: string;

package/dist/lib/constants.js

@@ -1,22 +1,25 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_REPO = exports.STARTERS_TEMPLATE_REPO = exports.COMMUNITY_TEMPLATE_REPO = exports.SEPARATOR = exports.DIRECTUS_PINK = exports.DIRECTUS_PURPLE = void 0;
-exports.DIRECTUS_PURPLE = '#6644ff';
-exports.DIRECTUS_PINK = '#FF99DD';
-exports.SEPARATOR = '------------------';
-exports.COMMUNITY_TEMPLATE_REPO = {
+import chalk from 'chalk';
+import terminalLink from 'terminal-link';
+export const DIRECTUS_PURPLE = '#6644ff';
+export const DIRECTUS_PINK = '#FF99DD';
+export const SEPARATOR = '------------------';
+export const pinkText = chalk.hex(DIRECTUS_PINK);
+export const purpleText = chalk.hex(DIRECTUS_PURPLE);
+export const COMMUNITY_TEMPLATE_REPO = {
     string: 'github:directus-labs/directus-templates',
     url: 'https://github.com/directus-labs/directus-templates',
 };
-exports.STARTERS_TEMPLATE_REPO = {
-    branch: 'cms-template',
-    string: 'github:directus-labs/starters',
-    url: 'https://github.com/directus-labs/starters',
-};
-exports.DEFAULT_REPO = {
+export const DEFAULT_REPO = {
     owner: 'directus-labs',
     path: '',
-    ref: 'cms-template',
+    ref: 'main',
     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';
+export const BSL_LICENSE_URL = 'https://directus.io/bsl';
+const BSL_LINK = terminalLink(BSL_LICENSE_URL, BSL_LICENSE_URL);
+const BSL_MAILTO = terminalLink('sales-demo-with-evil-sales@directus.io', 'mailto:sales-demo-with-evil-sales@directus.io');
+export const BSL_LICENSE_TEXT = `You REQUIRE a license to use Directus if your organisation has more than $5MM USD a year in revenue and/or funding.\nFor all organizations with less than $5MM USD a year in revenue and funding, Directus is free for personal projects, hobby projects and in production. This second group does not require a license. \nDirectus is licensed under BSL1.1. Visit ${pinkText(BSL_LINK)} for more information or reach out to us at ${pinkText(BSL_MAILTO)}.`;

package/dist/lib/extract/extract-access.js

@@ -1,15 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const core_1 = require("@oclif/core");
-const constants_1 = require("../constants");
-const sdk_1 = require("../sdk");
-const catch_error_1 = tslib_1.__importDefault(require("../utils/catch-error"));
-const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
-async function extractAccess(dir) {
-    core_1.ux.action.start(core_1.ux.colorize(constants_1.DIRECTUS_PINK, 'Extracting access'));
+import { ux } from '@oclif/core';
+import { DIRECTUS_PINK } from '../constants.js';
+import { api } from '../sdk.js';
+import catchError from '../utils/catch-error.js';
+import writeToFile from '../utils/write-to-file.js';
+export default async function extractAccess(dir) {
+    ux.action.start(ux.colorize(DIRECTUS_PINK, 'Extracting access'));
     try {
-        const response = await sdk_1.api.client.request(() => ({
+        const response = await api.client.request(() => ({
             method: 'GET',
             path: '/access?limit=-1',
         }));
@@ -17,11 +14,10 @@ async function extractAccess(dir) {
         // for (const access of response) {
         //   delete access.id
         // }
-        await (0, write_to_file_1.default)('access', response, dir);
+        await writeToFile('access', response, dir);
     }
     catch (error) {
-        (0, catch_error_1.default)(error);
+        catchError(error);
     }
-    core_1.ux.action.stop();
+    ux.action.stop();
 }
-exports.default = extractAccess;