directus-template-cli 0.7.4 → 0.7.6

package/bin/dev.js

@@ -1,6 +1,5 @@
 #!/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/bin/run.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+/* eslint-disable n/no-unpublished-bin */
 
 import {execute} from '@oclif/core'
 

package/dist/commands/apply.d.ts

@@ -7,9 +7,11 @@ export default class ApplyCommand extends BaseCommand {
         dashboards: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         directusToken: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         directusUrl: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        disableTelemetry: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         extensions: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         files: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         flows: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        noExit: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         partial: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         permissions: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         programmatic: import("@oclif/core/interfaces").BooleanFlag<boolean>;
@@ -20,7 +22,6 @@ export default class ApplyCommand extends BaseCommand {
         userEmail: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         userPassword: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         users: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        disableTelemetry: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     /**
      * MAIN

package/dist/commands/apply.js

@@ -1,20 +1,19 @@
+import { intro, log, select, text } from '@clack/prompts';
 import { Flags, ux } from '@oclif/core';
-import { text, select, log, intro } from '@clack/prompts';
+import chalk from 'chalk';
 import * as path from 'pathe';
-import { animatedBunny } from '../lib/utils/animated-bunny.js';
 import * as customFlags from '../flags/common.js';
-import { DIRECTUS_PINK, DIRECTUS_PURPLE, SEPARATOR } from '../lib/constants.js';
+import { BSL_LICENSE_CTA, BSL_LICENSE_HEADLINE, BSL_LICENSE_TEXT, 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, getDirectusEmailAndPassword } from '../lib/utils/auth.js';
+import { animatedBunny } from '../lib/utils/animated-bunny.js';
+import { getDirectusEmailAndPassword, getDirectusToken, getDirectusUrl, initializeDirectusApi } from '../lib/utils/auth.js';
 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';
+import { shutdown, track } from '../services/posthog.js';
 import { BaseCommand } from './base.js';
-import { track, shutdown } from '../services/posthog.js';
-import { BSL_LICENSE_HEADLINE, BSL_LICENSE_TEXT, BSL_LICENSE_CTA } from '../lib/constants.js';
 export default class ApplyCommand extends BaseCommand {
     static description = 'Apply a template to a blank Directus instance.';
     static examples = [
@@ -35,6 +34,7 @@ export default class ApplyCommand extends BaseCommand {
         }),
         directusToken: customFlags.directusToken,
         directusUrl: customFlags.directusUrl,
+        disableTelemetry: customFlags.disableTelemetry,
         extensions: Flags.boolean({
             allowNo: true,
             default: undefined,
@@ -50,6 +50,10 @@ export default class ApplyCommand extends BaseCommand {
             default: undefined,
             description: 'Load Flows (operations, flows)',
         }),
+        noExit: Flags.boolean({
+            default: false,
+            hidden: true,
+        }),
         partial: Flags.boolean({
             dependsOn: ['programmatic'],
             description: 'Enable partial template application (all components enabled by default)',
@@ -88,7 +92,6 @@ export default class ApplyCommand extends BaseCommand {
             default: undefined,
             description: 'Load users',
         }),
-        disableTelemetry: customFlags.disableTelemetry,
     };
     /**
      * MAIN
@@ -112,32 +115,25 @@ export default class ApplyCommand extends BaseCommand {
         await animatedBunny('Let\'s apply a template!');
         intro(`${chalk.bgHex(DIRECTUS_PURPLE).white.bold('Directus Template CLI')} - Apply Template`);
         const templateType = await select({
+            message: 'What type of template would you like to apply?',
             options: [
                 { label: 'Community templates', value: 'community' },
                 { label: 'From a local directory', value: 'local' },
                 { label: 'From a public GitHub repository', value: 'github' },
                 { label: 'Get premium templates', value: 'directus-plus' },
             ],
-            message: 'What type of template would you like to apply?',
         });
         let template;
         switch (templateType) {
             case 'community': {
                 const templates = await getCommunityTemplates();
                 const selectedTemplate = await select({
-                    options: templates.map(t => ({ label: t.templateName, value: t })),
                     message: 'Select a template.',
+                    options: templates.map(t => ({ label: t.templateName, value: t })),
                 });
                 template = selectedTemplate;
                 break;
             }
-            case 'local': {
-                const localTemplateDir = await text({
-                    message: 'What is the local template directory?',
-                });
-                template = await this.selectLocalTemplate(localTemplateDir);
-                break;
-            }
             case 'github': {
                 const ghTemplateUrl = await text({
                     message: 'What is the public GitHub repository URL?',
@@ -145,10 +141,19 @@ export default class ApplyCommand extends BaseCommand {
                 template = await getGithubTemplate(ghTemplateUrl);
                 break;
             }
+            case 'local': {
+                const localTemplateDir = await text({
+                    message: 'What is the local template directory?',
+                });
+                template = await this.selectLocalTemplate(localTemplateDir);
+                break;
+            }
             case 'directus-plus': {
                 openUrl('https://directus.io/plus?utm_source=directus-template-cli&utm_content=apply-command');
                 log.info('Redirecting to Directus website.');
-                ux.exit(0);
+                if (!validatedFlags.noExit)
+                    process.exit(0);
+                return;
             }
         }
         log.info(`You selected ${ux.colorize(DIRECTUS_PINK, template.templateName)}`);
@@ -157,11 +162,11 @@ export default class ApplyCommand extends BaseCommand {
         validatedFlags.directusUrl = directusUrl;
         // Prompt for login method
         const loginMethod = await select({
+            message: 'How do you want to log in?',
             options: [
                 { label: 'Directus Access Token', value: 'token' },
                 { label: 'Email and Password', value: 'email' },
             ],
-            message: 'How do you want to log in?',
         });
         if (loginMethod === 'token') {
             const directusToken = await getDirectusToken(directusUrl);
@@ -179,7 +184,7 @@ export default class ApplyCommand extends BaseCommand {
             if (!validatedFlags.disableTelemetry) {
                 await track({
                     command: 'apply',
-                    lifecycle: 'start',
+                    config: this.config,
                     distinctId: this.userConfig.distinctId,
                     flags: {
                         programmatic: false,
@@ -188,8 +193,8 @@ export default class ApplyCommand extends BaseCommand {
                         // Include other relevant flags from validatedFlags if needed
                         ...validatedFlags,
                     },
+                    lifecycle: 'start',
                     runId: this.runId,
-                    config: this.config,
                 });
             }
             await apply(template.directoryPath, validatedFlags);
@@ -198,15 +203,15 @@ export default class ApplyCommand extends BaseCommand {
             if (!validatedFlags.disableTelemetry) {
                 await track({
                     command: 'apply',
-                    lifecycle: 'complete',
+                    config: this.config,
                     distinctId: this.userConfig.distinctId,
                     flags: {
                         templateName: template.templateName,
                         templateType,
                         ...validatedFlags,
                     },
+                    lifecycle: 'complete',
                     runId: this.runId,
-                    config: this.config,
                 });
                 await shutdown();
             }
@@ -215,7 +220,9 @@ export default class ApplyCommand extends BaseCommand {
             log.info(BSL_LICENSE_TEXT);
             log.info(BSL_LICENSE_CTA);
             ux.stdout('Template applied successfully.');
-            ux.exit(0);
+            if (!validatedFlags.noExit)
+                process.exit(0);
+            return;
         }
     }
     /**
@@ -233,14 +240,14 @@ export default class ApplyCommand extends BaseCommand {
                 template = templates.find(t => t.templateName === validatedFlags.templateLocation) || templates[0];
                 break;
             }
-            case 'local': {
-                template = await getLocalTemplate(validatedFlags.templateLocation);
-                break;
-            }
             case 'github': {
                 template = await getGithubTemplate(validatedFlags.templateLocation);
                 break;
             }
+            case 'local': {
+                template = await getLocalTemplate(validatedFlags.templateLocation);
+                break;
+            }
             default: {
                 catchError('Invalid template type. Please check your template type.', {
                     fatal: true,
@@ -255,7 +262,7 @@ export default class ApplyCommand extends BaseCommand {
         if (!validatedFlags.disableTelemetry) {
             await track({
                 command: 'apply',
-                lifecycle: 'start',
+                config: this.config,
                 distinctId: this.userConfig.distinctId,
                 flags: {
                     programmatic: true,
@@ -263,8 +270,8 @@ export default class ApplyCommand extends BaseCommand {
                     // Include other relevant flags from validatedFlags
                     ...validatedFlags,
                 },
+                lifecycle: 'start',
                 runId: this.runId,
-                config: this.config,
             });
         }
         await apply(template.directoryPath, validatedFlags);
@@ -273,25 +280,26 @@ export default class ApplyCommand extends BaseCommand {
         if (!validatedFlags.disableTelemetry) {
             await track({
                 command: 'apply',
-                lifecycle: 'complete',
+                config: this.config,
                 distinctId: this.userConfig.distinctId,
                 flags: {
                     templateName: template.templateName,
                     // Include other relevant flags from validatedFlags
                     ...validatedFlags,
                 },
+                lifecycle: 'complete',
                 runId: this.runId,
-                config: this.config,
             });
             await shutdown();
         }
         ux.stdout(SEPARATOR);
         ux.stdout('Template applied successfully.');
+        if (!validatedFlags.noExit)
+            process.exit(0);
         // Hide BSL license info if running programatically for now
         // log.warn(BSL_LICENSE_HEADLINE)
         // log.info(BSL_LICENSE_TEXT)
         // log.info(BSL_LICENSE_CTA)
-        ux.exit(0);
     }
     /**
      * INTERACTIVE
@@ -306,11 +314,11 @@ export default class ApplyCommand extends BaseCommand {
                 return templates[0];
             }
             const selectedTemplate = await select({
+                message: 'Multiple templates found. Please select one:',
                 options: templates.map(t => ({
                     label: `${t.templateName} (${path.basename(t.directoryPath)})`,
                     value: t,
                 })),
-                message: 'Multiple templates found. Please select one:',
             });
             return selectedTemplate;
         }

package/dist/commands/base.d.ts

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

package/dist/commands/base.js

@@ -14,15 +14,27 @@ export class BaseCommand extends Command {
     async init() {
         await super.init();
         const { flags } = await this.parse({
-            flags: this.ctor.flags,
             args: this.ctor.args,
+            flags: this.ctor.flags,
             strict: false,
         });
         setExecutionContext({
-            distinctId: this.userConfig.distinctId ?? undefined,
             disableTelemetry: flags?.disableTelemetry ?? false,
+            distinctId: this.userConfig.distinctId ?? undefined,
         });
     }
+    /**
+     * 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}`);
+        }
+    }
     loadUserConfig() {
         try {
             const configPath = path.join(this.config.configDir, 'config.json');
@@ -43,16 +55,4 @@ export class BaseCommand extends Command {
             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

@@ -2,12 +2,12 @@ import { BaseCommand } from './base.js';
 export interface ExtractFlags {
     directusToken: string;
     directusUrl: string;
+    disableTelemetry?: boolean;
     programmatic: boolean;
     templateLocation: string;
     templateName: string;
     userEmail: string;
     userPassword: string;
-    disableTelemetry?: boolean;
 }
 export default class ExtractCommand extends BaseCommand {
     static description: string;
@@ -15,12 +15,12 @@ export default class ExtractCommand extends BaseCommand {
     static flags: {
         directusToken: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         directusUrl: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        disableTelemetry: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         programmatic: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         templateLocation: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         templateName: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         userEmail: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         userPassword: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        disableTelemetry: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     /**
      * Main run method for the ExtractCommand

package/dist/commands/extract.js

@@ -1,18 +1,18 @@
-import { text, select, intro, log } from '@clack/prompts';
+import { intro, log, select, text } from '@clack/prompts';
 import { ux } from '@oclif/core';
 import slugify from '@sindresorhus/slugify';
 import chalk from 'chalk';
 import fs from 'node:fs';
 import path from 'pathe';
 import * as customFlags from '../flags/common.js';
-import { DIRECTUS_PINK, DIRECTUS_PURPLE, SEPARATOR, BSL_LICENSE_TEXT, BSL_LICENSE_CTA, BSL_LICENSE_HEADLINE } from '../lib/constants.js';
-import { animatedBunny } from '../lib/utils/animated-bunny.js';
-import { BaseCommand } from './base.js';
-import { track, shutdown } from '../services/posthog.js';
+import { BSL_LICENSE_CTA, BSL_LICENSE_HEADLINE, BSL_LICENSE_TEXT, DIRECTUS_PINK, DIRECTUS_PURPLE, SEPARATOR } from '../lib/constants.js';
 import extract from '../lib/extract/index.js';
-import { getDirectusToken, getDirectusUrl, initializeDirectusApi, validateAuthFlags, getDirectusEmailAndPassword } from '../lib/utils/auth.js';
+import { animatedBunny } from '../lib/utils/animated-bunny.js';
+import { getDirectusEmailAndPassword, getDirectusToken, getDirectusUrl, initializeDirectusApi, validateAuthFlags } from '../lib/utils/auth.js';
 import catchError from '../lib/utils/catch-error.js';
 import { generatePackageJsonContent, generateReadmeContent, } from '../lib/utils/template-defaults.js';
+import { shutdown, track } from '../services/posthog.js';
+import { BaseCommand } from './base.js';
 export default class ExtractCommand extends BaseCommand {
     static description = 'Extract a template from a Directus instance.';
     static examples = [
@@ -22,12 +22,12 @@ export default class ExtractCommand extends BaseCommand {
     static flags = {
         directusToken: customFlags.directusToken,
         directusUrl: customFlags.directusUrl,
+        disableTelemetry: customFlags.disableTelemetry,
         programmatic: customFlags.programmatic,
         templateLocation: customFlags.templateLocation,
         templateName: customFlags.templateName,
         userEmail: customFlags.userEmail,
         userPassword: customFlags.userPassword,
-        disableTelemetry: customFlags.disableTelemetry,
     };
     /**
      * Main run method for the ExtractCommand
@@ -50,16 +50,16 @@ export default class ExtractCommand extends BaseCommand {
         if (!flags.disableTelemetry) {
             await track({
                 command: 'extract',
-                lifecycle: 'start',
+                config: this.config,
                 distinctId: this.userConfig.distinctId,
                 flags: {
-                    templateName,
-                    templateLocation: directory,
                     directusUrl: flags.directusUrl,
                     programmatic: flags.programmatic,
+                    templateLocation: directory,
+                    templateName,
                 },
+                lifecycle: 'start',
                 runId: this.runId,
-                config: this.config,
             });
         }
         try {
@@ -88,16 +88,16 @@ export default class ExtractCommand extends BaseCommand {
         if (!flags.disableTelemetry) {
             await track({
                 command: 'extract',
-                lifecycle: 'complete',
+                config: this.config,
                 distinctId: this.userConfig.distinctId,
                 flags: {
-                    templateName,
-                    templateLocation: directory,
                     directusUrl: flags.directusUrl,
                     programmatic: flags.programmatic,
+                    templateLocation: directory,
+                    templateName,
                 },
+                lifecycle: 'complete',
                 runId: this.runId,
-                config: this.config,
             });
             await shutdown();
         }
@@ -121,9 +121,9 @@ export default class ExtractCommand extends BaseCommand {
             placeholder: 'My Template',
         });
         const directory = await text({
-            placeholder: `templates/${slugify(templateName)}`,
             defaultValue: `templates/${slugify(templateName)}`,
             message: "What directory would you like to extract the template to? If it doesn't exist, it will be created.",
+            placeholder: `templates/${slugify(templateName)}`,
         });
         ux.stdout(`You selected ${ux.colorize(DIRECTUS_PINK, directory)}`);
         ux.stdout(SEPARATOR);
@@ -132,11 +132,11 @@ export default class ExtractCommand extends BaseCommand {
         flags.directusUrl = directusUrl;
         // Prompt for login method
         const loginMethod = await select({
+            message: 'How do you want to log in?',
             options: [
                 { label: 'Directus Access Token', value: 'token' },
                 { label: 'Email and Password', value: 'email' },
             ],
-            message: 'How do you want to log in?',
         });
         if (loginMethod === 'token') {
             const directusToken = await getDirectusToken(directusUrl);

package/dist/commands/init.d.ts

@@ -1,11 +1,11 @@
 import { BaseCommand } from './base.js';
 export interface InitFlags {
+    disableTelemetry?: boolean;
     frontend?: string;
     gitInit?: boolean;
     installDeps?: boolean;
     overwriteDir?: boolean;
     template?: string;
-    disableTelemetry?: boolean;
 }
 export interface InitArgs {
     directory: string;
@@ -19,12 +19,12 @@ export default class InitCommand extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
+        disableTelemetry: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         frontend: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         gitInit: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         installDeps: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         overwriteDir: 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;
     /**