diff options
author | Chocobozzz <me@florianbigard.com> | 2023-07-31 14:34:36 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2023-08-11 15:02:33 +0200 |
commit | 3a4992633ee62d5edfbb484d9c6bcb3cf158489d (patch) | |
tree | e4510b39bdac9c318fdb4b47018d08f15368b8f0 /server/scripts/plugin/install.ts | |
parent | 04d1da5621d25d59bd5fa1543b725c497bf5d9a8 (diff) | |
download | PeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.tar.gz PeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.tar.zst PeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.zip |
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)
Diffstat (limited to 'server/scripts/plugin/install.ts')
-rwxr-xr-x | server/scripts/plugin/install.ts | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/server/scripts/plugin/install.ts b/server/scripts/plugin/install.ts new file mode 100755 index 000000000..3b13120ff --- /dev/null +++ b/server/scripts/plugin/install.ts | |||
@@ -0,0 +1,41 @@ | |||
1 | import { program } from 'commander' | ||
2 | import { isAbsolute } from 'path' | ||
3 | import { initDatabaseModels } from '../../server/initializers/database.js' | ||
4 | import { PluginManager } from '../../server/lib/plugins/plugin-manager.js' | ||
5 | |||
6 | program | ||
7 | .option('-n, --npm-name [npmName]', 'Plugin to install') | ||
8 | .option('-v, --plugin-version [pluginVersion]', 'Plugin version to install') | ||
9 | .option('-p, --plugin-path [pluginPath]', 'Path of the plugin you want to install') | ||
10 | .parse(process.argv) | ||
11 | |||
12 | const options = program.opts() | ||
13 | |||
14 | if (!options.npmName && !options.pluginPath) { | ||
15 | console.error('You need to specify a plugin name with the desired version, or a plugin path.') | ||
16 | process.exit(-1) | ||
17 | } | ||
18 | |||
19 | if (options.pluginPath && !isAbsolute(options.pluginPath)) { | ||
20 | console.error('Plugin path should be absolute.') | ||
21 | process.exit(-1) | ||
22 | } | ||
23 | |||
24 | run() | ||
25 | .then(() => process.exit(0)) | ||
26 | .catch(err => { | ||
27 | console.error(err) | ||
28 | process.exit(-1) | ||
29 | }) | ||
30 | |||
31 | async function run () { | ||
32 | await initDatabaseModels(true) | ||
33 | |||
34 | const toInstall = options.npmName || options.pluginPath | ||
35 | await PluginManager.Instance.install({ | ||
36 | toInstall, | ||
37 | version: options.pluginVersion, | ||
38 | fromDisk: !!options.pluginPath, | ||
39 | register: false | ||
40 | }) | ||
41 | } | ||