Skip to content

feat: add --config flag for chronicle.yaml path #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rsbh merged 6 commits into from
Apr 1, 2026
Merged

feat: add --config flag for chronicle.yaml path #26

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0855ff5
fix: resolve chronicle.yaml only from cwd, not content dir
rsbh Mar 31, 2026
f0d6038
feat: add --config flag and remove -c short arg from CLI commands
rsbh Mar 31, 2026
3a9d126
fix: throw error when explicit --config path is unreadable
rsbh Mar 31, 2026
1e146a7
fix: rename configFlag to configPath and return undefined instead of …
rsbh Apr 1, 2026
09d2628
refactor: use fs promises and simplify resolveConfigPath
rsbh Apr 1, 2026
3e0a2a6
refactor: extract readConfig function with separate error handling
rsbh Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions packages/chronicle/src/cli/commands/build.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
import chalk from 'chalk';
import { Command } from 'commander';
import { resolveContentDir } from '@/cli/utils/config';
import { resolveConfigPath, resolveContentDir } from '@/cli/utils/config';
import { PACKAGE_ROOT } from '@/cli/utils/resolve';
import { linkContent } from '@/cli/utils/scaffold';

export const buildCommand = new Command('build')
.description('Build for production')
.option('-c, --content <path>', 'Content directory')
.option('--content <path>', 'Content directory')
.option('--config <path>', 'Path to chronicle.yaml')
.option(
'--preset <preset>',
'Deploy preset (vercel, cloudflare, node-server)'
)
.action(async options => {
const contentDir = resolveContentDir(options.content);
const configPath = resolveConfigPath(options.config);
Comment thread
rsbh marked this conversation as resolved.
await linkContent(contentDir);

console.log(chalk.cyan('Building for production...'));
Expand All @@ -24,6 +26,7 @@ export const buildCommand = new Command('build')
packageRoot: PACKAGE_ROOT,
projectRoot: process.cwd(),
contentDir,
configPath: configPath ?? undefined,
preset: options.preset
});

Expand Down
8 changes: 5 additions & 3 deletions packages/chronicle/src/cli/commands/dev.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@ import fs from 'node:fs';
import path from 'node:path';
import chalk from 'chalk';
import { Command } from 'commander';
import { resolveContentDir } from '@/cli/utils/config';
import { resolveConfigPath, resolveContentDir } from '@/cli/utils/config';
import { PACKAGE_ROOT } from '@/cli/utils/resolve';
import { linkContent } from '@/cli/utils/scaffold';

export const devCommand = new Command('dev')
.description('Start development server')
.option('-p, --port <port>', 'Port number', '3000')
.option('-c, --content <path>', 'Content directory')
.option('--content <path>', 'Content directory')
.option('--config <path>', 'Path to chronicle.yaml')
.action(async options => {
const contentDir = resolveContentDir(options.content);
const configPath = resolveConfigPath(options.config);
const port = parseInt(options.port, 10);

await linkContent(contentDir);
Expand All @@ -21,7 +23,7 @@ export const devCommand = new Command('dev')
const { createServer } = await import('vite');
const { createViteConfig } = await import('@/server/vite-config');

const config = await createViteConfig({ packageRoot: PACKAGE_ROOT, projectRoot: process.cwd(), contentDir });
const config = await createViteConfig({ packageRoot: PACKAGE_ROOT, projectRoot: process.cwd(), contentDir, configPath: configPath ?? undefined });
const server = await createServer({
...config,
server: { ...config.server, port }
Expand Down
7 changes: 5 additions & 2 deletions packages/chronicle/src/cli/commands/serve.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
import chalk from 'chalk';
import { Command } from 'commander';
import { resolveContentDir } from '@/cli/utils/config';
import { resolveConfigPath, resolveContentDir } from '@/cli/utils/config';
import { PACKAGE_ROOT } from '@/cli/utils/resolve';
import { linkContent } from '@/cli/utils/scaffold';

export const serveCommand = new Command('serve')
.description('Build and start production server')
.option('-p, --port <port>', 'Port number', '3000')
.option('-c, --content <path>', 'Content directory')
.option('--content <path>', 'Content directory')
.option('--config <path>', 'Path to chronicle.yaml')
.option(
'--preset <preset>',
'Deploy preset (vercel, cloudflare, node-server)'
)
.action(async options => {
const contentDir = resolveContentDir(options.content);
const configPath = resolveConfigPath(options.config);
const port = parseInt(options.port, 10);
await linkContent(contentDir);

Expand All @@ -24,6 +26,7 @@ export const serveCommand = new Command('serve')
packageRoot: PACKAGE_ROOT,
projectRoot: process.cwd(),
contentDir,
configPath: configPath ?? undefined,
preset: options.preset
});

Expand Down
2 changes: 1 addition & 1 deletion packages/chronicle/src/cli/commands/start.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { linkContent } from '@/cli/utils/scaffold';
export const startCommand = new Command('start')
.description('Start production server')
.option('-p, --port <port>', 'Port number', '3000')
Comment thread
rsbh marked this conversation as resolved.
.option('-c, --content <path>', 'Content directory')
.option('--content <path>', 'Content directory')
.action(async options => {
const contentDir = resolveContentDir(options.content);
const port = parseInt(options.port, 10);
Expand Down
11 changes: 5 additions & 6 deletions packages/chronicle/src/cli/utils/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,20 @@ export function resolveContentDir(contentFlag?: string): string {
return path.resolve('content');
}

function resolveConfigPath(contentDir: string): string | null {
export function resolveConfigPath(configFlag?: string): string | null {
if (configFlag) return path.resolve(configFlag);
const cwdPath = path.join(process.cwd(), 'chronicle.yaml');
if (fs.existsSync(cwdPath)) return cwdPath;
const contentPath = path.join(contentDir, 'chronicle.yaml');
if (fs.existsSync(contentPath)) return contentPath;
return null;
}
Comment thread
rsbh marked this conversation as resolved.

export function loadCLIConfig(contentDir: string): CLIConfig {
const configPath = resolveConfigPath(contentDir);
export function loadCLIConfig(contentDir: string, configFlag?: string): CLIConfig {
Comment thread
rsbh marked this conversation as resolved.
Outdated
const configPath = resolveConfigPath(configFlag);

if (!configPath) {
console.log(
chalk.red(
`Error: chronicle.yaml not found in '${process.cwd()}' or '${contentDir}'`
`Error: chronicle.yaml not found in '${process.cwd()}'`
)
);
console.log(chalk.gray("Run 'chronicle init' to create one"));
Expand Down
22 changes: 13 additions & 9 deletions packages/chronicle/src/server/vite-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,30 @@ export interface ViteConfigOptions {
packageRoot: string;
projectRoot: string;
contentDir: string;
configPath?: string;
preset?: string;
}

async function readChronicleConfig(projectRoot: string, contentDir: string): Promise<string | null> {
for (const dir of [projectRoot, contentDir]) {
const filePath = path.join(dir, 'chronicle.yaml');
async function readChronicleConfig(projectRoot: string, configPath?: string): Promise<string | null> {
if (configPath) {
try {
return await fs.readFile(filePath, 'utf-8');
} catch {
// not found, try next
return await fs.readFile(configPath, 'utf-8');
} catch (error) {
throw new Error(`Failed to read config file '${configPath}': ${(error as Error).message}`);
}
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
return null;
try {
return await fs.readFile(path.join(projectRoot, 'chronicle.yaml'), 'utf-8');
} catch {
return null;
}
}

export async function createViteConfig(
options: ViteConfigOptions
): Promise<InlineConfig> {
const { packageRoot, projectRoot, contentDir, preset } = options;
const rawConfig = await readChronicleConfig(projectRoot, contentDir);
const { packageRoot, projectRoot, contentDir, configPath, preset } = options;
const rawConfig = await readChronicleConfig(projectRoot, configPath);

return {
root: packageRoot,
Expand Down