Repository navigation
refactor: arrange the modules in layer subpackages - #42
Merged
Merged
Conversation
The package is split into subpackages by data flow, each importing only the layers below it: - nnnotes.core: JSON text and the process caches - nnnotes.source: settings, the APK, catalogs and bundles, the game API and master data - nnnotes.formats: CRI audio, movies and lip sync, shaders, motions - nnnotes.unity: bundle reading (nnnotes.unity.reader), the typetree exporter, the player data and the TextMeshPro fonts - nnnotes.content: stories, lives, scores, spots, rooms and UI - nnnotes.pipeline: stages, tasks, the store, layouts and the atoms - nnnotes.site and nnnotes.musicdata: the ournotes-player site and the music-data builds - nnnotes.cli: the command line nnnotes.cli and nnnotes.musicdata keep their import paths. Package data moves with the modules that read it. An import-linter layers contract in pyproject.toml checks the direction, and CI runs it with the lint. The live-audio document's `spec` names nnnotes.content.liveaudio. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
tests/<layer>/ holds the tests of the matching nnnotes subpackage, and tests/helpers/ the synthetic data builders (synth, fakeunity). The test directories are packages, so a test module reuses another's fixtures through its full name (tests.pipeline.test_stages), and the golden records name their providers that way. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
The package is split into subpackages by data flow. Each subpackage
imports only the layers below it:
nnnotes.corennnotes.sourcennnotes.formatsnnnotes.unitynnnotes.unity.reader), the typetree exporter, the player data, TextMeshPro fontsnnnotes.contentnnnotes.pipelinennnotes.site,nnnotes.musicdatannnotes.clinnnotes.cliandnnnotes.musicdatakeep their import paths, andthe
nnnotescommand is unchanged.pyproject.tomlchecks theimport direction, and CI runs
lint-importswith the lint.tests/<layer>/holds the tests of each subpackage.tests/helpers/holds the synthetic data builders.
specnamesnnnotes.content.liveaudio.