@shiqianjiang/ceru-plugin-cli 0.2.3 → 0.2.4
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.
- package/README.md +2 -0
- package/dist/dev.js +23 -6
- package/dist/index.js +1 -1
- package/dist/project.d.ts +2 -0
- package/dist/project.js +123 -5
- package/package.json +4 -4
- package/schemas/config.schema.json +19 -1
- package/templates/connected-library/js/package.json +2 -2
- package/templates/connected-library/js/tsconfig.json +1 -1
- package/templates/connected-library/ts/package.json +2 -2
- package/templates/connected-library/ts/tsconfig.json +1 -1
- package/templates/guest-adapter/js/package.json +2 -2
- package/templates/guest-adapter/js/tsconfig.json +1 -1
- package/templates/guest-adapter/ts/package.json +2 -2
- package/templates/guest-adapter/ts/tsconfig.json +1 -1
- package/templates/importer/js/package.json +2 -2
- package/templates/importer/js/tsconfig.json +1 -1
- package/templates/importer/ts/package.json +2 -2
- package/templates/importer/ts/tsconfig.json +1 -1
- package/templates/react/js/package.json +2 -2
- package/templates/react/js/tsconfig.json +1 -1
- package/templates/react/ts/package.json +2 -2
- package/templates/react/ts/tsconfig.json +1 -1
- package/templates/snapshot.json +1 -1
- package/templates/source/js/README.md +4 -0
- package/templates/source/js/ceru.plugin.json +10 -0
- package/templates/source/js/package.json +2 -2
- package/templates/source/js/src/index.js +6 -2
- package/templates/source/js/src/plugin.config.js +14 -0
- package/templates/source/js/tsconfig.json +1 -1
- package/templates/source/ts/README.md +5 -0
- package/templates/source/ts/ceru.plugin.json +10 -0
- package/templates/source/ts/package.json +2 -2
- package/templates/source/ts/src/index.ts +4 -2
- package/templates/source/ts/src/plugin.config.ts +14 -0
- package/templates/source/ts/tsconfig.json +1 -1
- package/templates/vue/js/package.json +2 -2
- package/templates/vue/js/tsconfig.json +1 -1
- package/templates/vue/ts/package.json +2 -2
- package/templates/vue/ts/tsconfig.json +1 -1
- package/templates/vue-tsx/js/package.json +2 -2
- package/templates/vue-tsx/js/tsconfig.json +1 -1
- package/templates/vue-tsx/ts/package.json +2 -2
- package/templates/vue-tsx/ts/tsconfig.json +1 -1
- package/templates/web-dist/js/package.json +2 -2
- package/templates/web-dist/js/tsconfig.json +1 -1
- package/templates/web-dist/ts/package.json +2 -2
- package/templates/web-dist/ts/tsconfig.json +1 -1
- package/templates/web-surface/js/package.json +2 -2
- package/templates/web-surface/js/tsconfig.json +1 -1
- package/templates/web-surface/ts/package.json +2 -2
- package/templates/web-surface/ts/tsconfig.json +1 -1
package/README.md
CHANGED
|
@@ -26,6 +26,8 @@ Vue/React 生产运行代码会直接打入发行文件,不依赖宿主提供
|
|
|
26
26
|
|
|
27
27
|
构建产物保留可读的入口名称(如 `LogicMain`、`UiStudioSurface`),并使用 `const` 声明每个 esbuild 入口容器,方便在单文件产物和错误堆栈中定位逻辑。插件源码仍可按需要使用函数或 class;构建器不会强制某一种编程风格。
|
|
28
28
|
|
|
29
|
+
`ceru.plugin.json` 的顶层 `config` 可直接写 JSON 对象,也可写 `@./path/config.ts` 引用 JSON/JS/TS 配置模块。字符串 `@@value` 表示字面量 `@value`。构建器递归展开引用,校验为 JSON 兼容对象,并合并到单文件的 `exports.manifest.config` 中。dev/build 会生成不包含配置值的 `@ceru/plugin-config` 类型声明。
|
|
30
|
+
|
|
29
31
|
在多根/父目录工作区中,请打开生成的 ceru-plugin.code-workspace 或把插件工程本身加入工作区。已经运行 dev 时选择 Attach to Ceru plugin;Launch 会启动或复用当前项目的 Host。
|
|
30
32
|
|
|
31
33
|
当前 v1 Host 不能直接安装 v2 产物。开发工作台不代替生产凭据保险箱、完整音乐业务或 Guest 安装。
|
package/dist/dev.js
CHANGED
|
@@ -11,9 +11,23 @@ import { fileURLToPath } from 'node:url';
|
|
|
11
11
|
import { createRequire } from 'node:module';
|
|
12
12
|
import { randomBytes, createHash } from 'node:crypto';
|
|
13
13
|
import { spawn } from 'node:child_process';
|
|
14
|
-
import { readArtifact, parseJsonStrict } from '@shiqianjiang/ceru-plugin-issuer';
|
|
14
|
+
import { readArtifact, parseJsonStrict, resolveArtifactConfig, } from '@shiqianjiang/ceru-plugin-issuer';
|
|
15
15
|
import { buildProject } from './project.js';
|
|
16
16
|
const asset = (name) => fileURLToPath(new URL('../assets/' + name, import.meta.url));
|
|
17
|
+
function mergeConfig(base, override) {
|
|
18
|
+
const result = structuredClone(base);
|
|
19
|
+
for (const [key, value] of Object.entries(override))
|
|
20
|
+
result[key] =
|
|
21
|
+
value &&
|
|
22
|
+
typeof value === 'object' &&
|
|
23
|
+
!Array.isArray(value) &&
|
|
24
|
+
result[key] &&
|
|
25
|
+
typeof result[key] === 'object' &&
|
|
26
|
+
!Array.isArray(result[key])
|
|
27
|
+
? mergeConfig(result[key], value)
|
|
28
|
+
: structuredClone(value);
|
|
29
|
+
return result;
|
|
30
|
+
}
|
|
17
31
|
async function readDebugTargets(port) {
|
|
18
32
|
const response = await fetch('http://127.0.0.1:' + port + '/json/list', {
|
|
19
33
|
signal: AbortSignal.timeout(750),
|
|
@@ -210,16 +224,17 @@ export async function runDev(project, options = {}) {
|
|
|
210
224
|
const token = randomBytes(24).toString('hex');
|
|
211
225
|
const nonce = randomBytes(24).toString('base64');
|
|
212
226
|
const catalog = JSON.parse(await readFile(asset('catalog.json'), 'utf8'));
|
|
213
|
-
let
|
|
227
|
+
let configOverride = {};
|
|
214
228
|
try {
|
|
215
229
|
const configPath = resolve(root, '.ceru-dev/config.json');
|
|
216
|
-
|
|
230
|
+
configOverride = parseJsonStrict(await readFile(configPath, 'utf8'));
|
|
217
231
|
}
|
|
218
232
|
catch (error) {
|
|
219
233
|
if (!(error instanceof Error) || !('code' in error) || error.code !== 'ENOENT')
|
|
220
234
|
throw error;
|
|
221
235
|
}
|
|
222
236
|
const grants = new Map();
|
|
237
|
+
const effectiveConfig = () => mergeConfig(resolveArtifactConfig(artifact.header), configOverride);
|
|
223
238
|
const sockets = new SocketBroker();
|
|
224
239
|
const operations = new Map();
|
|
225
240
|
const storage = new Map();
|
|
@@ -330,7 +345,7 @@ export async function runDev(project, options = {}) {
|
|
|
330
345
|
migrationWarnings: artifact.migrationWarnings,
|
|
331
346
|
resources: artifact.resources,
|
|
332
347
|
catalog,
|
|
333
|
-
config,
|
|
348
|
+
config: effectiveConfig(),
|
|
334
349
|
grants: Object.fromEntries(grants),
|
|
335
350
|
});
|
|
336
351
|
return;
|
|
@@ -343,7 +358,7 @@ export async function runDev(project, options = {}) {
|
|
|
343
358
|
if (url.pathname === '/api/config') {
|
|
344
359
|
if (!input || typeof input !== 'object' || Array.isArray(input))
|
|
345
360
|
throw new Error('Config must be an object');
|
|
346
|
-
|
|
361
|
+
configOverride = input;
|
|
347
362
|
json(200, { ok: true });
|
|
348
363
|
return;
|
|
349
364
|
}
|
|
@@ -408,7 +423,9 @@ export async function runDev(project, options = {}) {
|
|
|
408
423
|
throw new Error('此独立开发 Host 尚未连接澜音的歌单服务。本地歌单和云歌单由澜音管理;请在正式 Host 中调用此能力。开发环境不会创建替代歌单库。');
|
|
409
424
|
}
|
|
410
425
|
if (input.method === 'config.get') {
|
|
411
|
-
json(200, {
|
|
426
|
+
json(200, {
|
|
427
|
+
value: effectiveConfig(),
|
|
428
|
+
});
|
|
412
429
|
return;
|
|
413
430
|
}
|
|
414
431
|
if (input.method === 'storage.get') {
|
package/dist/index.js
CHANGED
|
@@ -6,7 +6,7 @@ import { createTemplate, generateSigningKeys, parseJsonStrict, PreparedIssuer, r
|
|
|
6
6
|
import { buildProject, scaffoldProject, TEMPLATES, writeAtomic } from './project.js';
|
|
7
7
|
import { runDev } from './dev.js';
|
|
8
8
|
export { buildProject, loadProject, scaffoldProject, TEMPLATES } from './project.js';
|
|
9
|
-
const VERSION = '0.2.
|
|
9
|
+
const VERSION = '0.2.4';
|
|
10
10
|
const HELP = 'Ceru Plugin CLI ' +
|
|
11
11
|
VERSION +
|
|
12
12
|
'\n\n' +
|
package/dist/project.d.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { type ArtifactHeader } from '@shiqianjiang/ceru-plugin-issuer';
|
|
2
|
+
import type { JsonObject } from '@shiqianjiang/ceru-plugin-sdk';
|
|
2
3
|
export interface BuildConfig {
|
|
3
4
|
manifest: ArtifactHeader['manifest'];
|
|
5
|
+
config?: JsonObject;
|
|
4
6
|
entries: Record<string, string>;
|
|
5
7
|
resources?: Record<string, {
|
|
6
8
|
path: string;
|
package/dist/project.js
CHANGED
|
@@ -8,7 +8,110 @@ import { spawnSync } from 'node:child_process';
|
|
|
8
8
|
import { createRequire } from 'node:module';
|
|
9
9
|
import { stylesheetPlugin, vuePlugin, webDistEntry } from './frameworks.js';
|
|
10
10
|
import { hostModulesPlugin, assertBundledDependencies } from './dependencies.js';
|
|
11
|
-
import { encodeArtifact, parseJsonStrict, readArtifact, validateManifest, LIMITS, } from '@shiqianjiang/ceru-plugin-issuer';
|
|
11
|
+
import { canonical, encodeArtifact, parseJsonStrict, readArtifact, validateManifest, LIMITS, } from '@shiqianjiang/ceru-plugin-issuer';
|
|
12
|
+
async function resolveConfigValue(root, value, stack = new Set(), depth = 0) {
|
|
13
|
+
if (depth > 32)
|
|
14
|
+
throw new Error('Plugin config references are too deeply nested');
|
|
15
|
+
if (typeof value === 'string') {
|
|
16
|
+
if (value.startsWith('@@'))
|
|
17
|
+
return value.slice(1);
|
|
18
|
+
if (!value.startsWith('@'))
|
|
19
|
+
return value;
|
|
20
|
+
const request = value.slice(1);
|
|
21
|
+
if (!request)
|
|
22
|
+
throw new Error('Plugin config reference cannot be empty');
|
|
23
|
+
const path = await inside(root, request);
|
|
24
|
+
if (stack.has(path))
|
|
25
|
+
throw new Error('Circular plugin config reference: ' + request);
|
|
26
|
+
stack.add(path);
|
|
27
|
+
try {
|
|
28
|
+
const extension = extname(path).toLowerCase();
|
|
29
|
+
let loaded;
|
|
30
|
+
if (extension === '.json') {
|
|
31
|
+
loaded = parseJsonStrict(await readFile(path, 'utf8'));
|
|
32
|
+
}
|
|
33
|
+
else if (['.js', '.mjs', '.cjs', '.ts', '.mts', '.cts'].includes(extension)) {
|
|
34
|
+
const result = await build({
|
|
35
|
+
absWorkingDir: root,
|
|
36
|
+
entryPoints: [path],
|
|
37
|
+
bundle: true,
|
|
38
|
+
write: false,
|
|
39
|
+
format: 'esm',
|
|
40
|
+
platform: 'node',
|
|
41
|
+
target: 'node22',
|
|
42
|
+
logLevel: 'silent',
|
|
43
|
+
});
|
|
44
|
+
if (result.outputFiles.length !== 1)
|
|
45
|
+
throw new Error('Config module emitted sidecar files: ' + request);
|
|
46
|
+
const url = 'data:text/javascript;base64,' +
|
|
47
|
+
Buffer.from(result.outputFiles[0].text).toString('base64') +
|
|
48
|
+
'#' +
|
|
49
|
+
randomUUID();
|
|
50
|
+
const module = await import(url);
|
|
51
|
+
if (!Object.hasOwn(module, 'default'))
|
|
52
|
+
throw new Error('Config module must export default: ' + request);
|
|
53
|
+
loaded = module.default;
|
|
54
|
+
}
|
|
55
|
+
else {
|
|
56
|
+
throw new Error('Config reference must be JSON, JS or TS: ' + request);
|
|
57
|
+
}
|
|
58
|
+
return resolveConfigValue(root, loaded, stack, depth + 1);
|
|
59
|
+
}
|
|
60
|
+
finally {
|
|
61
|
+
stack.delete(path);
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
if (value === null || typeof value === 'boolean' || typeof value === 'number')
|
|
65
|
+
return value;
|
|
66
|
+
if (Array.isArray(value))
|
|
67
|
+
return Promise.all(value.map((item) => resolveConfigValue(root, item, stack, depth + 1)));
|
|
68
|
+
if (value && typeof value === 'object') {
|
|
69
|
+
const result = Object.create(null);
|
|
70
|
+
for (const [key, child] of Object.entries(value)) {
|
|
71
|
+
if (['__proto__', 'prototype', 'constructor'].includes(key))
|
|
72
|
+
throw new Error('Unsafe plugin config key: ' + key);
|
|
73
|
+
result[key] = await resolveConfigValue(root, child, stack, depth + 1);
|
|
74
|
+
}
|
|
75
|
+
return result;
|
|
76
|
+
}
|
|
77
|
+
throw new Error('Plugin config must contain only JSON-compatible values');
|
|
78
|
+
}
|
|
79
|
+
function validatePluginConfig(value) {
|
|
80
|
+
if (value === undefined)
|
|
81
|
+
return undefined;
|
|
82
|
+
if (!value || typeof value !== 'object' || Array.isArray(value))
|
|
83
|
+
throw new Error('Plugin config root must resolve to an object');
|
|
84
|
+
return parseJsonStrict(canonical(value));
|
|
85
|
+
}
|
|
86
|
+
function configType(value, depth = 0) {
|
|
87
|
+
if (depth > 24)
|
|
88
|
+
return 'JsonValue';
|
|
89
|
+
if (value === null)
|
|
90
|
+
return 'null';
|
|
91
|
+
if (typeof value === 'string')
|
|
92
|
+
return 'string';
|
|
93
|
+
if (typeof value === 'number')
|
|
94
|
+
return 'number';
|
|
95
|
+
if (typeof value === 'boolean')
|
|
96
|
+
return 'boolean';
|
|
97
|
+
if (Array.isArray(value)) {
|
|
98
|
+
const members = [...new Set(value.map((item) => configType(item, depth + 1)))];
|
|
99
|
+
return 'readonly (' + (members.join(' | ') || 'JsonValue') + ')[]';
|
|
100
|
+
}
|
|
101
|
+
const fields = Object.entries(value).map(([key, child]) => 'readonly ' + JSON.stringify(key) + ': ' + configType(child, depth + 1) + ';');
|
|
102
|
+
return '{ ' + fields.join(' ') + ' }';
|
|
103
|
+
}
|
|
104
|
+
async function writeConfigTypes(root, config) {
|
|
105
|
+
const path = resolve(root, '.ceru-dev/types/plugin-config.d.ts');
|
|
106
|
+
const source = "declare module '@ceru/plugin-config' {\n" +
|
|
107
|
+
" type JsonValue = import('@shiqianjiang/ceru-plugin-sdk').JsonValue\n" +
|
|
108
|
+
' export type PluginConfig = ' +
|
|
109
|
+
configType(config) +
|
|
110
|
+
'\n const config: PluginConfig\n export default config\n}\n';
|
|
111
|
+
await mkdir(dirname(path), { recursive: true });
|
|
112
|
+
await writeFile(path, source);
|
|
113
|
+
return path;
|
|
114
|
+
}
|
|
12
115
|
function entryFunctionName(id, suffix) {
|
|
13
116
|
const words = id.split(/[^a-zA-Z0-9]+/).filter(Boolean);
|
|
14
117
|
const name = words
|
|
@@ -48,10 +151,16 @@ async function inside(root, path) {
|
|
|
48
151
|
}
|
|
49
152
|
export async function loadProject(project) {
|
|
50
153
|
const root = await realpath(resolve(project));
|
|
51
|
-
const
|
|
154
|
+
const source = parseJsonStrict(await readFile(resolve(root, 'ceru.plugin.json'), 'utf8'));
|
|
155
|
+
const expanded = await resolveConfigValue(root, source);
|
|
156
|
+
if (!expanded || typeof expanded !== 'object' || Array.isArray(expanded))
|
|
157
|
+
throw new Error('ceru.plugin.json must resolve to an object');
|
|
158
|
+
const raw = expanded;
|
|
52
159
|
for (const key of Object.keys(raw))
|
|
53
160
|
if (![
|
|
161
|
+
'$schema',
|
|
54
162
|
'manifest',
|
|
163
|
+
'config',
|
|
55
164
|
'entries',
|
|
56
165
|
'resources',
|
|
57
166
|
'output',
|
|
@@ -64,6 +173,11 @@ export async function loadProject(project) {
|
|
|
64
173
|
// to standalone bundles, without requiring authors to rewrite their source.
|
|
65
174
|
if (raw.manifest?.engines)
|
|
66
175
|
delete raw.manifest.engines.libraries;
|
|
176
|
+
if (raw.config !== undefined && raw.manifest?.config !== undefined)
|
|
177
|
+
throw new Error('Define config either at the project root or manifest.config, not both');
|
|
178
|
+
raw.config = validatePluginConfig(raw.config ?? raw.manifest?.config);
|
|
179
|
+
if (raw.config !== undefined)
|
|
180
|
+
raw.manifest.config = raw.config;
|
|
67
181
|
if (raw.framework && !['vanilla', 'vue', 'react'].includes(raw.framework))
|
|
68
182
|
throw new Error('Unsupported framework');
|
|
69
183
|
validateManifest(raw.manifest);
|
|
@@ -77,13 +191,16 @@ export async function loadProject(project) {
|
|
|
77
191
|
}
|
|
78
192
|
return { root, config: raw };
|
|
79
193
|
}
|
|
80
|
-
function checkTypes(root) {
|
|
194
|
+
function checkTypes(root, extraFiles = []) {
|
|
81
195
|
const path = resolve(root, 'tsconfig.json');
|
|
82
196
|
const read = ts.readConfigFile(path, ts.sys.readFile);
|
|
83
197
|
if (read.error)
|
|
84
198
|
throw new Error(ts.flattenDiagnosticMessageText(read.error.messageText, '\n'));
|
|
85
199
|
const config = ts.parseJsonConfigFileContent(read.config, ts.sys, root);
|
|
86
|
-
const program = ts.createProgram(config.fileNames,
|
|
200
|
+
const program = ts.createProgram([...new Set([...config.fileNames, ...extraFiles])], {
|
|
201
|
+
...config.options,
|
|
202
|
+
noEmit: true,
|
|
203
|
+
});
|
|
87
204
|
const diagnostics = [...config.errors, ...ts.getPreEmitDiagnostics(program)];
|
|
88
205
|
if (diagnostics.length) {
|
|
89
206
|
throw new Error(ts.formatDiagnosticsWithColorAndContext(diagnostics, {
|
|
@@ -102,7 +219,8 @@ export async function buildProject(project = '.', options = {}) {
|
|
|
102
219
|
if (result.status !== 0)
|
|
103
220
|
throw new Error(result.stdout + result.stderr);
|
|
104
221
|
}
|
|
105
|
-
const
|
|
222
|
+
const configTypes = await writeConfigTypes(root, config.config ?? {});
|
|
223
|
+
const program = checkTypes(root, [configTypes]);
|
|
106
224
|
const checker = program.getTypeChecker();
|
|
107
225
|
const chunks = new Map();
|
|
108
226
|
const devModules = {};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shiqianjiang/ceru-plugin-cli",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.4",
|
|
4
4
|
"description": "TypeScript scaffolding, single-file build, watch, validation, signing and issuance for Ceru plugins",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
}
|
|
14
14
|
},
|
|
15
15
|
"bin": {
|
|
16
|
-
"ceru-plugin": "
|
|
16
|
+
"ceru-plugin": "dist/bin.js"
|
|
17
17
|
},
|
|
18
18
|
"files": [
|
|
19
19
|
"dist",
|
|
@@ -32,8 +32,8 @@
|
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
34
|
"@babel/core": "^7.29.7",
|
|
35
|
-
"@shiqianjiang/ceru-plugin-issuer": "0.2.
|
|
36
|
-
"@shiqianjiang/ceru-plugin-sdk": "0.2.
|
|
35
|
+
"@shiqianjiang/ceru-plugin-issuer": "0.2.2",
|
|
36
|
+
"@shiqianjiang/ceru-plugin-sdk": "0.2.2",
|
|
37
37
|
"@vue/babel-plugin-jsx": "^2.0.1",
|
|
38
38
|
"@vue/compiler-sfc": "3.5.43",
|
|
39
39
|
"axios": "^1.20.0",
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
"properties": {
|
|
6
6
|
"$schema": {
|
|
7
7
|
"type": "string",
|
|
8
|
-
"
|
|
8
|
+
"description": "Optional editor schema reference; ignored by the build runtime."
|
|
9
9
|
},
|
|
10
10
|
"manifest": {
|
|
11
11
|
"type": "object",
|
|
@@ -46,6 +46,10 @@
|
|
|
46
46
|
"minLength": 1,
|
|
47
47
|
"maxLength": 4096
|
|
48
48
|
},
|
|
49
|
+
"config": {
|
|
50
|
+
"type": "object",
|
|
51
|
+
"additionalProperties": true
|
|
52
|
+
},
|
|
49
53
|
"engines": {
|
|
50
54
|
"type": "object",
|
|
51
55
|
"properties": {
|
|
@@ -884,6 +888,20 @@
|
|
|
884
888
|
],
|
|
885
889
|
"additionalProperties": false
|
|
886
890
|
},
|
|
891
|
+
"config": {
|
|
892
|
+
"oneOf": [
|
|
893
|
+
{
|
|
894
|
+
"type": "object",
|
|
895
|
+
"description": "JSON-compatible defaults exposed through ctx.config.",
|
|
896
|
+
"additionalProperties": true
|
|
897
|
+
},
|
|
898
|
+
{
|
|
899
|
+
"type": "string",
|
|
900
|
+
"pattern": "^@.+",
|
|
901
|
+
"description": "Build-time JSON/JS/TS config reference, for example @./src/plugin.config.ts."
|
|
902
|
+
}
|
|
903
|
+
]
|
|
904
|
+
},
|
|
887
905
|
"entries": {
|
|
888
906
|
"type": "object",
|
|
889
907
|
"description": "Map stable module IDs to TS/TSX/JS source files",
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2"
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2"
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2"
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2"
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2"
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2"
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2",
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2",
|
package/templates/snapshot.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 1,
|
|
3
3
|
"source": "https://github.com/CeruMusic/CeruMusic-Plugin-Template",
|
|
4
|
-
"digest": "sha256:
|
|
4
|
+
"digest": "sha256:1d272f9254f1249079611b29f59837e3277de70d40c911da207bdd935258f415",
|
|
5
5
|
"files": [
|
|
6
6
|
"connected-library/js/_gitignore",
|
|
7
7
|
"connected-library/js/.prettierrc.json",
|
|
@@ -19,6 +19,10 @@ VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to
|
|
|
19
19
|
激活代码已经执行时,可点击“重新运行”再次命中断点。
|
|
20
20
|
配置文件有 JSON Schema 提示,SDK 提供参数类型、图标名称与 Lodash 方法补全。
|
|
21
21
|
|
|
22
|
+
`ceru.plugin.json` 的 `config` 直接写普通对象。业务代码可用
|
|
23
|
+
`import('@ceru/plugin-config').PluginConfig` 声明配置类型。dev/build 会生成不含值的
|
|
24
|
+
`.ceru-dev/types/plugin-config.d.ts`,JSDoc 可引用 `@ceru/plugin-config`。
|
|
25
|
+
|
|
22
26
|
## 宿主资源
|
|
23
27
|
|
|
24
28
|
- 平台图标:icon: { kind: 'host', name: 'platform.tx' }。
|
|
@@ -52,6 +52,16 @@
|
|
|
52
52
|
"state": 1
|
|
53
53
|
}
|
|
54
54
|
},
|
|
55
|
+
"config": {
|
|
56
|
+
"displayName": "Ceru Demo",
|
|
57
|
+
"apiOrigin": "https://music.example.com",
|
|
58
|
+
"sources": {
|
|
59
|
+
"demo": {
|
|
60
|
+
"name": "Demo Source",
|
|
61
|
+
"qualities": ["320k", "flac"]
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
},
|
|
55
65
|
"entries": {
|
|
56
66
|
"logic.main": "src/index.js"
|
|
57
67
|
},
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2"
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import { definePlugin } from '@shiqianjiang/ceru-plugin-sdk'
|
|
2
2
|
|
|
3
|
+
/** @typedef {import('@ceru/plugin-config').PluginConfig} PluginConfig */
|
|
4
|
+
|
|
3
5
|
// 本地演示数据。请在接入真实音源时声明所需的网络权限。
|
|
4
6
|
const tracks = [
|
|
5
7
|
{ id: 'morning', title: 'Morning Light', artist: 'Ceru Demo' },
|
|
@@ -7,12 +9,14 @@ const tracks = [
|
|
|
7
9
|
{ id: 'night', title: 'Night Walk', artist: 'Ceru Demo' },
|
|
8
10
|
]
|
|
9
11
|
|
|
10
|
-
export default definePlugin((ctx) => {
|
|
12
|
+
export default definePlugin(async (ctx) => {
|
|
13
|
+
/** @type {Readonly<PluginConfig>} */
|
|
14
|
+
const config = await ctx.config.get()
|
|
11
15
|
ctx.actions.register('hello', async () => {
|
|
12
16
|
await ctx.ui.notify({
|
|
13
17
|
key: 'welcome',
|
|
14
18
|
level: 'info',
|
|
15
|
-
message:
|
|
19
|
+
message: `${config.displayName} 已就绪。试试搜索 Morning、Rain 或 Night。`,
|
|
16
20
|
})
|
|
17
21
|
})
|
|
18
22
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { definePluginConfig } from '@shiqianjiang/ceru-plugin-sdk'
|
|
2
|
+
|
|
3
|
+
const losslessQualities = ['flac']
|
|
4
|
+
|
|
5
|
+
export default definePluginConfig({
|
|
6
|
+
displayName: 'Ceru Demo',
|
|
7
|
+
apiOrigin: 'https://music.example.com',
|
|
8
|
+
sources: {
|
|
9
|
+
demo: {
|
|
10
|
+
name: 'Demo Source',
|
|
11
|
+
qualities: ['320k', ...losslessQualities],
|
|
12
|
+
},
|
|
13
|
+
},
|
|
14
|
+
})
|
|
@@ -19,6 +19,11 @@ VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to
|
|
|
19
19
|
激活代码已经执行时,可点击“重新运行”再次命中断点。
|
|
20
20
|
配置文件有 JSON Schema 提示,SDK 提供参数类型、图标名称与 Lodash 方法补全。
|
|
21
21
|
|
|
22
|
+
`ceru.plugin.json` 的 `config` 直接写普通对象,业务代码从
|
|
23
|
+
`@ceru/plugin-config` 导入自动生成的 `PluginConfig`,再通过
|
|
24
|
+
`await ctx.config.get<PluginConfig>()` 读取。dev/build 会生成不含值的
|
|
25
|
+
`.ceru-dev/types/plugin-config.d.ts`;可从 `@ceru/plugin-config` 导入 `PluginConfig`。
|
|
26
|
+
|
|
22
27
|
## 宿主资源
|
|
23
28
|
|
|
24
29
|
- 平台图标:icon: { kind: 'host', name: 'platform.tx' }。
|
|
@@ -52,6 +52,16 @@
|
|
|
52
52
|
"state": 1
|
|
53
53
|
}
|
|
54
54
|
},
|
|
55
|
+
"config": {
|
|
56
|
+
"displayName": "Ceru Demo",
|
|
57
|
+
"apiOrigin": "https://music.example.com",
|
|
58
|
+
"sources": {
|
|
59
|
+
"demo": {
|
|
60
|
+
"name": "Demo Source",
|
|
61
|
+
"qualities": ["320k", "flac"]
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
},
|
|
55
65
|
"entries": {
|
|
56
66
|
"logic.main": "src/index.ts"
|
|
57
67
|
},
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2"
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { definePlugin } from '@shiqianjiang/ceru-plugin-sdk'
|
|
2
|
+
import type { PluginConfig } from '@ceru/plugin-config'
|
|
2
3
|
|
|
3
4
|
// 本地演示数据。请在接入真实音源时声明所需的网络权限。
|
|
4
5
|
const tracks = [
|
|
@@ -7,12 +8,13 @@ const tracks = [
|
|
|
7
8
|
{ id: 'night', title: 'Night Walk', artist: 'Ceru Demo' },
|
|
8
9
|
]
|
|
9
10
|
|
|
10
|
-
export default definePlugin((ctx) => {
|
|
11
|
+
export default definePlugin(async (ctx) => {
|
|
12
|
+
const config = await ctx.config.get<PluginConfig>()
|
|
11
13
|
ctx.actions.register('hello', async () => {
|
|
12
14
|
await ctx.ui.notify({
|
|
13
15
|
key: 'welcome',
|
|
14
16
|
level: 'info',
|
|
15
|
-
message:
|
|
17
|
+
message: `${config.displayName} 已就绪。试试搜索 Morning、Rain 或 Night。`,
|
|
16
18
|
})
|
|
17
19
|
})
|
|
18
20
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { definePluginConfig } from '@shiqianjiang/ceru-plugin-sdk'
|
|
2
|
+
|
|
3
|
+
const losslessQualities = ['flac'] as const
|
|
4
|
+
|
|
5
|
+
export default definePluginConfig({
|
|
6
|
+
displayName: 'Ceru Demo',
|
|
7
|
+
apiOrigin: 'https://music.example.com',
|
|
8
|
+
sources: {
|
|
9
|
+
demo: {
|
|
10
|
+
name: 'Demo Source',
|
|
11
|
+
qualities: ['320k', ...losslessQualities],
|
|
12
|
+
},
|
|
13
|
+
},
|
|
14
|
+
})
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2",
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2",
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2",
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2",
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2"
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2"
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2"
|
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
"preview": "ceru-plugin preview dist/plugin.js"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@shiqianjiang/ceru-plugin-sdk": "^0.2.
|
|
14
|
+
"@shiqianjiang/ceru-plugin-sdk": "^0.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@shiqianjiang/ceru-plugin-cli": "^0.2.
|
|
17
|
+
"@shiqianjiang/ceru-plugin-cli": "^0.2.4",
|
|
18
18
|
"typescript": "~5.9.3",
|
|
19
19
|
"electron": "^44.4.2",
|
|
20
20
|
"prettier": "^3.6.2"
|