feat(cli): generate commented wmill.yaml and add config reference command (#8546)
* feat: generate commented wmill.yaml template and add config reference command Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: add missing options to config reference (promotion, skipBranchValidation, commonSpecificItems) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * refactor: generate YAML template from CONFIG_REFERENCE instead of handwritten string Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: preserve YAML comments when binding workspace profile during init Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * refactor: simplify to `wmill config` and reorder table columns Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * feat: generate JSON Schema for wmill.yaml editor autocomplete and validation Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * refactor: remove redundant templateValue fields and make specificItemsSchema data-driven Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * refactor: use native JSON Schema types in CONFIG_REFERENCE, strip non-schema keys for generation Eliminates typeToJsonSchema, specificItemsSchema, codebaseItemSchema, branchConfigSchema, and the complex generateJsonSchema body. Each CONFIG_REFERENCE entry is now a JSON Schema property with extra metadata. Schema generation just iterates and strips non-schema keys. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * refactor: remove typeLabel and displayType — use schema types directly Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * refactor: remove hidden entries, auto-expand nested schemas in reference table Sub-fields (codebases[], gitBranches.<branch>.*) are now derived from the parent's inline schema instead of being maintained as duplicate hidden entries. Removes 29 entries and the hidden field entirely. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: use console.log for JSON output and quote YAML-special branch names Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * chore: regenerate system prompts to include new config command Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: review feedback + add tests for template, schema, and config reference - Use console.log for --json output (no ANSI escape codes) - Quote branch names with YAML-special characters - Add 28 tests covering template generation, JSON Schema validation, config reference formatting, and CONFIG_REFERENCE integrity Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * feat: add generate-schema script and commit wmill.schema.json to repo Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * refactor: remove schema.json generation from wmill init Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: eliminate read-back cycle, harden yamlKey, fix triple negation Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
centdix
244
cli/test/init_template.test.ts
Normal file
244
cli/test/init_template.test.ts
Normal file
@@ -0,0 +1,244 @@
|
||||
/**
|
||||
* Unit tests for wmill.yaml template generation, config reference, and JSON Schema.
|
||||
*/
|
||||
|
||||
import { expect, test, describe } from "bun:test";
|
||||
import { parse } from "yaml";
|
||||
import Ajv from "ajv";
|
||||
import {
|
||||
generateCommentedTemplate,
|
||||
generateJsonSchema,
|
||||
formatConfigReference,
|
||||
formatConfigReferenceJson,
|
||||
CONFIG_REFERENCE,
|
||||
} from "../src/commands/init/template.ts";
|
||||
|
||||
// =============================================================================
|
||||
// generateCommentedTemplate
|
||||
// =============================================================================
|
||||
|
||||
describe("generateCommentedTemplate", () => {
|
||||
test("produces valid YAML that parses without errors", () => {
|
||||
const yaml = generateCommentedTemplate("main");
|
||||
const config = parse(yaml);
|
||||
expect(config).toBeDefined();
|
||||
expect(typeof config).toBe("object");
|
||||
});
|
||||
|
||||
test("uses provided branch name in gitBranches", () => {
|
||||
const config = parse(generateCommentedTemplate("my-feature"));
|
||||
expect(config.gitBranches["my-feature"]).toBeDefined();
|
||||
expect(config.gitBranches["my-feature"].overrides).toEqual({});
|
||||
});
|
||||
|
||||
test("defaults to 'main' when no branch name given", () => {
|
||||
const config = parse(generateCommentedTemplate());
|
||||
expect(config.gitBranches["main"]).toBeDefined();
|
||||
});
|
||||
|
||||
test("quotes branch names with YAML-special characters", () => {
|
||||
const specialBranches = ["fix: something", "feat/my branch", "release#1"];
|
||||
for (const branch of specialBranches) {
|
||||
const yaml = generateCommentedTemplate(branch);
|
||||
const config = parse(yaml);
|
||||
expect(config.gitBranches[branch]).toBeDefined();
|
||||
}
|
||||
});
|
||||
|
||||
test("contains yaml-language-server schema directive", () => {
|
||||
const yaml = generateCommentedTemplate("main");
|
||||
expect(yaml.startsWith("# yaml-language-server: $schema=wmill.schema.json")).toBe(true);
|
||||
});
|
||||
|
||||
test("includes all non-commented CONFIG_REFERENCE entries as active YAML keys", () => {
|
||||
const config = parse(generateCommentedTemplate("main"));
|
||||
for (const opt of CONFIG_REFERENCE) {
|
||||
if (!opt.commented) {
|
||||
expect(config).toHaveProperty(opt.name);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
test("does not include commented entries as active YAML keys", () => {
|
||||
const config = parse(generateCommentedTemplate("main"));
|
||||
for (const opt of CONFIG_REFERENCE) {
|
||||
if (opt.commented && opt.name !== "environments") {
|
||||
expect(config[opt.name]).toBeUndefined();
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
test("default values match expected defaults", () => {
|
||||
const config = parse(generateCommentedTemplate("main"));
|
||||
expect(config.defaultTs).toBe("bun");
|
||||
expect(config.skipSecrets).toBe(true);
|
||||
expect(config.nonDottedPaths).toBe(true);
|
||||
expect(config.codebases).toEqual([]);
|
||||
expect(config.excludes).toEqual([]);
|
||||
expect(config.includes).toEqual(["f/**"]);
|
||||
});
|
||||
});
|
||||
|
||||
// =============================================================================
|
||||
// generateJsonSchema
|
||||
// =============================================================================
|
||||
|
||||
describe("generateJsonSchema", () => {
|
||||
const schema = generateJsonSchema();
|
||||
|
||||
test("is a valid JSON Schema draft-07", () => {
|
||||
expect(schema.$schema).toBe("http://json-schema.org/draft-07/schema#");
|
||||
expect(schema.type).toBe("object");
|
||||
expect(schema.properties).toBeDefined();
|
||||
});
|
||||
|
||||
test("validates the generated YAML template", () => {
|
||||
const config = parse(generateCommentedTemplate("main"));
|
||||
const ajv = new Ajv({ allErrors: true });
|
||||
const validate = ajv.compile(schema);
|
||||
expect(validate(config)).toBe(true);
|
||||
});
|
||||
|
||||
test("rejects unknown keys", () => {
|
||||
const ajv = new Ajv({ allErrors: true });
|
||||
const validate = ajv.compile(schema);
|
||||
expect(validate({ unknownOption: true })).toBe(false);
|
||||
});
|
||||
|
||||
test("rejects invalid enum values", () => {
|
||||
const ajv = new Ajv({ allErrors: true });
|
||||
const validate = ajv.compile(schema);
|
||||
expect(validate({ defaultTs: "python" })).toBe(false);
|
||||
});
|
||||
|
||||
test("rejects wrong types", () => {
|
||||
const ajv = new Ajv({ allErrors: true });
|
||||
const validate = ajv.compile(schema);
|
||||
expect(validate({ skipSecrets: "yes" })).toBe(false);
|
||||
});
|
||||
|
||||
test("includes codebases array schema with item properties", () => {
|
||||
expect(schema.properties.codebases.type).toBe("array");
|
||||
expect(schema.properties.codebases.items.properties.relative_path).toBeDefined();
|
||||
expect(schema.properties.codebases.items.required).toContain("relative_path");
|
||||
});
|
||||
|
||||
test("includes gitBranches with branch config schema", () => {
|
||||
const branchSchema = schema.properties.gitBranches.additionalProperties;
|
||||
expect(branchSchema.properties.baseUrl).toBeDefined();
|
||||
expect(branchSchema.properties.workspaceId).toBeDefined();
|
||||
expect(branchSchema.properties.specificItems).toBeDefined();
|
||||
expect(branchSchema.properties.specificItems.properties.variables).toBeDefined();
|
||||
});
|
||||
|
||||
test("includes environments as alias for gitBranches", () => {
|
||||
expect(schema.properties.environments).toBeDefined();
|
||||
expect(schema.properties.environments.additionalProperties).toEqual(
|
||||
schema.properties.gitBranches.additionalProperties
|
||||
);
|
||||
});
|
||||
|
||||
test("does not contain template-only keys in schema output", () => {
|
||||
const templateKeys = ["section", "sectionNote", "commented", "templateValue", "example", "inlineComment", "groupNote"];
|
||||
const json = JSON.stringify(schema);
|
||||
for (const key of templateKeys) {
|
||||
expect(json).not.toContain(`"${key}"`);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// =============================================================================
|
||||
// formatConfigReference
|
||||
// =============================================================================
|
||||
|
||||
describe("formatConfigReference", () => {
|
||||
const output = formatConfigReference();
|
||||
|
||||
test("includes header row", () => {
|
||||
expect(output).toContain("OPTION");
|
||||
expect(output).toContain("DESCRIPTION");
|
||||
expect(output).toContain("DEFAULT");
|
||||
});
|
||||
|
||||
test("includes all top-level CONFIG_REFERENCE entries", () => {
|
||||
for (const opt of CONFIG_REFERENCE) {
|
||||
expect(output).toContain(opt.name);
|
||||
}
|
||||
});
|
||||
|
||||
test("auto-expands codebases sub-fields", () => {
|
||||
expect(output).toContain("codebases[].relative_path");
|
||||
expect(output).toContain("codebases[].format");
|
||||
expect(output).toContain("codebases[].external");
|
||||
});
|
||||
|
||||
test("auto-expands gitBranches sub-fields", () => {
|
||||
expect(output).toContain("gitBranches.<branch>.baseUrl");
|
||||
expect(output).toContain("gitBranches.<branch>.workspaceId");
|
||||
expect(output).toContain("gitBranches.<branch>.specificItems.variables");
|
||||
});
|
||||
|
||||
test("auto-expands commonSpecificItems sub-fields", () => {
|
||||
expect(output).toContain("gitBranches.commonSpecificItems.variables");
|
||||
expect(output).toContain("gitBranches.commonSpecificItems.settings");
|
||||
});
|
||||
});
|
||||
|
||||
// =============================================================================
|
||||
// formatConfigReferenceJson
|
||||
// =============================================================================
|
||||
|
||||
describe("formatConfigReferenceJson", () => {
|
||||
test("produces valid JSON", () => {
|
||||
const parsed = JSON.parse(formatConfigReferenceJson());
|
||||
expect(Array.isArray(parsed)).toBe(true);
|
||||
expect(parsed.length).toBe(CONFIG_REFERENCE.length);
|
||||
});
|
||||
|
||||
test("each entry has name, type, default, description", () => {
|
||||
const parsed = JSON.parse(formatConfigReferenceJson());
|
||||
for (const entry of parsed) {
|
||||
expect(entry).toHaveProperty("name");
|
||||
expect(entry).toHaveProperty("type");
|
||||
expect(entry).toHaveProperty("default");
|
||||
expect(entry).toHaveProperty("description");
|
||||
}
|
||||
});
|
||||
|
||||
test("does not contain template-only keys", () => {
|
||||
const parsed = JSON.parse(formatConfigReferenceJson());
|
||||
const templateKeys = ["section", "sectionNote", "commented", "templateValue", "example", "inlineComment", "groupNote"];
|
||||
for (const entry of parsed) {
|
||||
for (const key of templateKeys) {
|
||||
expect(entry).not.toHaveProperty(key);
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// =============================================================================
|
||||
// CONFIG_REFERENCE integrity
|
||||
// =============================================================================
|
||||
|
||||
describe("CONFIG_REFERENCE integrity", () => {
|
||||
test("all entries have required fields", () => {
|
||||
for (const opt of CONFIG_REFERENCE) {
|
||||
expect(opt.name).toBeTruthy();
|
||||
expect(opt.type).toBeTruthy();
|
||||
expect(opt.description).toBeTruthy();
|
||||
expect(opt.default).toBeDefined();
|
||||
}
|
||||
});
|
||||
|
||||
test("no duplicate names", () => {
|
||||
const names = CONFIG_REFERENCE.map((o) => o.name);
|
||||
expect(new Set(names).size).toBe(names.length);
|
||||
});
|
||||
|
||||
test("type field uses valid JSON Schema types", () => {
|
||||
const validTypes = new Set(["boolean", "string", "integer", "number", "array", "object"]);
|
||||
for (const opt of CONFIG_REFERENCE) {
|
||||
expect(validTypes.has(opt.type)).toBe(true);
|
||||
}
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user