Skip to content

Rewrite CodeceptJS skills: bullets over prose, doc-verified content, cross-references - #3

Merged
DavertMik merged 2 commits into
mainfrom
rewrite-skills-bullets
Aug 23, 2026
Merged

Rewrite CodeceptJS skills: bullets over prose, doc-verified content, cross-references#3
DavertMik merged 2 commits into
mainfrom
rewrite-skills-bullets

Conversation

@DavertMik

Copy link
Copy Markdown
Contributor

Summary

Rewrite of all 13 skills under plugins/codeceptjs/skills/ following three principles:

  • Bullets over prose — workflows compressed to numbered steps, structured sections instead of long paragraphs
  • Keep only what a model would get wrong — non-obvious rules and traps stay; CLI flags, API catalogs, and doc paths that are discoverable via --help, codeceptjs list, or node_modules/codeceptjs/docs/ are cut
  • Cross-references between skills — each skill names which to run first and which to hand off to, matching exact section names (codeceptjs-fundamentals § Effects, § Plugins from CLI)

Per-skill changes

Skill Change
codeceptjs-fundamentals Restructured into Gate / Main rule / Where things go / Shortcuts / Architecture / Config mutation trap / Plugins / Effects / Element-based API / Assertions. Content verified against current codecept.io docs: setCommonPlugins() bundle (enables retryFailedStep + screenshot; registers pause, browser, aiTrace, heal), lazy-proxy DI rationale, ARIA-first locator priority, effects API (tryTo/retryTo/hopeThat/within), codeceptjs/els, assertion preference ladder (custom helper → ExpectHelper → codeceptjs/assertions → external), soft assertions via hopeThat.noErrors(). Low-level access in Scenarios softened to a recommendation
writing-codeceptjs-tests 218 → 106 lines. Workflow to numbered steps; kept dry-run-skips-plugins warning, aiTrace MCP-vs-CLI asymmetry, I.see context requirement, step.opts disambiguation
debugging-codeceptjs-tests 234 → 130 lines. Cut 25-row tool-selection table (duplicated workflow); collapsed repeated pause() explanations into Paths section; condensed codeceptq to essentials
refactoring-codeceptjs-tests Compressed; decision tree kept intact; aligned with fundamentals' "Where things go" vocabulary
codeceptjs-auth Fixed typos ("nto", "includded", "accross", "sessision"); merged Verify/Refactor sections; kept ask-first questions and config shapes
codeceptjs-run-analysis / codeceptjs-exploration / ci-fix-tests Bullet compression, trimmed pointers, cross-refs
4 framework migrations + migrate-codeceptjs-4 Surgical: translation tables and hard rules untouched; duplicated doc-path Pointer lists (~15 bullets each) replaced with Related skills + one docs line; identical batch-run prose compressed to bullets

Net: −223 lines across the set.

Test plan

  • No Pointers sections remain (grep -c Pointers clean)
  • Spot-read fundamentals against codecept.io/basics, /pageobjects, /effects, /assertions, /element-based-testing
  • Confirm cross-referenced section names exist in target skills

DavertMik added 2 commits August 23, 2026 13:51
…cross-references

- fundamentals: restructure into Gate / Main rule / Where things go /
  Shortcuts / Architecture / Effects / Element-based API / Assertions;
  verify setCommonPlugins bundle, lazy-proxy DI rationale, ARIA-first
  locators, effects API against current codecept.io docs; soften
  low-level-access wording to a recommendation
- writing/debugging/refactoring: compress workflows to numbered bullets,
  keep non-obvious traps (dry-run skips plugin init, aiTrace auto-on
  under MCP only, I.see needs context, step.opts), replace Pointers with
  Related skills cross-references
- auth: fix typos, merge Verify/Refactor sections
- run-analysis/exploration/ci-fix: bullet compression, trimmed pointers
- migrations: cut duplicated doc-path pointer lists, compress repeated
  batch-run prose to bullets; translation tables and hard rules unchanged
Each description now leads with when the agent should invoke the skill
plus compact trigger signals. Cut how-it-works summaries that duplicated
the skill body (worst offenders: migration skills carried their whole
workflow in the description).
@DavertMik
DavertMik force-pushed the rewrite-skills-bullets branch from 2db2e07 to 512b7e3 Compare August 23, 2026 10:52
@DavertMik
DavertMik merged commit d3d6a4e into main Aug 23, 2026
@DavertMik
DavertMik deleted the rewrite-skills-bullets branch August 23, 2026 12:05
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