Add agent configurations and apply documentation and known issues fixes - #588
Merged
Conversation
|
Coverage report for commit: cd37924 Summary - Lines: 100.00% ⏹️ | Methods: 100.00% ⏹️ | Branches: 100.00% 🔼
🤖 comment via lucassabreu/comment-coverage-clover |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
…workflow Signed-off-by: James Robb <47126579+jamesrweb@users.noreply.github.com>
…o avoid lock file formatting issues Signed-off-by: James Robb <47126579+jamesrweb@users.noreply.github.com>
yevdyko
force-pushed
the
add-agents-files
branch
from
September 3, 2026 21:03
9a3a641 to
cd37924
Compare
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.
Related Issue
N / A
PR Type
Description
Updates the project dependencies (including a major pnpm 10 → 11 migration), adds agent configuration files (
AGENTS.mdplus aCLAUDE.mdsymlink), and fixes a published-package bug where the CommonJS entry could not berequire()d by Node consumers. The README is also corrected and extended with contribution guidelines, and the demo build's chunk size warning limit is raised to clear a false-positive warning.Proposed Changes
AGENTS.mddocumenting project standards for agents (quality gates, git safety, scope of operation, code philosophy, testing, PR description, and commit attribution rules following the Linux kernel team's AI coding assistant guidelines) and symlinkCLAUDE.mdto it.packageManagerfrom pnpm 10.33.0 to 11.25.0, bump the Node.js engine to>=24.20.0, update all dependencies to their latest versions, and regeneratepnpm-lock.yaml.overridesinpnpm-workspace.yamlwith pnpm 11'sminimumReleaseAgeStrictsupply-chain setting, keeping a minimalonlyBuiltDependenciesallowlist (esbuildonly).vite-plugin-dtsfrom v4 (rollupTypes) to v5 (bundleTypes).config/vite/library.tstomain.mjs/main.cjs— Vite 8's[format]placeholder renamedesmtoes, which stopped the build output from matching thepackage.jsonexportsmap.main.cjs.js/main.esm.jstomain.cjs/main.mjsand updatemain,module, andexportsinpackage.jsonin lockstep — because the package uses"type": "module", a.jsCJS entry is parsed as ESM, sorequire()threwexports is not defined in ES module scope(broken in the published 5.0.4).typescriptto the exact version6.0.3(typescript-eslint does not support the Go-based TypeScript 7 yet).chunkSizeWarningLimitfrom 1200 to 1250 to clear the warning triggered by the ~1203 kB p5 chunk.pnpm preview→pnpm dev, port 3001 → 5173, remove the outdated@types/p5setup (p5 ships its own types), and correct two "occured" typos.--signoff, optionalAssisted-by: LLMtrailer).How Has This Been Tested?
All 43 unit tests pass (2 pre-existing skips remain). Manual testing: the library was built, packed with
npm pack, and installed into a clean consumer project in/tmp—require('@p5-wrapper/react')andimport ... from '@p5-wrapper/react'both resolve and returnP5CanvasandCanvasContainerClassName; the tarball shipsmain.cjs,main.mjs, andmain.d.tsmatching theexportsmap.pnpm integrate(format check, lint, test, build) passes locally.Screenshots/Recordings
Breaking Changes
Checklist
Additional Notes
The published filenames change (
main.cjs.js→main.cjs,main.esm.js→main.mjs), but consumers import through thepackage.jsonexportsmap, which is updated in the same commit — deep imports ofdist/were never supported, so no supported usage breaks. This change actually repairsrequire()for Node CJS consumers, which has been broken since"type": "module"was introduced, so it is worth calling out in the release notes when the next version is published. The ViteconfigLoader: 'native'warning about__dirnameand extension-less imports inconfig/vite/vite.config.tsis pre-existing and documented inAGENTS.mdas a future task.