@league-of-foundry-developers/foundry-vtt-types 13.345.1-beta.20250704.94554 → 13.345.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +32 -4
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -23,7 +23,7 @@ AI cannot be provided the source of Foundry VTT Types. This is because Foundry V
23
23
 
24
24
  ## V13 Installation
25
25
 
26
- Currently v13 is still in beta. There are known bugs, issues in the ergonomics, and unfinished work in the current implementation. To get a direct line of communication about the current status of development as well as to help us understand what areas need to be prioritized first, join the [League of Extraordinary FoundryVTT Developers Discord](https://discord.gg/73HTMuK7dT) or file an issue.
26
+ Currently v13 is still in beta. There are known bugs, issues in the ergonomics, and major unfinished work in the current implementation. To get a direct line of communication about the current status of development as well as to help us understand what areas need to be prioritized first, join the [League of Extraordinary FoundryVTT Developers Discord](https://discord.gg/73HTMuK7dT) or file an issue.
27
27
 
28
28
  The recommended way to install for v13 is this command:
29
29
 
@@ -31,15 +31,15 @@ The recommended way to install for v13 is this command:
31
31
  npm add -D fvtt-types@github:League-of-Foundry-Developers/foundry-vtt-types#main
32
32
  ```
33
33
 
34
- The command for other package managers is similar, for example with yarn you'll need to use the command `yarn add --dev fvtt-types@github:League-of-Foundry-Developers/foundry-vtt-types#main`.
34
+ Alternatively, if you're using yarn you'll need to use the command `yarn add --dev fvtt-types@github:League-of-Foundry-Developers/foundry-vtt-types#main`.
35
35
 
36
- This will add the current commit on `main` as a dependency. Every popular package manager has a lockfile which will store the commit you initially installed this command and so updates to your dependency will not happen automatically or even after a fresh install. To update you will need to be rerun the prior command periodically to update as improvements are added frequently.
36
+ This will add the current commit on `main` as a dependency. Both npm and yarn's lockfile will store the commit you initially installed this command and so updates to your dependency will not happen automatically or even after a fresh install. To update you will need to be rerun the prior command periodically to update as improvements are added frequently.
37
37
 
38
38
  ## Installation
39
39
 
40
40
  You can install historical versions of foundry-vtt-types from the [npm registry](https://npmjs.org/).
41
41
 
42
- In order to install the latest stable version, run
42
+ In order to install the latest stable version (v9), run
43
43
 
44
44
  ```sh
45
45
  npm add --save-dev fvtt-types@npm:@league-of-foundry-developers/foundry-vtt-types
@@ -126,6 +126,34 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for more details on how to contri
126
126
  If you have any specific questions, feel free to contact us in the
127
127
  [League of Extraordinary Foundry Developers Discord](https://discord.gg/52DNPzqm2Z).
128
128
 
129
+ ## Type-Checking, Linting, Testing
130
+
131
+ When contributing, make sure that the type checks pass, the linter is green and the tests are green. We _do_ have
132
+ checks in the CI but running this locally also helps you while developing and saves you time as you don't have to wait
133
+ for the CI.
134
+
135
+ You can run type checking and linting with the following command:
136
+
137
+ ```shell
138
+ npm run lint
139
+ ```
140
+
141
+ You can run the tests with
142
+
143
+ ```shell
144
+ npm run test
145
+ ```
146
+
147
+ ## Creating a release
148
+
149
+ To create a release, you have to create a new release commit, tag it and create a GitHub release from that. The CI will
150
+ handle the rest.
151
+
152
+ ```shell
153
+ npm version <release-type>
154
+ git push --follow-tags
155
+ ```
156
+
129
157
  ## License
130
158
 
131
159
  This project is licensed under the MIT license. You can find a copy at [LICENSE](LICENSE).
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package.json",
3
3
  "name": "@league-of-foundry-developers/foundry-vtt-types",
4
- "version": "13.345.1-beta.20250704.94554",
4
+ "version": "13.345.1",
5
5
  "description": "TypeScript type definitions for Foundry VTT",
6
6
  "type": "module",
7
7
  "types": "./src/index.d.mts",