@mintlify/cli 4.0.1122 → 4.0.1123

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1122",
+  "version": "4.0.1123",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -93,5 +93,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "794b8b7473bf08e20dea96efe72921c44a52b194"
+  "gitHead": "511d45e72c42590140bd4568456f75bc65658752"
 }

package/src/cli.tsx

@@ -44,7 +44,6 @@ import { scoreHandler } from './score/index.js';
 import { status, getCliSubdomains } from './status.js';
 import { trackTelemetryPreferenceChange } from './telemetry/track.js';
 import { update } from './update.js';
-import { addWorkflow } from './workflow.js';
 
 export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
   const telemetryMiddleware = createTelemetryMiddleware();
@@ -554,22 +553,6 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
           }
         }
       )
-      .command(
-        'workflow',
-        'Add a workflow to your documentation repository',
-        () => undefined,
-        async () => {
-          try {
-            await addWorkflow();
-            await terminate(0);
-          } catch (error) {
-            addLog(
-              <ErrorLog message={error instanceof Error ? error.message : 'error occurred'} />
-            );
-            await terminate(1);
-          }
-        }
-      )
       .command('analytics', 'View analytics for your documentation', analyticsBuilder)
       .command(
         'score <url>',

package/__test__/workflow.test.ts

@@ -1,320 +0,0 @@
-import * as previewing from '@mintlify/previewing';
-import fse from 'fs-extra';
-import path from 'path';
-
-import { addWorkflow, slugify, buildFrontmatter, isValidCron } from '../src/workflow.js';
-
-const FAKE_PROJECT = '/fake/project';
-const WORKFLOWS_DIR = path.join(FAKE_PROJECT, '.mintlify', 'workflows');
-
-vi.mock('@inquirer/prompts', () => ({
-  select: vi.fn(),
-  input: vi.fn(),
-  editor: vi.fn(),
-}));
-
-vi.mock('@mintlify/previewing', () => ({
-  addLog: vi.fn(),
-  addLogs: vi.fn(),
-  SuccessLog: vi.fn(),
-}));
-
-vi.mock('fs-extra', () => ({
-  default: {
-    pathExists: vi.fn(),
-    ensureDir: vi.fn().mockResolvedValue(undefined),
-    writeFile: vi.fn().mockResolvedValue(undefined),
-  },
-}));
-
-vi.mock('../src/helpers.js', () => ({
-  CMD_EXEC_PATH: '/fake/project',
-  isAI: () =>
-    !process.stdin.isTTY || process.env.CLAUDECODE === '1' || process.env.TERM_PROGRAM === 'claude',
-}));
-
-const addLogSpy = vi.mocked(previewing.addLog);
-
-describe('slugify', () => {
-  it('converts spaces to hyphens', () => {
-    expect(slugify('Update changelog')).toBe('update-changelog');
-  });
-
-  it('replaces special characters with hyphens', () => {
-    expect(slugify('My Workflow!@#$%')).toBe('my-workflow');
-  });
-
-  it('replaces slashes with hyphens like the dashboard', () => {
-    expect(slugify('a/b')).toBe('a-b');
-  });
-
-  it('collapses multiple hyphens', () => {
-    expect(slugify('a   b---c')).toBe('a-b-c');
-  });
-
-  it('trims leading and trailing hyphens', () => {
-    expect(slugify('  --hello--  ')).toBe('hello');
-  });
-
-  it('lowercases the result', () => {
-    expect(slugify('UPPER CASE')).toBe('upper-case');
-  });
-
-  it('handles single word', () => {
-    expect(slugify('deploy')).toBe('deploy');
-  });
-});
-
-describe('isValidCron', () => {
-  it('accepts standard 5-field expressions', () => {
-    expect(isValidCron('0 9 * * 1')).toBe(true);
-    expect(isValidCron('*/15 * * * *')).toBe(true);
-    expect(isValidCron('0 0 1 1 *')).toBe(true);
-  });
-
-  it('accepts ranges and lists', () => {
-    expect(isValidCron('0 9-17 * * 1-5')).toBe(true);
-    expect(isValidCron('0,30 * * * *')).toBe(true);
-  });
-
-  it('rejects invalid expressions', () => {
-    expect(isValidCron('0 xd f gasf')).toBe(false);
-    expect(isValidCron('not a cron')).toBe(false);
-    expect(isValidCron('')).toBe(false);
-  });
-
-  it('rejects wrong number of fields', () => {
-    expect(isValidCron('* * *')).toBe(false);
-    expect(isValidCron('* * * * * *')).toBe(false);
-  });
-});
-
-describe('buildFrontmatter', () => {
-  it('builds cron trigger frontmatter', () => {
-    const result = buildFrontmatter({
-      name: 'Update changelog',
-      triggerType: 'cron',
-      cronExpression: '0 9 * * 1',
-      automerge: false,
-    });
-    expect(result).toBe('---\nname: "Update changelog"\non:\n  cron: "0 9 * * 1"\n---');
-  });
-
-  it('builds push trigger frontmatter with repos', () => {
-    const result = buildFrontmatter({
-      name: 'Deploy docs',
-      triggerType: 'push',
-      triggerRepos: ['org/docs', 'org/api'],
-      automerge: false,
-    });
-    expect(result).toBe(
-      '---\nname: "Deploy docs"\non:\n  push:\n    - repo: "org/docs"\n    - repo: "org/api"\n---'
-    );
-  });
-
-  it('builds push trigger with no repos', () => {
-    const result = buildFrontmatter({
-      name: 'Deploy',
-      triggerType: 'push',
-      automerge: false,
-    });
-    expect(result).toBe('---\nname: "Deploy"\non:\n  push:\n---');
-  });
-
-  it('includes context repos', () => {
-    const result = buildFrontmatter({
-      name: 'Test',
-      triggerType: 'cron',
-      cronExpression: '0 9 * * 1',
-      contextRepos: ['org/repo1', 'org/repo2'],
-      automerge: false,
-    });
-    expect(result).toContain('context:\n  - repo: "org/repo1"\n  - repo: "org/repo2"');
-  });
-
-  it('includes automerge only when true', () => {
-    const result = buildFrontmatter({
-      name: 'Test',
-      triggerType: 'cron',
-      cronExpression: '0 9 * * 1',
-      automerge: true,
-    });
-    expect(result).toContain('automerge: true');
-  });
-
-  it('omits automerge when false', () => {
-    const result = buildFrontmatter({
-      name: 'Test',
-      triggerType: 'cron',
-      cronExpression: '0 9 * * 1',
-      automerge: false,
-    });
-    expect(result).not.toContain('automerge');
-  });
-
-  it('escapes quotes in name', () => {
-    const result = buildFrontmatter({
-      name: 'My "Test" Workflow',
-      triggerType: 'cron',
-      cronExpression: '0 9 * * 1',
-      automerge: false,
-    });
-    expect(result).toContain('name: "My \\"Test\\" Workflow"');
-  });
-});
-
-describe('addWorkflow', () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  it('throws when docs.json does not exist', async () => {
-    vi.mocked(fse.pathExists).mockResolvedValue(false as never);
-
-    await expect(addWorkflow()).rejects.toThrow(
-      'docs.json not found in the current directory. Please run this command from your docs repository root.'
-    );
-  });
-
-  it('outputs AI usage message when not interactive', async () => {
-    vi.mocked(fse.pathExists).mockResolvedValue(true as never);
-    const originalIsTTY = process.stdin.isTTY;
-    process.stdin.isTTY = false;
-
-    await addWorkflow();
-
-    expect(previewing.addLogs).toHaveBeenCalled();
-
-    process.stdin.isTTY = originalIsTTY;
-  });
-
-  it('throws when workflow name has no alphanumeric characters', async () => {
-    vi.mocked(fse.pathExists).mockResolvedValue(true as never);
-    const originalIsTTY = process.stdin.isTTY;
-    const originalClaudeCode = process.env.CLAUDECODE;
-    process.stdin.isTTY = true;
-    delete process.env.CLAUDECODE;
-
-    const { input } = await import('@inquirer/prompts');
-    vi.mocked(input).mockResolvedValueOnce('!!!');
-
-    await expect(addWorkflow()).rejects.toThrow(
-      'Workflow name must contain at least one alphanumeric character.'
-    );
-
-    process.stdin.isTTY = originalIsTTY;
-    if (originalClaudeCode === undefined) {
-      delete process.env.CLAUDECODE;
-    } else {
-      process.env.CLAUDECODE = originalClaudeCode;
-    }
-  });
-
-  it('throws when workflow file already exists', async () => {
-    // pathExists returns true for both docs.json and the workflow file
-    vi.mocked(fse.pathExists).mockResolvedValue(true as never);
-    const originalIsTTY = process.stdin.isTTY;
-    const originalClaudeCode = process.env.CLAUDECODE;
-    process.stdin.isTTY = true;
-    delete process.env.CLAUDECODE;
-
-    const { input, select, editor } = await import('@inquirer/prompts');
-    vi.mocked(input)
-      .mockResolvedValueOnce('My Workflow') // workflow name
-      .mockResolvedValueOnce('0 9 * * 1') // cron expression
-      .mockResolvedValueOnce(''); // context repos
-    vi.mocked(select)
-      .mockResolvedValueOnce('cron') // trigger type
-      .mockResolvedValueOnce('no'); // automerge
-    vi.mocked(editor).mockResolvedValueOnce('Do the thing');
-
-    const expectedRelative = path.join('.mintlify', 'workflows', 'my-workflow.md');
-    await expect(addWorkflow()).rejects.toThrow(
-      `A workflow already exists at ${expectedRelative}. Please choose a different name or delete the existing file.`
-    );
-    expect(fse.writeFile).not.toHaveBeenCalled();
-
-    process.stdin.isTTY = originalIsTTY;
-    if (originalClaudeCode === undefined) {
-      delete process.env.CLAUDECODE;
-    } else {
-      process.env.CLAUDECODE = originalClaudeCode;
-    }
-  });
-
-  it('creates cron workflow file with correct content', async () => {
-    // true for docs.json, false for workflow file existence check
-    vi.mocked(fse.pathExists)
-      .mockResolvedValueOnce(true as never)
-      .mockResolvedValueOnce(false as never);
-    const originalIsTTY = process.stdin.isTTY;
-    const originalClaudeCode = process.env.CLAUDECODE;
-    process.stdin.isTTY = true;
-    delete process.env.CLAUDECODE;
-
-    const { input, select, editor } = await import('@inquirer/prompts');
-    vi.mocked(input)
-      .mockResolvedValueOnce('My Test Workflow') // workflow name
-      .mockResolvedValueOnce('0 9 * * 1') // cron expression
-      .mockResolvedValueOnce(''); // context repos
-    vi.mocked(select)
-      .mockResolvedValueOnce('cron') // trigger type
-      .mockResolvedValueOnce('no'); // automerge
-    vi.mocked(editor).mockResolvedValueOnce('Do the thing');
-
-    await addWorkflow();
-
-    expect(fse.ensureDir).toHaveBeenCalledWith(WORKFLOWS_DIR);
-    expect(fse.writeFile).toHaveBeenCalledWith(
-      path.join(WORKFLOWS_DIR, 'my-test-workflow.md'),
-      '---\nname: "My Test Workflow"\non:\n  cron: "0 9 * * 1"\n---\n\nDo the thing\n'
-    );
-    const expectedRelative = path.join('.mintlify', 'workflows', 'my-test-workflow.md');
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({
-        props: { message: `Workflow created at ${expectedRelative}` },
-      })
-    );
-
-    process.stdin.isTTY = originalIsTTY;
-    if (originalClaudeCode === undefined) {
-      delete process.env.CLAUDECODE;
-    } else {
-      process.env.CLAUDECODE = originalClaudeCode;
-    }
-  });
-
-  it('creates push trigger workflow with automerge and context', async () => {
-    vi.mocked(fse.pathExists)
-      .mockResolvedValueOnce(true as never)
-      .mockResolvedValueOnce(false as never);
-    const originalIsTTY = process.stdin.isTTY;
-    const originalClaudeCode = process.env.CLAUDECODE;
-    process.stdin.isTTY = true;
-    delete process.env.CLAUDECODE;
-
-    const { input, select, editor } = await import('@inquirer/prompts');
-    vi.mocked(input)
-      .mockResolvedValueOnce('Deploy Docs') // workflow name
-      .mockResolvedValueOnce('org/docs') // trigger repos
-      .mockResolvedValueOnce('org/server'); // context repos
-    vi.mocked(select)
-      .mockResolvedValueOnce('push') // trigger type
-      .mockResolvedValueOnce('yes'); // automerge
-    vi.mocked(editor).mockResolvedValueOnce('Deploy the docs');
-
-    await addWorkflow();
-
-    expect(fse.writeFile).toHaveBeenCalledWith(
-      path.join(WORKFLOWS_DIR, 'deploy-docs.md'),
-      '---\nname: "Deploy Docs"\non:\n  push:\n    - repo: "org/docs"\ncontext:\n  - repo: "org/server"\nautomerge: true\n---\n\nDeploy the docs\n'
-    );
-
-    process.stdin.isTTY = originalIsTTY;
-    if (originalClaudeCode === undefined) {
-      delete process.env.CLAUDECODE;
-    } else {
-      process.env.CLAUDECODE = originalClaudeCode;
-    }
-  });
-});

package/bin/workflow.js

@@ -1,150 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { jsx as _jsx } from "react/jsx-runtime";
-import { select, input, editor } from '@inquirer/prompts';
-import { addLog, addLogs, SuccessLog } from '@mintlify/previewing';
-import fse from 'fs-extra';
-import { Text } from 'ink';
-import path from 'path';
-import { CMD_EXEC_PATH, isAI } from './helpers.js';
-export function slugify(name) {
-    return name
-        .toLowerCase()
-        .replace(/[^a-z0-9]+/g, '-')
-        .replace(/^-|-$/g, '');
-}
-const CRON_FIELD = /^(\*|(\*\/\d+)|(\d+(-\d+)?(,\d+(-\d+)?)*))$/;
-export function isValidCron(expr) {
-    const fields = expr.trim().split(/\s+/);
-    if (fields.length !== 5)
-        return false;
-    return fields.every((f) => CRON_FIELD.test(f));
-}
-function escapeYaml(value) {
-    return value.replace(/\\/g, '\\\\').replace(/"/g, '\\"');
-}
-export function buildFrontmatter(config) {
-    var _a;
-    const lines = [];
-    lines.push(`name: "${escapeYaml(config.name)}"`);
-    if (config.triggerType === 'push') {
-        lines.push('on:');
-        lines.push('  push:');
-        if (config.triggerRepos) {
-            for (const repo of config.triggerRepos) {
-                lines.push(`    - repo: "${escapeYaml(repo)}"`);
-            }
-        }
-    }
-    else {
-        lines.push('on:');
-        lines.push(`  cron: "${escapeYaml((_a = config.cronExpression) !== null && _a !== void 0 ? _a : '')}"`);
-    }
-    if (config.contextRepos && config.contextRepos.length > 0) {
-        lines.push('context:');
-        for (const repo of config.contextRepos) {
-            lines.push(`  - repo: "${escapeYaml(repo)}"`);
-        }
-    }
-    if (config.automerge) {
-        lines.push('automerge: true');
-    }
-    return `---\n${lines.join('\n')}\n---`;
-}
-const sendUsageMessageForAI = () => {
-    addLogs(_jsx(Text, { children: "Agent Detected - sending AI friendly prompt" }), _jsx(Text, { children: '<system-message>' }), _jsx(Text, { children: "Example usage of `mintlify workflow`. This command is interactive and creates a workflow file in `.mintlify/workflows/`." }), _jsx(Text, { children: "Workflow files are Markdown files with YAML frontmatter. Instead of running this command, you can directly create a `.mintlify/workflows/your-workflow.md` file." }), _jsx(Text, { children: "Frontmatter fields: name (string), on.cron (string) or on.push with repo list, context (array of objects with repo key), automerge (boolean, only when true)." }), _jsx(Text, { children: "The Markdown body contains the agent instructions/prompt." }), _jsx(Text, { children: '</system-message>' }));
-};
-export function addWorkflow() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const docsJsonPath = path.join(CMD_EXEC_PATH, 'docs.json');
-        if (!(yield fse.pathExists(docsJsonPath))) {
-            throw new Error('docs.json not found in the current directory. Please run this command from your docs repository root.');
-        }
-        if (isAI()) {
-            sendUsageMessageForAI();
-            return;
-        }
-        const workflowName = yield input({
-            message: 'Workflow name',
-            default: 'Update changelog',
-        });
-        if (!workflowName.trim()) {
-            throw new Error('Workflow name cannot be empty.');
-        }
-        const slug = slugify(workflowName);
-        if (!slug) {
-            throw new Error('Workflow name must contain at least one alphanumeric character.');
-        }
-        const triggerType = yield select({
-            message: 'Trigger type',
-            choices: [
-                { name: 'Cron (scheduled)', value: 'cron' },
-                { name: 'Push (on push to repo)', value: 'push' },
-            ],
-        });
-        let cronExpression;
-        let triggerRepos = [];
-        if (triggerType === 'cron') {
-            cronExpression = yield input({
-                message: 'Cron expression',
-                default: '0 9 * * 1',
-                validate: (value) => isValidCron(value) ||
-                    'Invalid cron expression. Expected 5 fields: minute hour day-of-month month day-of-week (e.g. 0 9 * * 1).',
-            });
-        }
-        else {
-            const triggerReposInput = yield input({
-                message: 'Trigger repos (comma-separated, e.g. your-org/your-docs)',
-                default: '',
-            });
-            triggerRepos = triggerReposInput
-                .split(',')
-                .map((r) => r.trim())
-                .filter(Boolean);
-        }
-        const contextReposInput = yield input({
-            message: 'Context repos (comma-separated, e.g. your-org/your-product, optional)',
-            default: '',
-        });
-        const contextRepos = contextReposInput
-            .split(',')
-            .map((r) => r.trim())
-            .filter(Boolean);
-        const automergeChoice = yield select({
-            message: 'Enable automerge?',
-            choices: [
-                { name: 'Yes', value: 'yes' },
-                { name: 'No', value: 'no' },
-            ],
-        });
-        const instructions = yield editor({
-            message: 'Agent instructions (opens your default editor)',
-            default: '# Agent Instructions\n\nDescribe what this workflow should do.\n\nFor example:\n- Update the changelog based on recent commits\n- Summarize recent PRs\n',
-        });
-        const frontmatter = buildFrontmatter({
-            name: workflowName,
-            triggerType,
-            cronExpression,
-            triggerRepos,
-            contextRepos: contextRepos.length > 0 ? contextRepos : undefined,
-            automerge: automergeChoice === 'yes',
-        });
-        const filename = slug + '.md';
-        const workflowDir = path.join(CMD_EXEC_PATH, '.mintlify', 'workflows');
-        const filePath = path.join(workflowDir, filename);
-        const relativePath = path.relative(CMD_EXEC_PATH, filePath);
-        yield fse.ensureDir(workflowDir);
-        if (yield fse.pathExists(filePath)) {
-            throw new Error(`A workflow already exists at ${relativePath}. Please choose a different name or delete the existing file.`);
-        }
-        yield fse.writeFile(filePath, frontmatter + '\n\n' + instructions.trim() + '\n');
-        addLog(_jsx(SuccessLog, { message: `Workflow created at ${relativePath}` }));
-    });
-}