OpenCloud
/
PeerTube
mirror of https://github.com/Chocobozzz/PeerTube
1
0
Fork 0
Code Issues Releases Wiki Activity
PeerTube/support/doc/development/lib.md

26 lines
542 B
Markdown
Raw Normal View History

Add dev lib documentation
2021-09-07 11:47:40 +02:00
# Lib development documentation
## @peertube/embed-api
Fix some build scripts and lint
2021-12-14 13:48:13 +01:00
### Build & Publish
Add dev lib documentation
2021-09-07 11:47:40 +02:00
```
Fix build
2023-07-10 16:41:08 +02:00
cd client/src/standalone/embed-player-api/
Remove $ for bash commands It prevents easy copy
2023-04-04 09:16:53 +02:00
npm run build
npm publish --access=public
Add dev lib documentation
2021-09-07 11:47:40 +02:00
```
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
2021-11-09 13:49:08 +01:00
## @peertube/peertube-types
Fix some build scripts and lint
2021-12-14 13:48:13 +01:00
Typescript definition files generation is controlled by the various `tsconfig.types.json` files.
The complete types package is generated via:
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
2021-11-09 13:49:08 +01:00
```
Remove $ for bash commands It prevents easy copy
2023-04-04 09:16:53 +02:00
npm run generate-types-package 4.x.x
Migrate server to ESM Sorry for the very big commit that may lead to git log issues and merge conflicts, but it's a major step forward: * Server can be faster at startup because imports() are async and we can easily lazy import big modules * Angular doesn't seem to support ES import (with .js extension), so we had to correctly organize peertube into a monorepo: * Use yarn workspace feature * Use typescript reference projects for dependencies * Shared projects have been moved into "packages", each one is now a node module (with a dedicated package.json/tsconfig.json) * server/tools have been moved into apps/ and is now a dedicated app bundled and published on NPM so users don't have to build peertube cli tools manually * server/tests have been moved into packages/ so we don't compile them every time we want to run the server * Use isolatedModule option: * Had to move from const enum to const (https://www.typescriptlang.org/docs/handbook/enums.html#objects-vs-enums) * Had to explictely specify "type" imports when used in decorators * Prefer tsx (that uses esbuild under the hood) instead of ts-node to load typescript files (tests with mocha or scripts): * To reduce test complexity as esbuild doesn't support decorator metadata, we only test server files that do not import server models * We still build tests files into js files for a faster CI * Remove unmaintained peertube CLI import script * Removed some barrels to speed up execution (less imports)
2023-07-31 14:34:36 +02:00
cd packages/types-generator/dist
Remove $ for bash commands It prevents easy copy
2023-04-04 09:16:53 +02:00
npm publish --access=public
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
2021-11-09 13:49:08 +01:00
```
Fix some build scripts and lint
2021-12-14 13:48:13 +01:00
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
2021-11-09 13:49:08 +01:00
> See [scripts/generate-types-package.ts](scripts/generate-types-package.ts) for details.