diff options
author | lutangar <johan.dufour@gmail.com> | 2021-11-09 13:49:08 +0100 |
---|---|---|
committer | Chocobozzz <chocobozzz@cpy.re> | 2021-12-16 10:08:43 +0100 |
commit | 8b03e2ce1a2098261de2f729f660b1ae2a320b65 (patch) | |
tree | ca4770cf86c9c54814dbb62bfc95ef38661646b2 /support/doc/development/lib.md | |
parent | 06aad80165d09a8863ab8103149a8ff518b10641 (diff) | |
download | PeerTube-8b03e2ce1a2098261de2f729f660b1ae2a320b65.tar.gz PeerTube-8b03e2ce1a2098261de2f729f660b1ae2a320b65.tar.zst PeerTube-8b03e2ce1a2098261de2f729f660b1ae2a320b65.zip |
feat(types): create peertube-types package
Create dedicated Typescript "types" configuration file for each "projects".
Create a types folder which includes every useful ts definition:
- client
- server
- shared
Add tooling to create a proper package, extract dependencies, etc...
Add CI Github task.
refactor(types): publish types package in release script
Diffstat (limited to 'support/doc/development/lib.md')
-rw-r--r-- | support/doc/development/lib.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/support/doc/development/lib.md b/support/doc/development/lib.md index 6b0372150..9c67a39dd 100644 --- a/support/doc/development/lib.md +++ b/support/doc/development/lib.md | |||
@@ -8,3 +8,16 @@ | |||
8 | $ cd client/src/standalone/player/ | 8 | $ cd client/src/standalone/player/ |
9 | $ npm run build | 9 | $ npm run build |
10 | ``` | 10 | ``` |
11 | |||
12 | ## @peertube/peertube-types | ||
13 | |||
14 | Typescript definition files generation is controlled by the various `tsconfig.types.json` files, see: | ||
15 | ``` | ||
16 | yarn tsc -b --verbose tsconfig.types.json | ||
17 | ``` | ||
18 | |||
19 | But the complete types package is generated via: | ||
20 | ``` | ||
21 | yarn generate-types-package | ||
22 | ``` | ||
23 | > See [scripts/generate-types-package.ts](scripts/generate-types-package.ts) for details. | ||