@atcute/lex-cli 2.7.0 → 2.8.1

package/src/commands/pull.ts

@@ -3,34 +3,14 @@ import * as path from 'node:path';
 
 import { lexiconDoc, refineLexiconDoc, type LexiconDoc } from '@atcute/lexicon-doc';
 
-import { merge, object } from '@optique/core/constructs';
-import { message } from '@optique/core/message';
-import { type InferValue } from '@optique/core/parser';
-import { command, constant } from '@optique/core/primitives';
 import pc from 'picocolors';
 
+import type { PullCommand } from '../cli.ts';
 import { loadConfig, type NormalizedConfig, type PullConfig, type SourceConfig } from '../config.ts';
 import { createFormatter, type Formatter } from '../formatter.ts';
 import { pullAtprotoSource } from '../pull-sources/atproto.ts';
 import { pullGitSource } from '../pull-sources/git.ts';
 import type { PullResult, PulledLexicon, SourceLocation } from '../pull-sources/types.ts';
-import { sharedOptions } from '../shared-options.ts';
-
-export const pullCommandSchema = command(
-	'pull',
-	merge(
-		object({
-			type: constant('pull'),
-		}),
-		sharedOptions,
-	),
-	{
-		brief: message`pull lexicon documents from configured sources`,
-		description: message`fetches lexicon documents from configured git repositories and writes them to the output directory.`,
-	},
-);
-
-export type PullCommand = InferValue<typeof pullCommandSchema>;
 
 interface SourceRevision {
 	source: SourceConfig;
@@ -180,7 +160,7 @@ const writeSourceReadme = async (
  * runs the pull command to fetch lexicon documents from configured sources
  * @param args parsed command arguments
  */
-export const runPull = async (args: PullCommand): Promise<void> => {
+export const handler = async (args: PullCommand): Promise<void> => {
 	const config = await loadConfig(args.config);
 	const pullConfig = ensurePullConfig(config);
 

package/src/config.ts

@@ -79,15 +79,6 @@ const formatterConfigSchema = v.union(
 	}),
 );
 
-export type GitSourceConfig = v.Infer<typeof gitSourceConfigSchema>;
-export type AtprotoNsidsSourceConfig = v.Infer<typeof atprotoNsidsSourceConfigSchema>;
-export type AtprotoAuthoritySourceConfig = v.Infer<typeof atprotoAuthoritySourceConfigSchema>;
-export type AtprotoSourceConfig = v.Infer<typeof atprotoSourceConfigSchema>;
-export type SourceConfig = v.Infer<typeof sourceConfigSchema>;
-export type PullConfig = v.Infer<typeof pullConfigSchema>;
-export type ExportConfig = v.Infer<typeof exportConfigSchema>;
-export type FormatterConfig = v.Infer<typeof formatterConfigSchema>;
-
 const isValidLexiconPattern = (pattern: string): boolean => {
 	if (pattern.endsWith('.*')) {
 		return isNsid(`${pattern.slice(0, -2)}.x`);
@@ -127,32 +118,71 @@ const importMappingSchema: v.Type<ImportMapping> = v.object({
 	imports: mappingImports,
 });
 
-export const lexiconConfigSchema = v.object({
-	outdir: v.string().assert((value) => value.length > 0, `must not be empty`),
+const modulesConfigSchema = v
+	.object({
+		importSuffix: v
+			.string()
+			.assert((value) => value.length > 0, `must not be empty`)
+			.optional(),
+	})
+	.partial();
+
+const generateConfigSchema = v.object({
+	outdir: v
+		.string()
+		.assert((value) => value.length > 0, `must not be empty`)
+		.optional(),
 	files: v
 		.array(v.string().assert((value) => value.length > 0, `must not be empty`))
-		.assert((value) => value.length > 0, `must include at least one glob pattern`),
+		.assert((value) => value.length > 0, `must include at least one glob pattern`)
+		.optional(),
 	imports: v.array(v.string().assert((value) => value.length > 0, `must not be empty`)).optional(),
 	mappings: v.array(importMappingSchema).optional(),
-	modules: v
-		.object({
-			importSuffix: v
-				.string()
-				.assert((value) => value.length > 0, `must not be empty`)
-				.optional(),
-		})
-		.partial()
+	modules: modulesConfigSchema.optional(),
+	clean: v.boolean().optional(),
+});
+
+export type GitSourceConfig = v.Infer<typeof gitSourceConfigSchema>;
+export type AtprotoNsidsSourceConfig = v.Infer<typeof atprotoNsidsSourceConfigSchema>;
+export type AtprotoAuthoritySourceConfig = v.Infer<typeof atprotoAuthoritySourceConfigSchema>;
+export type AtprotoSourceConfig = v.Infer<typeof atprotoSourceConfigSchema>;
+export type SourceConfig = v.Infer<typeof sourceConfigSchema>;
+export type PullConfig = v.Infer<typeof pullConfigSchema>;
+export type ExportConfig = v.Infer<typeof exportConfigSchema>;
+export type FormatterConfig = v.Infer<typeof formatterConfigSchema>;
+export type GenerateConfig = v.Infer<typeof generateConfigSchema>;
+
+export const lexiconConfigSchema = v.object({
+	/** @deprecated moved to `generate.outdir` */
+	outdir: v
+		.string()
+		.assert((value) => value.length > 0, `must not be empty`)
+		.optional(),
+	/** @deprecated moved to `generate.files` */
+	files: v
+		.array(v.string().assert((value) => value.length > 0, `must not be empty`))
+		.assert((value) => value.length > 0, `must include at least one glob pattern`)
 		.optional(),
+	/** @deprecated moved to `generate.imports` */
+	imports: v.array(v.string().assert((value) => value.length > 0, `must not be empty`)).optional(),
+	/** @deprecated moved to `generate.mappings` */
+	mappings: v.array(importMappingSchema).optional(),
+	/** @deprecated moved to `generate.modules` */
+	modules: modulesConfigSchema.optional(),
 	formatter: formatterConfigSchema.optional((): FormatterConfig => ({ type: 'prettier' })),
+	generate: generateConfigSchema.optional(),
 	pull: pullConfigSchema.optional(),
 	export: exportConfigSchema.optional(),
 });
 
 export type LexiconConfig = v.Infer<typeof lexiconConfigSchema>;
 
-export interface NormalizedConfig extends LexiconConfig {
+export type NormalizedConfig = Omit<
+	LexiconConfig,
+	'outdir' | 'files' | 'imports' | 'mappings' | 'modules'
+> & {
 	root: string;
-}
+};
 
 export const loadConfig = async (configPath?: string): Promise<NormalizedConfig> => {
 	let configFilename: string | undefined;
@@ -207,5 +237,29 @@ export const loadConfig = async (configPath?: string): Promise<NormalizedConfig>
 		process.exit(1);
 	}
 
-	return { ...configResult.value, root: configDirname };
+	const { outdir, files, imports, mappings, modules, generate, ...rest } = configResult.value;
+
+	// back-compat: top-level generate options were moved into `generate.*`. merge the legacy
+	// top-level values into `generate`, with nested `generate.*` winning on conflicts. the result
+	// is only present if at least one generate-related option was provided anywhere.
+	const hasLegacyTopLevel =
+		outdir !== undefined ||
+		files !== undefined ||
+		imports !== undefined ||
+		mappings !== undefined ||
+		modules !== undefined;
+
+	let normalizedGenerate: GenerateConfig | undefined;
+	if (generate || hasLegacyTopLevel) {
+		normalizedGenerate = {
+			outdir: generate?.outdir ?? outdir,
+			files: generate?.files ?? files,
+			imports: generate?.imports ?? imports,
+			mappings: generate?.mappings ?? mappings,
+			modules: generate?.modules ?? modules,
+			clean: generate?.clean,
+		};
+	}
+
+	return { ...rest, generate: normalizedGenerate, root: configDirname };
 };

package/src/pull-sources/git.ts

@@ -26,80 +26,81 @@ export const pullGitSource = async (
 	const cloneDir = path.join(tempParent, 'repo');
 
 	try {
-		await runGit(
-			[
-				'clone',
-				'--filter=blob:none',
-				'--depth',
-				'1',
-				'--sparse',
-				...(source.ref ? ['--branch', source.ref, '--single-branch'] : []),
-				source.remote,
-				cloneDir,
-			],
-			{ timeoutMs: 60_000 },
-		);
-	} catch (err) {
-		if (err instanceof GitError) {
-			console.error(pc.bold(pc.red(`git clone failed for ${source.remote}:`)));
-			console.error(err.stderr || err.message);
-			process.exit(1);
+		try {
+			await runGit(
+				[
+					'clone',
+					'--filter=blob:none',
+					'--depth',
+					'1',
+					'--sparse',
+					...(source.ref ? ['--branch', source.ref, '--single-branch'] : []),
+					source.remote,
+					cloneDir,
+				],
+				{ timeoutMs: 60_000 },
+			);
+		} catch (err) {
+			if (err instanceof GitError) {
+				console.error(pc.bold(pc.red(`git clone failed for ${source.remote}:`)));
+				console.error(err.stderr || err.message);
+				process.exit(1);
+			}
+
+			throw err;
 		}
 
-		throw err;
-	}
-
-	try {
-		await runGit(['-C', cloneDir, 'sparse-checkout', 'set', '--no-cone', ...source.pattern], {
-			timeoutMs: 30_000,
-		});
-	} catch (err) {
-		if (err instanceof GitError) {
-			console.error(pc.bold(pc.red(`git sparse-checkout failed for ${source.remote}:`)));
-			console.error(err.stderr || err.message);
-			process.exit(1);
+		try {
+			await runGit(['-C', cloneDir, 'sparse-checkout', 'set', '--no-cone', ...source.pattern], {
+				timeoutMs: 30_000,
+			});
+		} catch (err) {
+			if (err instanceof GitError) {
+				console.error(pc.bold(pc.red(`git sparse-checkout failed for ${source.remote}:`)));
+				console.error(err.stderr || err.message);
+				process.exit(1);
+			}
+
+			throw err;
 		}
 
-		throw err;
-	}
-
-	const pulled = new Map<string, PulledLexicon>();
+		const pulled = new Map<string, PulledLexicon>();
 
-	for await (const filename of fs.glob(source.pattern, { cwd: cloneDir })) {
-		const absolute = path.join(cloneDir, filename);
-		const stat = await fs.stat(absolute);
+		for await (const filename of fs.glob(source.pattern, { cwd: cloneDir })) {
+			const absolute = path.join(cloneDir, filename);
+			const stat = await fs.stat(absolute);
 
-		if (!stat.isFile()) {
-			continue;
-		}
+			if (!stat.isFile()) {
+				continue;
+			}
 
-		const location: SourceLocation = {
-			absolutePath: absolute,
-			relativePath: filename,
-			sourceDescription: source.remote,
-		};
+			const location: SourceLocation = {
+				absolutePath: absolute,
+				relativePath: filename,
+				sourceDescription: source.remote,
+			};
 
-		const doc = await parseLexiconFile(location);
+			const doc = await parseLexiconFile(location);
 
-		pulled.set(doc.id, { nsid: doc.id, doc, location });
-	}
+			pulled.set(doc.id, { nsid: doc.id, doc, location });
+		}
 
-	// get the commit hash
-	let rev: string;
-	try {
-		const result = await runGit(['-C', cloneDir, 'rev-parse', 'HEAD'], { timeoutMs: 10_000 });
-		rev = result.stdout.trim();
-	} catch (err) {
-		if (err instanceof GitError) {
-			console.error(pc.bold(pc.red(`git rev-parse failed for ${source.remote}:`)));
-			console.error(err.stderr || err.message);
-			process.exit(1);
+		let rev: string;
+		try {
+			const result = await runGit(['-C', cloneDir, 'rev-parse', 'HEAD'], { timeoutMs: 10_000 });
+			rev = result.stdout.trim();
+		} catch (err) {
+			if (err instanceof GitError) {
+				console.error(pc.bold(pc.red(`git rev-parse failed for ${source.remote}:`)));
+				console.error(err.stderr || err.message);
+				process.exit(1);
+			}
+
+			throw err;
 		}
 
-		throw err;
+		return { pulled, rev };
+	} finally {
+		await fs.rm(tempParent, { recursive: true, force: true });
 	}
-
-	await fs.rm(tempParent, { recursive: true, force: true });
-
-	return { pulled, rev };
 };

package/dist/shared-options.d.ts

@@ -1,6 +0,0 @@
-export declare const sharedOptions: import("@optique/core/parser").Parser<"sync", {
-    readonly config: string | undefined;
-}, {
-    readonly config: [import("@optique/core/valueparser").ValueParserResult<string> | undefined] | undefined;
-}>;
-//# sourceMappingURL=shared-options.d.ts.map

package/dist/shared-options.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"shared-options.d.ts","sourceRoot":"","sources":["../src/shared-options.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,aAAa;;;;EAMxB,CAAC"}

package/dist/shared-options.js

@@ -1,11 +0,0 @@
-import { object } from '@optique/core/constructs';
-import { message } from '@optique/core/message';
-import { optional } from '@optique/core/modifiers';
-import { option } from '@optique/core/primitives';
-import { path as pathParser } from '@optique/run/valueparser';
-export const sharedOptions = object(`Global options`, {
-    config: optional(option('-c', '--config', pathParser({ metavar: 'CONFIG' }), {
-        description: message `path to the lexicon configuration file. defaults to searching for lex.config.js or lex.config.ts in the current directory.`,
-    })),
-});
-//# sourceMappingURL=shared-options.js.map

package/dist/shared-options.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"shared-options.js","sourceRoot":"","sources":["../src/shared-options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,OAAO,EAAE,IAAI,IAAI,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAE9D,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,gBAAgB,EAAE;IACrD,MAAM,EAAE,QAAQ,CACf,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE;QAC3D,WAAW,EAAE,OAAO,CAAA,4HAA4H;KAChJ,CAAC,CACF;CACD,CAAC,CAAC"}

package/src/shared-options.ts

@@ -1,13 +0,0 @@
-import { object } from '@optique/core/constructs';
-import { message } from '@optique/core/message';
-import { optional } from '@optique/core/modifiers';
-import { option } from '@optique/core/primitives';
-import { path as pathParser } from '@optique/run/valueparser';
-
-export const sharedOptions = object(`Global options`, {
-	config: optional(
-		option('-c', '--config', pathParser({ metavar: 'CONFIG' }), {
-			description: message`path to the lexicon configuration file. defaults to searching for lex.config.js or lex.config.ts in the current directory.`,
-		}),
-	),
-});