directus-template-cli 0.7.0-beta.4 → 0.7.0-beta.6

package/dist/lib/utils/template-defaults.js

@@ -1,13 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateReadmeContent = exports.generatePackageJsonContent = void 0;
-const tslib_1 = require("tslib");
-const slugify_1 = tslib_1.__importDefault(require("slugify"));
-const generatePackageJsonContent = (templateName) => {
-    const slugifiedName = (0, slugify_1.default)(templateName, {
-        lower: true, // Convert to lowercase
-        strict: true, // Remove special characters
-    });
+import slugify from '@sindresorhus/slugify';
+export function generatePackageJsonContent(templateName) {
+    const slugifiedName = slugify(templateName);
     const packageName = `directus-template-${slugifiedName}`;
     return JSON.stringify({
         author: '',
@@ -18,9 +11,8 @@ const generatePackageJsonContent = (templateName) => {
         templateName,
         version: '1.0.0',
     }, null, 2);
-};
-exports.generatePackageJsonContent = generatePackageJsonContent;
-const generateReadmeContent = (templateName) => `# ${templateName} Template
+}
+export const generateReadmeContent = (templateName) => `# ${templateName} Template
 
 This is a template for [Directus](https://directus.io/) - an open-source headless CMS and API. Use the template-cli to load / apply this template to a blank instance.
 
@@ -31,4 +23,3 @@ This is a template for [Directus](https://directus.io/) - an open-source headles
 ## License
 
 `;
-exports.generateReadmeContent = generateReadmeContent;

package/dist/lib/utils/transform-github-url.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformGitHubUrl = void 0;
-function transformGitHubUrl(url) {
+export function transformGitHubUrl(url) {
     // Regular expression to capture the repository name and any subsequent path after the 'tree'
     const regex = /github\.com\/([^/]+\/[^/]+)(?:\/tree\/[^/]+\/(.*))?$/;
     const match = url.match(regex);
@@ -12,4 +9,3 @@ function transformGitHubUrl(url) {
     }
     return 'Invalid URL';
 }
-exports.transformGitHubUrl = transformGitHubUrl;

package/dist/lib/utils/validate-url.js

@@ -1,13 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const protected_domains_1 = require("./protected-domains");
-function validateUrl(url) {
+import { protectedDomains } from './protected-domains.js';
+export default function validateUrl(url) {
     try {
         const parsedUrl = new URL(url);
-        return !protected_domains_1.protectedDomains.includes(parsedUrl.hostname);
+        return !protectedDomains.includes(parsedUrl.hostname);
     }
     catch {
         return false;
     }
 }
-exports.default = validateUrl;

package/dist/lib/utils/wait.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitFor = void 0;
-async function waitFor(checkFn, options = {}) {
+export async function waitFor(checkFn, options = {}) {
     const { errorMessage = 'Operation timed out', interval = 2000, maxAttempts = 30, } = options;
     for (let i = 0; i < maxAttempts; i++) {
         if (await checkFn())
@@ -10,4 +7,3 @@ async function waitFor(checkFn, options = {}) {
     }
     throw new Error(errorMessage);
 }
-exports.waitFor = waitFor;

package/dist/lib/utils/write-to-file.js

@@ -1,23 +1,20 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
-const node_path_1 = tslib_1.__importDefault(require("node:path"));
-exports.default = async (fileName, data, dir) => {
+import fs from 'node:fs';
+import path from 'pathe';
+export default async (fileName, data, dir) => {
     const folders = fileName.split('/');
     const endFileName = folders.pop();
     const folderPath = folders.join('/');
     // Generate the full path where you want to write the file
-    const fullPath = node_path_1.default.join(dir, folderPath);
+    const fullPath = path.join(dir, folderPath);
     // Check if the directory exists. Create if it doesn't.
-    if (!node_fs_1.default.existsSync(fullPath)) {
-        node_fs_1.default.mkdirSync(fullPath, { recursive: true });
+    if (!fs.existsSync(fullPath)) {
+        fs.mkdirSync(fullPath, { recursive: true });
     }
     // Construct the full file path
-    const fullFilePath = node_path_1.default.join(fullPath, `${endFileName}.json`);
+    const fullFilePath = path.join(fullPath, `${endFileName}.json`);
     try {
         // Write the file
-        await node_fs_1.default.promises.writeFile(fullFilePath, JSON.stringify(data, null, 2));
+        await fs.promises.writeFile(fullFilePath, JSON.stringify(data, null, 2));
         // console.log(`Wrote ${fullFilePath}`);
     }
     catch (error) {

package/dist/services/docker.js

@@ -1,10 +1,62 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDocker = void 0;
-const tslib_1 = require("tslib");
-const prompts_1 = require("@clack/prompts");
-const catch_error_1 = tslib_1.__importDefault(require("../lib/utils/catch-error"));
-const wait_1 = require("../lib/utils/wait");
+import { spinner } from '@clack/prompts';
+import { execa } from 'execa';
+import net from 'node:net';
+import { ux } from '@oclif/core';
+import catchError from '../lib/utils/catch-error.js';
+import { waitFor } from '../lib/utils/wait.js';
+/**
+ * Check if a port is in use and what's using it
+ * @param port The port to check
+ * @returns Object indicating if port is in use and what's using it
+ */
+async function checkPort(port) {
+    return new Promise((resolve) => {
+        const server = net.createServer();
+        server.once('error', async (err) => {
+            if (err.code === 'EADDRINUSE') {
+                // Try to get information about what's using the port
+                try {
+                    const { stdout } = await execa('lsof', ['-i', `:${port}`]);
+                    const process = stdout.split('\n')[1]?.split(/\s+/)[0]; // Get process name
+                    resolve({ inUse: true, process });
+                }
+                catch {
+                    resolve({ inUse: true });
+                }
+            }
+            else {
+                resolve({ inUse: false });
+            }
+        });
+        server.once('listening', () => {
+            server.close();
+            resolve({ inUse: false });
+        });
+        server.listen(port);
+    });
+}
+/**
+ * Check if required ports are available and warn if they're in use
+ * @returns Promise<void>
+ */
+async function checkRequiredPorts() {
+    const portsToCheck = [
+        { port: 8055, name: 'Directus API' },
+        { port: 5432, name: 'PostgreSQL' },
+    ];
+    let hasConflicts = false;
+    for (const { port, name } of portsToCheck) {
+        const status = await checkPort(port);
+        if (status.inUse) {
+            hasConflicts = true;
+            const process = status.process ? ` by ${status.process}` : '';
+            ux.warn(`Port ${port} (${name}) is already in use${process}`);
+        }
+    }
+    if (hasConflicts) {
+        ux.warn('Please stop any conflicting services before continuing.');
+    }
+}
 /**
  * Check if Docker is installed and running
  * @returns {Promise<DockerCheckResult>} Docker installation and running status
@@ -12,7 +64,6 @@ const wait_1 = require("../lib/utils/wait");
 async function checkDocker() {
     try {
         // Check if Docker is installed
-        const { execa } = await Promise.resolve().then(() => tslib_1.__importStar(require('execa')));
         const versionResult = await execa('docker', ['--version']);
         const isInstalled = versionResult.exitCode === 0;
         if (!isInstalled) {
@@ -43,19 +94,18 @@ async function checkDocker() {
  */
 async function startContainers(cwd) {
     try {
-        const { execa } = await Promise.resolve().then(() => tslib_1.__importStar(require('execa')));
-        // ux.action.start('Starting Docker containers')
-        const s = (0, prompts_1.spinner)();
+        // Check if required ports are available
+        await checkRequiredPorts();
+        const s = spinner();
         s.start('Starting Docker containers');
         return execa('docker-compose', ['up', '-d'], {
             cwd,
-            // stdio: 'inherit',
         }).then(() => {
             s.stop('Docker containers running!');
         });
     }
     catch (error) {
-        (0, catch_error_1.default)(error, {
+        catchError(error, {
             context: { cwd, function: 'startContainers' },
             fatal: true,
             logToFile: true,
@@ -70,14 +120,12 @@ async function startContainers(cwd) {
  */
 async function stopContainers(cwd) {
     try {
-        const { execa } = await Promise.resolve().then(() => tslib_1.__importStar(require('execa')));
         return execa('docker-compose', ['down'], {
             cwd,
-            // stdio: 'inherit',
         }).then(() => { });
     }
     catch (error) {
-        (0, catch_error_1.default)(error, {
+        catchError(error, {
             context: { cwd, function: 'stopContainers' },
             fatal: false,
             logToFile: true,
@@ -92,10 +140,10 @@ async function stopContainers(cwd) {
  */
 function createWaitForHealthy(config) {
     async function waitForHealthy(healthCheckUrl) {
-        const s = (0, prompts_1.spinner)();
+        const s = spinner();
         s.start('Waiting for Directus to be ready.');
         try {
-            await (0, wait_1.waitFor)(async () => {
+            await waitFor(async () => {
                 try {
                     const response = await fetch(healthCheckUrl);
                     return response.ok;
@@ -113,7 +161,7 @@ function createWaitForHealthy(config) {
         }
         catch (error) {
             s.stop('');
-            (0, catch_error_1.default)(error, {
+            catchError(error, {
                 context: { function: 'waitForHealthy', url: healthCheckUrl },
                 fatal: true,
                 logToFile: true,
@@ -128,7 +176,7 @@ function createWaitForHealthy(config) {
  * @param {DockerConfig} config - The Docker configuration
  * @returns {DockerService} - Returns a Docker service instance
  */
-function createDocker(config) {
+export function createDocker(config) {
     return {
         checkDocker,
         startContainers,
@@ -136,4 +184,3 @@ function createDocker(config) {
         waitForHealthy: createWaitForHealthy(config),
     };
 }
-exports.createDocker = createDocker;

package/dist/services/github.d.ts

@@ -1,4 +1,4 @@
-import { parseGitHubUrl } from '../lib/utils/parse-github-url';
+import { parseGitHubUrl } from '../lib/utils/parse-github-url.js';
 interface GitHubUrlParts {
     owner: string;
     path?: string;

package/dist/services/github.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createGitHub = void 0;
-const rest_1 = require("@octokit/rest");
-const constants_1 = require("../lib/constants");
-const parse_github_url_1 = require("../lib/utils/parse-github-url");
-function createGitHub(token) {
-    const octokit = new rest_1.Octokit({
+import { Octokit } from '@octokit/rest';
+import { DEFAULT_REPO } from '../lib/constants.js';
+import { parseGitHubUrl } from '../lib/utils/parse-github-url.js';
+export function createGitHub(token) {
+    const octokit = new Octokit({
         auth: token,
     });
     /**
@@ -15,19 +12,50 @@ function createGitHub(token) {
      * @returns The directories for the template.
      */
     async function getTemplateDirectories(template, customUrl) {
-        const repo = customUrl ? (0, parse_github_url_1.parseGitHubUrl)(customUrl) : constants_1.DEFAULT_REPO;
+        // If template is a URL, parse it directly
+        if (template.startsWith('http')) {
+            const repo = parseGitHubUrl(template);
+            try {
+                const { data } = await octokit.rest.repos.getContent({
+                    owner: repo.owner,
+                    repo: repo.repo,
+                    path: repo.path || '',
+                    ref: repo.ref,
+                });
+                if (!Array.isArray(data))
+                    return [];
+                // For direct URLs, we don't filter out the directus directory
+                // as the entire repo might be a directus template
+                return data
+                    .filter(item => item.type === 'dir')
+                    .map(item => item.name);
+            }
+            catch (error) {
+                // If we can't get contents, return empty array
+                // This indicates no frontends are available
+                return [];
+            }
+        }
+        // Otherwise use default repo behavior
+        const repo = customUrl ? parseGitHubUrl(customUrl) : DEFAULT_REPO;
         const templatePath = repo.path ? `${repo.path}/${template}` : template;
-        const { data } = await octokit.rest.repos.getContent({
-            owner: repo.owner,
-            path: templatePath,
-            ref: repo.ref,
-            repo: repo.repo,
-        });
-        if (!Array.isArray(data))
+        try {
+            const { data } = await octokit.rest.repos.getContent({
+                owner: repo.owner,
+                path: templatePath,
+                ref: repo.ref,
+                repo: repo.repo,
+            });
+            if (!Array.isArray(data))
+                return [];
+            return data
+                .filter(item => item.type === 'dir' && item.name !== 'directus')
+                .map(item => item.name);
+        }
+        catch (error) {
+            // If we can't get contents, return empty array
             return [];
-        return data
-            .filter(item => item.type === 'dir' && item.name !== 'directus')
-            .map(item => item.name);
+        }
     }
     /**
      * Get the templates for a repository.
@@ -35,7 +63,11 @@ function createGitHub(token) {
      * @returns The templates for the repository.
      */
     async function getTemplates(customUrl) {
-        const repo = customUrl ? (0, parse_github_url_1.parseGitHubUrl)(customUrl) : constants_1.DEFAULT_REPO;
+        // If customUrl is provided and it's a full repository URL, return it as the only template
+        if (customUrl?.startsWith('http')) {
+            return [customUrl];
+        }
+        const repo = customUrl ? parseGitHubUrl(customUrl) : DEFAULT_REPO;
         const { data } = await octokit.rest.repos.getContent({
             owner: repo.owner,
             path: repo.path || '',
@@ -51,7 +83,6 @@ function createGitHub(token) {
     return {
         getTemplateDirectories,
         getTemplates,
-        parseGitHubUrl: parse_github_url_1.parseGitHubUrl,
+        parseGitHubUrl,
     };
 }
-exports.createGitHub = createGitHub;

package/dist/services/posthog.d.ts

@@ -0,0 +1,37 @@
+import type { Config } from '@oclif/core';
+import { PostHog } from 'posthog-node';
+/**
+ * Initialize and get the PostHog client
+ * @param debug Whether to log debug information
+ * @returns The PostHog client
+ */
+export declare function getClient(debug?: boolean): PostHog;
+/**
+ * Shutdown the PostHog client
+ * @param debug Whether to log debug information
+ * @returns void
+ */
+export declare function shutdown(debug?: boolean): Promise<void>;
+/**
+ * Track an event in PostHog
+ * @param options The tracking options
+ * @param options.lifecycle The lifecycle event to track ('start', 'complete', 'error')
+ * @param options.distinctId The distinct ID for the user
+ * @param options.command Optional command name (for command tracking)
+ * @param options.flags Optional command flags
+ * @param options.runId Optional run ID
+ * @param options.config Optional config object
+ * @param options.properties Optional additional properties to track
+ * @param options.debug Whether to log debug information
+ */
+export declare function track({ lifecycle, distinctId, command, flags, runId, message, config, properties, debug }: {
+    lifecycle: 'start' | 'complete' | 'error';
+    message?: string;
+    distinctId: string;
+    command?: string;
+    flags?: Record<string, unknown>;
+    runId?: string;
+    config?: Config;
+    properties?: Record<string, unknown>;
+    debug?: boolean;
+}): void;

package/dist/services/posthog.js

@@ -0,0 +1,104 @@
+import { ux } from '@oclif/core';
+import { PostHog } from 'posthog-node';
+import { POSTHOG_PUBLIC_KEY, POSTHOG_HOST } from '../lib/constants.js';
+import { sanitizeFlags } from '../lib/utils/sanitize-flags.js';
+// Create a singleton client using module scope
+let client = null;
+/**
+ * Initialize and get the PostHog client
+ * @param debug Whether to log debug information
+ * @returns The PostHog client
+ */
+export function getClient(debug = false) {
+    if (debug)
+        ux.stdout('Initializing PostHog client...');
+    if (!client) {
+        client = new PostHog(POSTHOG_PUBLIC_KEY, {
+            host: POSTHOG_HOST,
+            disableGeoip: false,
+        });
+        // Add error handling
+        client.on('error', err => {
+            ux.warn(`PostHog Error: ${err}`);
+        });
+    }
+    if (debug)
+        ux.stdout('PostHog client initialized successfully');
+    return client;
+}
+/**
+ * Shutdown the PostHog client
+ * @param debug Whether to log debug information
+ * @returns void
+ */
+export async function shutdown(debug = false) {
+    if (debug)
+        ux.stdout('Shutting down PostHog client...');
+    if (!client)
+        return;
+    try {
+        await client.shutdown();
+        client = null;
+        if (debug)
+            ux.stdout('PostHog client shut down successfully');
+    }
+    catch (error) {
+        ux.warn(`Error shutting down PostHog client: ${error}`);
+    }
+}
+/**
+ * Track an event in PostHog
+ * @param options The tracking options
+ * @param options.lifecycle The lifecycle event to track ('start', 'complete', 'error')
+ * @param options.distinctId The distinct ID for the user
+ * @param options.command Optional command name (for command tracking)
+ * @param options.flags Optional command flags
+ * @param options.runId Optional run ID
+ * @param options.config Optional config object
+ * @param options.properties Optional additional properties to track
+ * @param options.debug Whether to log debug information
+ */
+export function track({ lifecycle, distinctId, command, flags, runId, message, config, properties = {}, debug = false }) {
+    if (debug)
+        ux.stdout('Tracking event...');
+    const phClient = getClient(debug);
+    const eventProperties = command
+        ? {
+            runId,
+            message,
+            ...properties,
+            ...getEnvironmentInfo(config),
+            // Always sanitize sensitive flags
+            ...sanitizeFlags(flags),
+        }
+        : properties;
+    if (debug) {
+        ux.stdout('Capturing event...');
+        ux.stdout(JSON.stringify(eventProperties));
+    }
+    phClient.capture({
+        distinctId,
+        event: `directus_template_cli.${command}.${lifecycle}`,
+        properties: eventProperties
+    });
+    if (debug)
+        ux.stdout('Event tracked successfully');
+}
+/**
+ * Get environment info
+ * @param config The config to get environment info from
+ * @returns The environment info
+ */
+function getEnvironmentInfo(config) {
+    return {
+        // PostHog properties
+        $os: process.platform,
+        $raw_user_agent: config?.userAgent || 'unknown',
+        // Custom properties
+        arch: process.arch || 'unknown',
+        nodeVersion: process.version,
+        platform: config?.platform || 'unknown',
+        shell: config?.shell || 'unknown',
+        version: config?.version || 'unknown',
+    };
+}

package/oclif.manifest.json

@@ -169,13 +169,32 @@
       "pluginType": "core",
       "strict": true,
       "enableJsonFlag": false,
-      "isESM": false,
+      "isESM": true,
       "relativePath": [
         "dist",
         "commands",
         "apply.js"
       ]
     },
+    "base": {
+      "aliases": [],
+      "args": {},
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "base",
+      "pluginAlias": "directus-template-cli",
+      "pluginName": "directus-template-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "base.js"
+      ]
+    },
     "extract": {
       "aliases": [],
       "args": {},
@@ -272,7 +291,7 @@
       "pluginType": "core",
       "strict": true,
       "enableJsonFlag": false,
-      "isESM": false,
+      "isESM": true,
       "relativePath": [
         "dist",
         "commands",
@@ -293,8 +312,8 @@
       "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"
       ],
       "flags": {
         "frontend": {
@@ -328,19 +347,19 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "programmatic": {
-          "char": "p",
-          "description": "Run in programmatic mode (non-interactive)",
-          "name": "programmatic",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "template": {
           "description": "Template name (e.g., simple-cms) or GitHub URL (e.g., https://github.com/directus-labs/starters/tree/main/simple-cms)",
           "name": "template",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "disableTelemetry": {
+          "description": "Disable telemetry",
+          "env": "DISABLE_TELEMETRY",
+          "name": "disableTelemetry",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -351,7 +370,7 @@
       "pluginType": "core",
       "strict": true,
       "enableJsonFlag": false,
-      "isESM": false,
+      "isESM": true,
       "relativePath": [
         "dist",
         "commands",
@@ -359,5 +378,5 @@
       ]
     }
   },
-  "version": "0.7.0-beta.4"
+  "version": "0.7.0-beta.6"
 }