docs(nodejs): steer agents to the right module system in code snippets#18
Open
mmanciop wants to merge 1 commit into
Open
docs(nodejs): steer agents to the right module system in code snippets#18mmanciop wants to merge 1 commit into
mmanciop wants to merge 1 commit into
Conversation
Node.js snippets across the otel-instrumentation skill mixed `import` and `require` without telling agents how to pick between them. An agent copying snippets into a project could produce `SyntaxError: Cannot use import statement outside a module` (ESM syntax in a CJS file) or the reverse. - Add a "Module system in code snippets" subsection to nodejs.md with detection rules (file extension, package.json `"type"`, surrounding code), an explicit ESM default for the file's snippets, and a translation table. - Normalize the `pg` `requestHook` snippet in nodejs.md to `import` so the file is internally consistent. - Switch the Node.js intro snippet in SKILL.md from `require` to `import` to match the ESM default. Co-Authored-By: Claude Opus 4.7 (1M context) <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.
Summary
Node.js snippets across the
otel-instrumentationskill mixedimportandrequirewithout telling agents how to pick between them. An agent copying snippets into a project could produceSyntaxError: Cannot use import statement outside a module(ESM syntax in a CJS file) orReferenceError: require is not defined in ES module scope(the reverse).rules/sdks/nodejs.mdwith:package.json"type", surrounding code style, new-file default)importimport↔require, default/named/namespace forms, andexport↔module.exportsimportregardless of emit targetpgrequestHooksnippet innodejs.mdfromrequiretoimportso all snippets in the file share one style.SKILL.mdfromrequiretoimportto match the ESM default.Test plan
rules/sdks/nodejs.mdend-to-end and confirm no code snippet usesrequire(outside the translation table.SKILL.mdintro snippet usesimport..mjs/.cjsextensions,package.json"type", existing surrounding syntax, and new-file default.🤖 Generated with Claude Code