Skip to content

Commit 2d72fb8

Browse files
committed
docs: update readme for new version info
1 parent 66f3a28 commit 2d72fb8

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,29 @@ The [version source plugin](https://hatch.pypa.io/latest/plugins/version-source/
4747
|---------------| --- |---------------|--------------------------------------------|
4848
| `path` | `str` | `package.json` | Relative path to the `package.json` file. |
4949

50+
51+
## Metadata hook
52+
53+
The [metadata hook plugin](https://hatch.pypa.io/dev/plugins/metadata-hook/reference/) name is `nodejs`.
54+
55+
- ***pyproject.toml***
56+
57+
```toml
58+
[tool.hatch.metadata.hooks.nodejs]
59+
```
60+
61+
- ***hatch.toml***
62+
63+
```toml
64+
[metadata.hooks.nodejs]
65+
```
66+
67+
### Version source options
68+
69+
| Option | Type | Default | Description |
70+
|----------|-----------------|---------|---------------------------------------------------------------------|
71+
| `fields` | `list` of `str` | None | Optional list of fields to take from the generated metadata object. |
72+
5073
## License
5174

5275
`hatch-nodejs-version` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

0 commit comments

Comments
 (0)