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.post1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | de8a548ac13a9283d5b8beaf82a5273c884c865b5d77e91f6452b2c918b3fa58 |
|
MD5 | 65150e0fca15bf1baa5aa0310adb8b48 |
|
BLAKE2b-256 | 3e487d129d0e62e0a9442c77157e9991ded6f3b694ef5a494038135253ecdca6 |
Hashes for hatch_nodejs_version-0.2.1.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff4b6f9e664594115ce0b82177a409c84d90edfdf1766720021428a6e1f8388e |
|
MD5 | 31b6ad875c32e95f864fbe59d07c7fe2 |
|
BLAKE2b-256 | b3f484bdc0771a722e61573e490f69e9dcb139b1b994fc7ca50b93b18c41c312 |