docs: new codeplain output layout — plain_modules/<module>/{code,tests} - #12
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
codeplain now writes everything it generates under the module directory:
plain_modules/<module>/plain_modules/<module>/code/conformance_tests/<module>/<spec>/plain_modules/<module>/tests/<spec>/Verified against the installed CLI rather than assumed —
codeplain --helpdocuments the unit-test script as receiving "the module's code folder path (e.g.plain_modules/module_name/code)" and the conformance script as receiving "plain_modules/module_name/code" plus "a subfolder of the module's tests folder (e.g.plain_modules/module_name/tests/subfoldername)".What changed
Rules —
impl-reqs(unit tests sit incode/),test-reqs(conformance tests live intests/, one folder per spec),requires-modules(the copied starting point is<required_module>/code),integration-embedded(+ directory tree),integration-embedded-testing(script arg contract and the***test reqs***example).References —
project-model.mdrepository tree,rendering-and-testing.mdread-only surface, script roles and invocation shapes.Skills —
load-codeplain-reference,debug-specs,run-codeplain,create-requires-module,forge-plain,init-config-file, and the threeimplement-*-scriptskills.Docs —
CLAUDE.md,AGENTS.md,README.md.Two things worth a second look
conformance-tests-folderremoved frominit-config-file. That option no longer exists in the installed CLI (--copy-conformance-testsnow reads from<build-folder>/<module>/tests), so documenting it would send users to a key the renderer rejects.conformance-tests-destsurvives and is reworded..memory/left at the module root.run-codeplaindocuments renderer memory atplain_modules/<module>/.memory/. I couldn't confirm whether that moved undercode/— no new-layout render was available to check against. Worth verifying on the next render.Untouched on purpose: the
assets/test scripts take their folders as arguments, so they're layout-agnostic, andrun_conformance_tests_<lang>remains the script filename everywhere.