hatch-nodejs-version 0.2.1

Hatch plugin for versioning from a package.json file

hatch-nodejs-version

---

This provides a version source plugin for Hatch that reads/writes the package version from the version field of the NodeJS package.json file.

Table of Contents

• Installation
• Global dependency]
• Version source
• Metadata hook
• License

Global dependency

Ensure hatch-nodejs-version is defined within the build-system.requires field in your pyproject.toml file.

[build-system]
requires = ["hatchling", "hatch-nodejs-version"]
build-backend = "hatchling.build"

Version source

The version source plugin name is nodejs.

• pyproject.toml

  [tool.hatch.version]
  source = "nodejs"
  

• hatch.toml

  [version]
  source = "nodejs"
  

Semver

The semver specification defines the following version sections:

• major
• minor
• patch
• pre-release
• build

Meanwhile, PEP 440 defines:

• epoch
• major
• minor
• patch
• pre-release
• post-release
• dev-release

In order to ensure round-trip support, and ensure semantic consistency between NodeJS and Python, this plugin only accepts the common version parts:

• major
• minor
• patch
• pre-release

e.g. 1.2.3-rc0.

Version source options

Option	Type	Default	Description
path	str	package.json	Relative path to the package.json file.

Metadata hook

The metadata hook plugin name is nodejs.

• pyproject.toml

  [tool.hatch.metadata.hooks.nodejs]
  

• hatch.toml

  [metadata.hooks.nodejs]
  

Metadata hook options

Option	Type	Default	Description
fields	list of str	None	Optional list of fields to take from the generated metadata object.

License

hatch-nodejs-version is distributed under the terms of the MIT license.