Skip to content

refactor: establish WebAudio folder feature - #329

Open
jderochervlk wants to merge 1 commit into
codex/option5-media-folderfrom
codex/option5-web-audio-folder
Open

refactor: establish WebAudio folder feature#329
jderochervlk wants to merge 1 commit into
codex/option5-media-folderfrom
codex/option5-web-audio-folder

Conversation

@jderochervlk

@jderochervlk jderochervlk commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator

Tracking issue: #342

Stack context

Part 19 of the Option 5 folder-feature stack.

Review this PR as the incremental diff against #328.

Summary

  • rename src/WebAudio to the target src/web-audio folder
  • switch the folder to the unqualified internal WebAudio feature
  • add the supported WebAPI.WebAudio -> WebAPI.Media + WebAPI.Messaging + WebAudio feature
  • preserve all existing flat WebAudio module paths and binding signatures

Dependency note

The Option 5 proposal listed only Media as a public dependency. The current bindings also expose MessagePort from AudioWorkletNode.port, so the compiler-proven closure additionally requires WebAPI.Messaging. This PR records the real public signature dependency at the domain level.

Temporary state

  • the legacy broad WebAPI.DOM source entry remains until its remaining interfaces have been assigned
  • final feature-graph guardrails and cleanup remain deferred until the stack is complete

Review focus

  • the lowercase folder/internal feature transition
  • the additional Messaging dependency
  • preservation of flat public module names

Verification

  • node_modules/.bin/rescript clean
  • node_modules/.bin/rescript build --prod --features DOM,Event,DOMPlatform,Animation,CSSOM,Geometry,DOMNodes,File,HTML,Media,Messaging,WebAudio
  • npm run build
  • npm test
  • npm run format:check
  • git diff --check

Copy link
Copy Markdown
Collaborator Author

@codex

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0d44e1a7b0

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread rescript.json
},
{
"dir": "src/WebAudio",
"dir": "src/web-audio",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep the WebAudio documentation source path in sync

When the API documentation routes are generated, docs/utils.js still derives this feature's path from featureSpecs, where dirName remains WebAudio; it therefore probes src/WebAudio/WebAudioTypes.res and filters the module out because that path no longer exists. As a result, this rename removes WebAudio and all of its child modules from the generated API documentation unless the documentation metadata is updated or made to use the configured source directory.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant