File tree Expand file tree Collapse file tree 1 file changed +31
-3
lines changed Expand file tree Collapse file tree 1 file changed +31
-3
lines changed Original file line number Diff line number Diff line change 10
10
- [ Installation] ( #installation )
11
11
- [ License] ( #license )
12
12
13
- ## Installation
13
+ ## Global dependency
14
14
15
- ``` console
16
- pip install hatch-nodejs-version
15
+ Ensure ` hatch-nodejs-version ` is defined within the ` build-system.requires ` field in your ` pyproject.toml ` file.
16
+
17
+ ``` toml
18
+ [build-system ]
19
+ requires = [" hatchling" , " hatch-nodejs-version" ]
20
+ build-backend = " hatchling.build"
17
21
```
18
22
23
+ ## Version source
24
+
25
+ The [ version source plugin] ( https://hatch.pypa.io/latest/plugins/version-source/ ) name is ` nodejs ` .
26
+
27
+ - *** pyproject.toml***
28
+
29
+ ``` toml
30
+ [tool .hatch .version ]
31
+ source = " nodejs"
32
+ ```
33
+
34
+ - ***hatch.toml***
35
+
36
+ ```toml
37
+ [version ]
38
+ source = " nodejs"
39
+ ```
40
+
41
+ # ## Version source options
42
+
43
+ | Option | Type | Default | Description |
44
+ |---------------| --- |---------------|--------------------------------------------|
45
+ | `path` | `str` | `package.json` | Relative path to the `package.json` file. |
46
+
19
47
# # License
20
48
21
49
`hatch-nodejs-version` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
You can’t perform that action at this time.
0 commit comments