docs(readme): simplify going further snippet#180
Merged
Conversation
PR #178 squash-merged into 0.16.1 carried a stray README change from PR #177's branch — the Nuxt subsection in "Going further" got rewritten from `modules: ['attaform/nuxt']` to a manual `defineNuxtPlugin(... vueApp.use(createAttaform()))` snippet. PR #177 was closed unmerged on the basis that the manual-plugin pattern is wrong (the Nuxt module is the idiomatic install, exposes the `attaform` configKey, threads SSR payload, registers the Vite plugin, and auto-imports useForm — all of which the manual snippet loses), but that commit was somehow still on the branch when #178 was squash-merged. End result: 0.16.1 shipped to npm with the wrong README snippet. The expanded `docs/api/nuxt.md` from #178 is fine and stays; this is a README-only revert. Restores the snippet to: // nuxt.config.ts export default defineNuxtConfig({ modules: ['attaform/nuxt'], }) Needs a 0.16.2 publish to land on npm — the README in the published tarball is what consumers see on the package page. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
ozzyfromspace
changed the title
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
1 participant
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
0.16.1 on npm shipped with the wrong Nuxt install snippet in the README. PR #178 squash-merged a stray README change from PR #177's branch — the Nuxt subsection was rewritten from
modules: ['attaform/nuxt']to a manualdefineNuxtPlugin(... vueApp.use(createAttaform()))snippet. PR #177 was closed unmerged precisely because that pattern is wrong (the Nuxt module is the idiomatic install — it exposes theattaformconfigKey, threads the SSR payload, registers the Vite plugin, and auto-importsuseForm; the manual snippet loses all of that), but the commit was still on the docs-reference branch when it merged.Verified by inspecting the published tarball:
What changed
README-only revert. Restores the Nuxt section to:
The expanded
docs/api/nuxt.mdfrom #178 stays — it leads with the same module install and was the correct deliverable from that PR. Only the README needed to be backed out.Followup
This needs a 0.16.2 publish to land on npm — the README in the published tarball is what shows up on the npmjs.com package page. After merge,
Publish to NPM and Version Bumpworkflow withversion_type=patchwill cut it.Test plan
git diff --statshows1 file changed, 4 insertions(+), 6 deletions(-))npm pack attaform@0.16.2 && grep -A 6 "Nuxt 3 / 4" package/README.mdshowsmodules: ['attaform/nuxt']🤖 Generated with Claude Code