Hatch plugin for versioning from a package.json file
Project description
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
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hatch_nodejs_version-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19f7486eef996e0541ff08cdfaa0fdb5a995d7f276ef11d86c9284755746bf8b |
|
MD5 | b0ed415a91d7e5b335d60a2c82ad11a8 |
|
BLAKE2b-256 | 5ef4402737ed7b1637b0ebb3fd4305b59fd4dedfed61597d1f4f5c7f90ce2347 |
Hashes for hatch_nodejs_version-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89852224b6d083bbfb40efcd55235763142042fd3ac1f03457b45b727c54865f |
|
MD5 | b9313dbd955822d8175d41d59569249f |
|
BLAKE2b-256 | b17e1bbb2eba33169797a8d7bb7d2ddeb151526369d8f9d61bf3ceb0e8d634b6 |