Repository navigation
Rename Codex to CDX (writer, code symbols, docs) - #47
Merged
Merged
Conversation
Tracks the upstream Codex -> CDX ("Content-addressed Document eXchange")
spec rename (spec PR merged). Makes cdx-pandoc fully consistent with the
new name.
Functional / on-the-wire changes:
- Manifest spec-version key "codex" -> "cdx" in emitted JSON
- MIME type application/vnd.codex+json -> application/vnd.cdx+json
- Extension IDs codex.{academic,semantic,...} -> cdx.<same>
Writer file rename:
- git mv codex.lua -> cdx.lua (the Pandoc custom writer); the invocation
is now `pandoc ... -t cdx.lua`. Updated all references in Makefile
(WRITER := cdx.lua), README/CONTRIBUTING usage examples, and
scripts/pandoc-to-cdx.sh (CODEX_WRITER -> CDX_WRITER and the writer
path string). Matches the existing cdx-reader.lua naming convention.
Code symbols & docs:
- Internal Lua identifiers (CODEX_VERSION -> CDX_VERSION, codex_field/
codex_name -> cdx_*, comments referencing "Codex") updated
- Brand in prose/docs/comments Codex -> CDX (README, CHANGELOG,
CONTRIBUTING, SECURITY, LICENSE copyright lines)
- Golden baselines under tests/expected/ updated to the new key/MIME/
extension IDs so golden + round-trip tests pass
Preserved: the upstream spec repo path token codex-file-format-spec.
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.
Tracks the upstream Codex → CDX ("Content-addressed Document eXchange") spec rename (spec PR merged). Makes
cdx-pandocfully consistent with the new name.Functional / on-the-wire identifiers
"codex"→"cdx"in emitted JSON.application/vnd.codex+json→application/vnd.cdx+json.codex.{academic,semantic,...}→cdx.<same>(e.g.cdx.academic,cdx.semantic).Writer file rename
git mv codex.lua → cdx.lua(the Pandoc custom writer). The invocation changes:pandoc ... -t codex.luais nowpandoc ... -t cdx.lua.Makefile(WRITER := cdx.lua,.manifest.cdx), README/CONTRIBUTING usage examples, andscripts/pandoc-to-cdx.sh(CODEX_WRITER→CDX_WRITERplus the writer path string).cdx-reader.luanaming convention.Code symbols
CODEX_VERSION→CDX_VERSION,codex_field/codex_name→cdx_*, andcodex-referencing comments throughoutlib/.Docs / prose
Codex→CDXin README, CHANGELOG, CONTRIBUTING, SECURITY, and the LICENSE copyright holder lines ("CDX Document Format Contributors").Tests
tests/expected/updated to the new key / MIME / extension IDs so golden and round-trip tests pass.Preserved
codex-file-format-specis intentionally left unchanged (it is still named that). A re-grep confirms it is the only remainingcodextoken in the tree.Verification (local, macOS)
Installed
pandoc 3.10,lua 5.4.8,luacheck 1.2.0,jq 1.7.1and ran:make lint— 0 warnings / 0 errorsmake test— all unit suites + JSON output passmake test-golden— all golden tests passmake test-reader— all round-trip tests OKmake validate— structure OKmake test-all— passes (exit 0)make test-cdx— full.cdxpackaging pipeline OK; generatedmanifest.jsoncontains"cdx": "0.1"