PeerTube/support/doc/development/lib.md

# Lib development documentation

## @peertube/embed-api

### Build & Publish

```
$ cd client/src/standalone/player/
$ npm run build
$ npm publish --access=public
```

## @peertube/peertube-types

Typescript definition files generation is controlled by the various `tsconfig.types.json` files.

The complete types package is generated via:

```
$ npm run generate-types-package
$ cd types/dist
$ npm publish --access=public
```

> See [scripts/generate-types-package.ts](scripts/generate-types-package.ts) for details.
Add dev lib documentation 2021-09-07 04:47:40 -05:00			`# Lib development documentation`

			`## @peertube/embed-api`

Fix some build scripts and lint 2021-12-14 06:48:13 -06:00			`### Build & Publish`
Add dev lib documentation 2021-09-07 04:47:40 -05:00
			```
			`$ cd client/src/standalone/player/`
			`$ npm run build`
Fix some build scripts and lint 2021-12-14 06:48:13 -06:00			`$ npm publish --access=public`
Add dev lib documentation 2021-09-07 04:47:40 -05: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 06:49:08 -06:00
			`## @peertube/peertube-types`

Fix some build scripts and lint 2021-12-14 06:48:13 -06: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 06:49:08 -06:00
			```
Fix some build scripts and lint 2021-12-14 06:48:13 -06:00			`$ npm run generate-types-package`
Fix generate types package script 2021-12-16 10:17:16 -06:00			`$ cd types/dist`
Fix some build scripts and lint 2021-12-14 06:48:13 -06: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 06:49:08 -06:00			```
Fix some build scripts and lint 2021-12-14 06:48:13 -06: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 06:49:08 -06:00			`> See [scripts/generate-types-package.ts](scripts/generate-types-package.ts) for details.`