Skip to content

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

Description

@Natshah

Problem/Motivation

The package is currently declared as an unscoped diffy-steps at 0.1.0:

  "name": "diffy-steps",
  "version": "0.1.0",

Two problems with that.

The name is unscoped. diffy-steps sits in the global npm namespace with no
signal of who publishes it, and nothing reserves it for this organisation. The
package is a Webship product and should carry the @webship scope, matching how
the org's other JavaScript work is grouped.

The version does not match the line it belongs to. This plugin peers against
webship-js ^2.0.4, its repository branch is 2.0.x, and its step phrasings are
the 2.0.x phrasings extracted from webship-js. Shipping it as 0.1.0 implies a
pre-release with no compatibility promise, and leaves the plugin and the harness
it plugs into on unrelated version tracks.

Proposed resolution

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

and update every reference to the package name — the install commands, the
node_modules/... require paths in the configuration examples, the copy and
uninstall snippets, and the doc headings — to the scoped path
node_modules/@webship/diffy-steps/tests/step-definitions/**/*.js.

Scoped packages default to restricted on publish, so add:

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

Without it, npm publish on a scoped name either fails or publishes privately —
which would contradict the now-public repository.

Two prerequisites before the first publish, both outside this repository:

  • The webship org must exist on npmjs.comhttps://registry.npmjs.org/-/org/webship currently returns 404.
  • The publishing account must be a member of that org with publish rights.

The sibling *-steps packages remain unscoped for now; if the scope is adopted
as the standard they should follow in their own issues.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions