Skip to content

feat: scope the package as @webship/diffy-steps at 2.0.0 (#1) - #2

Merged
Natshah merged 1 commit into
2.0.xfrom
1-scope-package-name
Aug 1, 2026
Merged

feat: scope the package as @webship/diffy-steps at 2.0.0 (#1)#2
Natshah merged 1 commit into
2.0.xfrom
1-scope-package-name

Conversation

@Natshah

@Natshah Natshah commented Aug 1, 2026

Copy link
Copy Markdown
Member

Scopes the package and moves it onto the 2.0.x line.

- "name": "diffy-steps",
- "version": "0.1.0",
+ "name": "@webship/diffy-steps",
+ "version": "2.0.0",

Closes #1

Why 2.0.0

The plugin peers against webship-js ^2.0.4, its branch is 2.0.x, and its step
phrasings are the 2.0.x phrasings extracted from webship-js. 0.1.0 implied a
pre-release with no compatibility promise and put the plugin on a version track
unrelated to the harness it plugs into.

One addition beyond the rename

"publishConfig": { "access": "public" }

Scoped packages publish as restricted by default. Without this, npm publish
would either fail or publish privately — contradicting the now-public
repository. Flagging it because it was not in the request but the rename is
incomplete without it.

Everything that follows the name

File Updated
README.md heading, prose, install command, require: path
docs/README.md heading, intro
tests/step-definitions/README.md install, require: path, cp snippet, uninstall snippet
tests/step-definitions/diffy.steps.js header comment
package-lock.json regenerated

The consumer require: path becomes:

'node_modules/@webship/diffy-steps/tests/step-definitions/**/*.js'

GitHub URLs (github.com/webship/diffy-steps) and the directory name are
unchanged — only the npm package identity moved.

Before publishing — two prerequisites outside this repo

  • The webship org must exist on npmjs.com. https://registry.npmjs.org/-/org/webship returns 404 today, and npm publish will fail on a scope with no org behind it.
  • The publishing account must be a member of that org with publish rights.

Still unpublished, as intended.

Test notes

  • npm pack --dry-run@webship/diffy-steps@2.0.0, filename webship-diffy-steps-2.0.0.tgz, same 5-file payload.
  • package.json re-parsed through Node after editing — valid, key order preserved, non-ASCII intact.
  • Suite re-run after the change: 6 scenarios / 37 steps passing against the mock Diffy API.

One knock-on outside this repository: webship-js PR
#303 documents the unscoped
node_modules/diffy-steps/... path. It needs the scoped path before it merges —
handled separately so this PR stays single-purpose.

AI-Generated: Yes (applied the rename and version bump and updated every
reference; reviewed by Rajab Natshah.)

Checkpoints

  • File an issue about this project
  • Addition/Change/Update/Fix to this project
  • Testing to ensure no regression
  • Automated unit/functional testing coverage
  • Developer Documentation support on feature change/addition
  • User Guide Documentation support on feature change/addition
  • Accessibility and Readability
  • Reviewed by a human
  • Code review by maintainers
  • Full testing and approval
  • Credit contributors
  • Review with the product owner
  • Update Release Notes
  • Release

  "name": "diffy-steps",     ->  "name": "@webship/diffy-steps",
  "version": "0.1.0",        ->  "version": "2.0.0",

The scope puts the package in the organisation's namespace instead of the
global one. The version aligns the plugin with the line it plugs into:
it peers against webship-js ^2.0.4, its branch is 2.0.x, and its step
phrasings are the 2.0.x phrasings extracted from webship-js. 0.1.0
implied a pre-release on an unrelated track.

Scoped packages publish as `restricted` by default, which would
contradict the public repository, so publishConfig.access is set to
public.

Every reference to the package name follows: the install commands, the
node_modules/@webship/diffy-steps/... require paths in the configuration
examples, the copy and uninstall snippets, the doc headings, and the
step-file header. package-lock.json regenerated.

Not published. The webship org does not yet exist on npmjs.com and the
publishing account needs membership in it before a first release.

Verified: npm pack --dry-run reports @webship/diffy-steps@2.0.0, and the
suite still passes 6 scenarios / 37 steps against the mock Diffy API.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@Natshah
Natshah merged commit 196fbd0 into 2.0.x Aug 1, 2026
1 check passed
@Natshah
Natshah deleted the 1-scope-package-name branch August 1, 2026 14:19
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.

Change the package name to @webship/diffy-steps and the version to 2.0.0

1 participant