docs: clarify local plugin test commands#1706
Open
anhtnt90dev wants to merge 1 commit into
Open
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.
Who is submitting this PR? (required)
What problem are you trying to solve?
While checking the plugin test surface from
docs/testing.md, the current guidance only said to use the relevant directory'srun-*.shornpm test.That left two concrete traps in my local contributor session:
npm testintests/brainstorm-serverbefore installing that test suite's dependency failed withError: Cannot find module 'ws'fromtests/brainstorm-server/server.test.js.tests/brainstorm-server/windows-lifecycle.test.shwith a 120-second command timeout produced a false timeout. The test intentionally sleeps past the 60-second lifecycle check window twice, so it needs more than 150 seconds on Windows/Git Bash.This PR documents the exact commands and time expectation that made those tests pass.
What does this PR change?
Adds a small "Fast local checks" section to
docs/testing.mdwith the verified commands for the brainstorm server JS tests, shell lint wrapper tests, and Windows lifecycle test. It also documents the Git Bash invocation from PowerShell for Windows contributors.Is this change appropriate for the core library?
Yes. This is contributor documentation for the core repository's existing test suites. It is not project-specific, team-specific, or a third-party integration.
What alternatives did you consider?
I considered adding a new root-level test runner, but that would be a larger tooling change and could overlap with existing test organization. I also considered changing the Windows lifecycle test timeout behavior, but the test's runtime is intentional because it verifies behavior past lifecycle check windows. A docs-only clarification addresses the actual contributor failure mode with less risk.
Does this PR contain multiple unrelated changes?
No. It only updates
docs/testing.mdto clarify local plugin test commands.Existing PRs
#1703 and #1677 touch adjacent test/tooling areas but do not document these local commands. #1592 and #1655 are prior Windows brainstorm lifecycle fixes; this PR only documents how to run the existing test reliably.
Environment tested
Authoring environment disclosure: generated with GPT-5 in Codex CLI 0.137.0. Installed Codex plugins available in the session: Browser, Documents, Presentations, Sites, Spreadsheets, Superpowers.
New harness support (required if this PR adds a new harness)
Not applicable. This PR does not add a new harness.
Clean-session transcript for "Let's make a react todo list"
Evaluation
npm testguidance intests/brainstorm-serverwithoutnpm cifailed withCannot find module 'ws'; running the Windows lifecycle test with a 120-second timeout timed out even though the test is designed to run longer.Verification run after the change:
Rigor
superpowers:writing-skillsand completed adversarial pressure testing (paste results below)This is not a skills change. No skill text, prompts, red flags, rationalization lists, or behavior-shaping content were modified.
Human review