@shiqianjiang/ceru-plugin-cli 0.3.16 → 3.0.0

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.
Files changed (302) hide show
  1. package/README.md +26 -7
  2. package/assets/compatibility.json +18 -0
  3. package/dist/compatibility.d.ts +24 -0
  4. package/dist/compatibility.js +119 -0
  5. package/dist/component.d.ts +6 -0
  6. package/dist/component.js +60 -0
  7. package/dist/dev-music.d.ts +19 -0
  8. package/dist/dev-music.js +81 -0
  9. package/dist/dev-plugin-services.d.ts +10 -0
  10. package/dist/dev-plugin-services.js +67 -0
  11. package/dist/dev.d.ts +1 -9
  12. package/dist/dev.js +53 -713
  13. package/dist/frameworks.d.ts +5 -2
  14. package/dist/frameworks.js +43 -6
  15. package/dist/index.d.ts +1 -1
  16. package/dist/index.js +54 -23
  17. package/dist/init.js +3 -3
  18. package/dist/migrate.d.ts +3 -0
  19. package/dist/migrate.js +109 -0
  20. package/dist/project.d.ts +5 -2
  21. package/dist/project.js +131 -43
  22. package/dist/test-hooks.d.ts +1 -0
  23. package/dist/test-hooks.js +209 -0
  24. package/dist/test-services.d.ts +4 -0
  25. package/dist/test-services.js +54 -0
  26. package/dist/watch-vue-types.d.ts +17 -0
  27. package/dist/watch-vue-types.js +145 -0
  28. package/package.json +10 -6
  29. package/schemas/config.schema.json +954 -452
  30. package/templates/account-qrcode/js/.vscode/extensions.json +3 -0
  31. package/templates/account-qrcode/js/.vscode/launch.json +19 -0
  32. package/templates/account-qrcode/js/.vscode/settings.json +20 -0
  33. package/templates/account-qrcode/js/.vscode/tasks.json +43 -0
  34. package/templates/account-qrcode/js/README.md +15 -0
  35. package/templates/account-qrcode/js/_gitignore +6 -0
  36. package/templates/account-qrcode/js/ceru-plugin.code-workspace +8 -0
  37. package/templates/account-qrcode/js/ceru.plugin.json +62 -0
  38. package/templates/account-qrcode/js/package.json +24 -0
  39. package/templates/account-qrcode/js/src/Login.vue +25 -0
  40. package/templates/account-qrcode/js/src/index.js +25 -0
  41. package/templates/account-qrcode/js/src/login-html.js +23 -0
  42. package/templates/account-qrcode/js/tsconfig.json +17 -0
  43. package/templates/account-qrcode/ts/.vscode/extensions.json +3 -0
  44. package/templates/account-qrcode/ts/.vscode/launch.json +19 -0
  45. package/templates/account-qrcode/ts/.vscode/settings.json +20 -0
  46. package/templates/account-qrcode/ts/.vscode/tasks.json +43 -0
  47. package/templates/account-qrcode/ts/README.md +15 -0
  48. package/templates/account-qrcode/ts/_gitignore +6 -0
  49. package/templates/account-qrcode/ts/ceru-plugin.code-workspace +8 -0
  50. package/templates/account-qrcode/ts/ceru.plugin.json +62 -0
  51. package/templates/account-qrcode/ts/package.json +24 -0
  52. package/templates/account-qrcode/ts/src/Login.vue +25 -0
  53. package/templates/account-qrcode/ts/src/index.ts +25 -0
  54. package/templates/account-qrcode/ts/src/login-html.ts +23 -0
  55. package/templates/account-qrcode/ts/tsconfig.json +17 -0
  56. package/templates/connected-library/js/.vscode/launch.json +12 -29
  57. package/templates/connected-library/js/.vscode/tasks.json +2 -3
  58. package/templates/connected-library/js/README.md +26 -12
  59. package/templates/connected-library/js/ceru.plugin.json +122 -50
  60. package/templates/connected-library/js/package.json +5 -5
  61. package/templates/connected-library/js/src/index.js +46 -5
  62. package/templates/connected-library/js/src/settings.js +28 -0
  63. package/templates/connected-library/ts/.vscode/launch.json +12 -29
  64. package/templates/connected-library/ts/.vscode/tasks.json +2 -3
  65. package/templates/connected-library/ts/README.md +26 -12
  66. package/templates/connected-library/ts/ceru.plugin.json +122 -50
  67. package/templates/connected-library/ts/package.json +5 -5
  68. package/templates/connected-library/ts/src/index.ts +46 -5
  69. package/templates/connected-library/ts/src/settings.ts +28 -0
  70. package/templates/encrypted-source/README.md +86 -0
  71. package/templates/encrypted-source/js/.prettierrc.json +5 -0
  72. package/templates/encrypted-source/js/.vscode/ceru.code-snippets +55 -0
  73. package/templates/encrypted-source/js/.vscode/extensions.json +3 -0
  74. package/templates/encrypted-source/js/.vscode/launch.json +15 -0
  75. package/templates/encrypted-source/js/.vscode/settings.json +20 -0
  76. package/templates/encrypted-source/js/.vscode/tasks.json +40 -0
  77. package/templates/encrypted-source/js/DEMO.md +77 -0
  78. package/templates/encrypted-source/js/README.md +13 -0
  79. package/templates/encrypted-source/js/_gitignore +6 -0
  80. package/templates/encrypted-source/js/ceru-plugin.code-workspace +8 -0
  81. package/templates/encrypted-source/js/ceru.plugin.json +95 -0
  82. package/templates/encrypted-source/js/package.json +26 -0
  83. package/templates/encrypted-source/js/resources/xor-byte.wasm +0 -0
  84. package/templates/encrypted-source/js/resources/xor-byte.wat +5 -0
  85. package/templates/encrypted-source/js/src/demo.js +200 -0
  86. package/templates/encrypted-source/js/src/fixtures.js +118 -0
  87. package/templates/encrypted-source/js/src/index.js +4 -0
  88. package/templates/encrypted-source/js/tests/demo.test.mjs +357 -0
  89. package/templates/encrypted-source/js/tsconfig.json +16 -0
  90. package/templates/encrypted-source/ts/.prettierrc.json +5 -0
  91. package/templates/encrypted-source/ts/.vscode/ceru.code-snippets +55 -0
  92. package/templates/encrypted-source/ts/.vscode/extensions.json +3 -0
  93. package/templates/encrypted-source/ts/.vscode/launch.json +15 -0
  94. package/templates/encrypted-source/ts/.vscode/settings.json +20 -0
  95. package/templates/encrypted-source/ts/.vscode/tasks.json +40 -0
  96. package/templates/encrypted-source/ts/DEMO.md +77 -0
  97. package/templates/encrypted-source/ts/README.md +13 -0
  98. package/templates/encrypted-source/ts/_gitignore +6 -0
  99. package/templates/encrypted-source/ts/ceru-plugin.code-workspace +8 -0
  100. package/templates/encrypted-source/ts/ceru.plugin.json +95 -0
  101. package/templates/encrypted-source/ts/package.json +26 -0
  102. package/templates/encrypted-source/ts/resources/xor-byte.wasm +0 -0
  103. package/templates/encrypted-source/ts/resources/xor-byte.wat +5 -0
  104. package/templates/encrypted-source/ts/src/demo.ts +212 -0
  105. package/templates/encrypted-source/ts/src/fixtures.ts +125 -0
  106. package/templates/encrypted-source/ts/src/index.ts +4 -0
  107. package/templates/encrypted-source/ts/tests/demo.test.mjs +357 -0
  108. package/templates/encrypted-source/ts/tsconfig.json +17 -0
  109. package/templates/guest-adapter/js/.vscode/launch.json +12 -29
  110. package/templates/guest-adapter/js/.vscode/tasks.json +2 -3
  111. package/templates/guest-adapter/js/README.md +10 -10
  112. package/templates/guest-adapter/js/ceru.plugin.json +67 -62
  113. package/templates/guest-adapter/js/package.json +5 -5
  114. package/templates/guest-adapter/js/src/index.js +1 -1
  115. package/templates/guest-adapter/js/src/settings.js +8 -0
  116. package/templates/guest-adapter/ts/.vscode/launch.json +12 -29
  117. package/templates/guest-adapter/ts/.vscode/tasks.json +2 -3
  118. package/templates/guest-adapter/ts/README.md +10 -10
  119. package/templates/guest-adapter/ts/ceru.plugin.json +67 -62
  120. package/templates/guest-adapter/ts/package.json +5 -5
  121. package/templates/guest-adapter/ts/src/index.ts +1 -1
  122. package/templates/guest-adapter/ts/src/settings.ts +8 -0
  123. package/templates/importer/js/.vscode/launch.json +12 -29
  124. package/templates/importer/js/.vscode/tasks.json +2 -3
  125. package/templates/importer/js/README.md +10 -10
  126. package/templates/importer/js/ceru.plugin.json +23 -21
  127. package/templates/importer/js/package.json +5 -5
  128. package/templates/importer/ts/.vscode/launch.json +12 -29
  129. package/templates/importer/ts/.vscode/tasks.json +2 -3
  130. package/templates/importer/ts/README.md +10 -10
  131. package/templates/importer/ts/ceru.plugin.json +23 -21
  132. package/templates/importer/ts/package.json +5 -5
  133. package/templates/page-extension/js/.vscode/extensions.json +3 -0
  134. package/templates/page-extension/js/.vscode/launch.json +19 -0
  135. package/templates/page-extension/js/.vscode/settings.json +20 -0
  136. package/templates/page-extension/js/.vscode/tasks.json +43 -0
  137. package/templates/page-extension/js/README.md +9 -0
  138. package/templates/page-extension/js/_gitignore +6 -0
  139. package/templates/page-extension/js/ceru-plugin.code-workspace +8 -0
  140. package/templates/page-extension/js/ceru.plugin.json +94 -0
  141. package/templates/page-extension/js/package.json +24 -0
  142. package/templates/page-extension/js/src/Open.vue +6 -0
  143. package/templates/page-extension/js/src/Search.vue +62 -0
  144. package/templates/page-extension/js/src/index.js +54 -0
  145. package/templates/page-extension/js/tsconfig.json +17 -0
  146. package/templates/page-extension/ts/.vscode/extensions.json +3 -0
  147. package/templates/page-extension/ts/.vscode/launch.json +19 -0
  148. package/templates/page-extension/ts/.vscode/settings.json +20 -0
  149. package/templates/page-extension/ts/.vscode/tasks.json +43 -0
  150. package/templates/page-extension/ts/README.md +9 -0
  151. package/templates/page-extension/ts/_gitignore +6 -0
  152. package/templates/page-extension/ts/ceru-plugin.code-workspace +8 -0
  153. package/templates/page-extension/ts/ceru.plugin.json +94 -0
  154. package/templates/page-extension/ts/package.json +24 -0
  155. package/templates/page-extension/ts/src/Open.vue +6 -0
  156. package/templates/page-extension/ts/src/Search.vue +62 -0
  157. package/templates/page-extension/ts/src/index.ts +54 -0
  158. package/templates/page-extension/ts/tsconfig.json +17 -0
  159. package/templates/playback-hook/js/.prettierrc.json +5 -0
  160. package/templates/playback-hook/js/.vscode/extensions.json +3 -0
  161. package/templates/playback-hook/js/.vscode/launch.json +19 -0
  162. package/templates/playback-hook/js/.vscode/settings.json +20 -0
  163. package/templates/playback-hook/js/.vscode/tasks.json +50 -0
  164. package/templates/playback-hook/js/README.md +24 -0
  165. package/templates/playback-hook/js/_gitignore +6 -0
  166. package/templates/playback-hook/js/ceru-plugin.code-workspace +8 -0
  167. package/templates/playback-hook/js/ceru.plugin.json +36 -0
  168. package/templates/playback-hook/js/package.json +23 -0
  169. package/templates/playback-hook/js/src/index.js +25 -0
  170. package/templates/playback-hook/js/tests/hooks.json +316 -0
  171. package/templates/playback-hook/js/tsconfig.json +16 -0
  172. package/templates/playback-hook/ts/.prettierrc.json +5 -0
  173. package/templates/playback-hook/ts/.vscode/extensions.json +3 -0
  174. package/templates/playback-hook/ts/.vscode/launch.json +19 -0
  175. package/templates/playback-hook/ts/.vscode/settings.json +20 -0
  176. package/templates/playback-hook/ts/.vscode/tasks.json +50 -0
  177. package/templates/playback-hook/ts/README.md +24 -0
  178. package/templates/playback-hook/ts/_gitignore +6 -0
  179. package/templates/playback-hook/ts/ceru-plugin.code-workspace +8 -0
  180. package/templates/playback-hook/ts/ceru.plugin.json +36 -0
  181. package/templates/playback-hook/ts/package.json +23 -0
  182. package/templates/playback-hook/ts/src/index.ts +25 -0
  183. package/templates/playback-hook/ts/tests/hooks.json +316 -0
  184. package/templates/playback-hook/ts/tsconfig.json +16 -0
  185. package/templates/player-skin/js/.vscode/extensions.json +3 -0
  186. package/templates/player-skin/js/.vscode/launch.json +19 -0
  187. package/templates/player-skin/js/.vscode/settings.json +20 -0
  188. package/templates/player-skin/js/.vscode/tasks.json +43 -0
  189. package/templates/player-skin/js/README.md +11 -0
  190. package/templates/player-skin/js/_gitignore +6 -0
  191. package/templates/player-skin/js/assets/studio-preview.svg +15 -0
  192. package/templates/player-skin/js/ceru-plugin.code-workspace +8 -0
  193. package/templates/player-skin/js/ceru.plugin.json +77 -0
  194. package/templates/player-skin/js/package.json +24 -0
  195. package/templates/player-skin/js/src/Artwork.vue +9 -0
  196. package/templates/player-skin/js/src/Background.vue +15 -0
  197. package/templates/player-skin/js/src/BuiltinLyrics.vue +15 -0
  198. package/templates/player-skin/js/src/Lyrics.vue +28 -0
  199. package/templates/player-skin/js/tsconfig.json +17 -0
  200. package/templates/player-skin/ts/.vscode/extensions.json +3 -0
  201. package/templates/player-skin/ts/.vscode/launch.json +19 -0
  202. package/templates/player-skin/ts/.vscode/settings.json +20 -0
  203. package/templates/player-skin/ts/.vscode/tasks.json +43 -0
  204. package/templates/player-skin/ts/README.md +11 -0
  205. package/templates/player-skin/ts/_gitignore +6 -0
  206. package/templates/player-skin/ts/assets/studio-preview.svg +15 -0
  207. package/templates/player-skin/ts/ceru-plugin.code-workspace +8 -0
  208. package/templates/player-skin/ts/ceru.plugin.json +77 -0
  209. package/templates/player-skin/ts/package.json +24 -0
  210. package/templates/player-skin/ts/src/Artwork.vue +9 -0
  211. package/templates/player-skin/ts/src/Background.vue +15 -0
  212. package/templates/player-skin/ts/src/BuiltinLyrics.vue +15 -0
  213. package/templates/player-skin/ts/src/Lyrics.vue +28 -0
  214. package/templates/player-skin/ts/tsconfig.json +17 -0
  215. package/templates/react/js/.vscode/launch.json +12 -29
  216. package/templates/react/js/.vscode/tasks.json +2 -3
  217. package/templates/react/js/README.md +10 -10
  218. package/templates/react/js/ceru.plugin.json +27 -22
  219. package/templates/react/js/package.json +5 -5
  220. package/templates/react/js/src/index.js +1 -1
  221. package/templates/react/ts/.vscode/launch.json +12 -29
  222. package/templates/react/ts/.vscode/tasks.json +2 -3
  223. package/templates/react/ts/README.md +10 -10
  224. package/templates/react/ts/ceru.plugin.json +27 -22
  225. package/templates/react/ts/package.json +5 -5
  226. package/templates/react/ts/src/index.ts +1 -1
  227. package/templates/snapshot.json +152 -6
  228. package/templates/source/js/.vscode/launch.json +12 -29
  229. package/templates/source/js/.vscode/tasks.json +2 -3
  230. package/templates/source/js/README.md +12 -10
  231. package/templates/source/js/ceru.plugin.json +44 -26
  232. package/templates/source/js/package.json +5 -5
  233. package/templates/source/js/src/index.js +10 -8
  234. package/templates/source/ts/.vscode/launch.json +12 -29
  235. package/templates/source/ts/.vscode/tasks.json +2 -3
  236. package/templates/source/ts/README.md +12 -10
  237. package/templates/source/ts/ceru.plugin.json +44 -26
  238. package/templates/source/ts/package.json +5 -5
  239. package/templates/source/ts/src/index.ts +10 -8
  240. package/templates/vue/js/.vscode/launch.json +12 -29
  241. package/templates/vue/js/.vscode/tasks.json +2 -3
  242. package/templates/vue/js/README.md +10 -10
  243. package/templates/vue/js/ceru.plugin.json +27 -22
  244. package/templates/vue/js/package.json +5 -5
  245. package/templates/vue/js/src/index.js +1 -1
  246. package/templates/vue/ts/.vscode/launch.json +12 -29
  247. package/templates/vue/ts/.vscode/tasks.json +2 -3
  248. package/templates/vue/ts/README.md +10 -10
  249. package/templates/vue/ts/ceru.plugin.json +27 -22
  250. package/templates/vue/ts/package.json +5 -5
  251. package/templates/vue/ts/src/index.ts +1 -1
  252. package/templates/vue-tsx/js/.vscode/launch.json +12 -29
  253. package/templates/vue-tsx/js/.vscode/tasks.json +2 -3
  254. package/templates/vue-tsx/js/README.md +10 -10
  255. package/templates/vue-tsx/js/ceru.plugin.json +27 -22
  256. package/templates/vue-tsx/js/package.json +5 -5
  257. package/templates/vue-tsx/js/src/index.js +1 -1
  258. package/templates/vue-tsx/ts/.vscode/launch.json +12 -29
  259. package/templates/vue-tsx/ts/.vscode/tasks.json +2 -3
  260. package/templates/vue-tsx/ts/README.md +10 -10
  261. package/templates/vue-tsx/ts/ceru.plugin.json +27 -22
  262. package/templates/vue-tsx/ts/package.json +5 -5
  263. package/templates/vue-tsx/ts/src/index.ts +1 -1
  264. package/templates/web-dist/js/.vscode/launch.json +12 -29
  265. package/templates/web-dist/js/.vscode/tasks.json +2 -3
  266. package/templates/web-dist/js/README.md +10 -10
  267. package/templates/web-dist/js/ceru.plugin.json +27 -22
  268. package/templates/web-dist/js/package.json +5 -5
  269. package/templates/web-dist/js/src/index.js +1 -1
  270. package/templates/web-dist/ts/.vscode/launch.json +12 -29
  271. package/templates/web-dist/ts/.vscode/tasks.json +2 -3
  272. package/templates/web-dist/ts/README.md +10 -10
  273. package/templates/web-dist/ts/ceru.plugin.json +27 -22
  274. package/templates/web-dist/ts/package.json +5 -5
  275. package/templates/web-dist/ts/src/index.ts +1 -1
  276. package/templates/web-surface/js/.vscode/launch.json +12 -29
  277. package/templates/web-surface/js/.vscode/tasks.json +2 -3
  278. package/templates/web-surface/js/README.md +10 -10
  279. package/templates/web-surface/js/ceru.plugin.json +35 -35
  280. package/templates/web-surface/js/package.json +5 -5
  281. package/templates/web-surface/js/src/index.js +1 -1
  282. package/templates/web-surface/ts/.vscode/launch.json +12 -29
  283. package/templates/web-surface/ts/.vscode/tasks.json +2 -3
  284. package/templates/web-surface/ts/README.md +10 -10
  285. package/templates/web-surface/ts/ceru.plugin.json +35 -35
  286. package/templates/web-surface/ts/package.json +5 -5
  287. package/templates/web-surface/ts/src/index.ts +1 -1
  288. package/assets/core-contracts.js +0 -1
  289. package/assets/electron-app/main.cjs +0 -1
  290. package/assets/electron-app/package.json +0 -8
  291. package/assets/electron.cjs +0 -42
  292. package/assets/index.html +0 -94
  293. package/assets/native-view.js +0 -197
  294. package/assets/playground.js +0 -883
  295. package/assets/sandbox.js +0 -67
  296. package/assets/style.css +0 -337
  297. package/dist/socket-broker.d.ts +0 -23
  298. package/dist/socket-broker.js +0 -229
  299. package/templates/connected-library/js/ui/settings.json +0 -24
  300. package/templates/connected-library/ts/ui/settings.json +0 -24
  301. package/templates/guest-adapter/js/ui/settings.json +0 -14
  302. package/templates/guest-adapter/ts/ui/settings.json +0 -14
@@ -2,35 +2,18 @@
2
2
  "version": "0.2.0",
3
3
  "configurations": [
4
4
  {
5
- "name": "Launch Ceru plugin",
6
- "type": "pwa-chrome",
7
- "request": "attach",
8
- "port": 9223,
9
- "preLaunchTask": "Ceru: dev",
10
- "webRoot": "${workspaceFolder}",
11
- "sourceMaps": true,
12
- "sourceMapPathOverrides": {
13
- "ceru:///*": "${workspaceFolder}/*"
14
- },
15
- "skipFiles": ["**/node_modules/**"],
16
- "address": "127.0.0.1",
17
- "urlFilter": "http://127.0.0.1:4179/",
18
- "timeout": 30000
19
- },
20
- {
21
- "name": "Attach to Ceru plugin",
22
- "type": "pwa-chrome",
23
- "request": "attach",
24
- "port": 9223,
25
- "webRoot": "${workspaceFolder}",
26
- "sourceMaps": true,
27
- "sourceMapPathOverrides": {
28
- "ceru:///*": "${workspaceFolder}/*"
29
- },
30
- "skipFiles": ["**/node_modules/**"],
31
- "address": "127.0.0.1",
32
- "urlFilter": "http://127.0.0.1:4179/",
33
- "timeout": 30000
5
+ "name": "Watch Ceru plugin",
6
+ "type": "node",
7
+ "request": "launch",
8
+ "program": "${workspaceFolder}/node_modules/@shiqianjiang/ceru-plugin-cli/dist/bin.js",
9
+ "args": [
10
+ "dev"
11
+ ],
12
+ "cwd": "${workspaceFolder}",
13
+ "console": "integratedTerminal",
14
+ "skipFiles": [
15
+ "<node_internals>/**"
16
+ ]
34
17
  }
35
18
  ]
36
19
  }
@@ -14,14 +14,13 @@
14
14
  "background": {
15
15
  "activeOnStart": true,
16
16
  "beginsPattern": "^.*$",
17
- "endsPattern": "^CERU_DEBUG_READY "
17
+ "endsPattern": "^CERU_BUILD_READY "
18
18
  }
19
19
  },
20
20
  "command": "node",
21
21
  "args": [
22
22
  "${workspaceFolder}/node_modules/@shiqianjiang/ceru-plugin-cli/dist/bin.js",
23
- "dev",
24
- "--ensure-running"
23
+ "dev"
25
24
  ],
26
25
  "options": {
27
26
  "cwd": "${workspaceFolder}"
@@ -1,22 +1,22 @@
1
1
  # source / ts
2
2
 
3
- Ceru Music v2 插件开发模板。此目录是源码,不是安装包。
3
+ Ceru Music v3 插件开发模板。此目录是源码,不是安装包。
4
4
 
5
5
  ## 运行 demo
6
6
 
7
- 1. 使用脚手架创建工程:
7
+ 1. 使用匹配的 v3 脚手架创建工程(本地开发套件可使用其 `npm run create` 命令):
8
8
 
9
- npm create ceru-plugin@latest my-plugin -- --template source --lang ts
9
+ ceru-plugin init my-plugin --template source --lang ts
10
10
 
11
11
  2. 进入目录,运行 npm install。
12
- 3. 运行 npm run dev,打开独立 Electron 调试工作台。
12
+ 3. 运行 npm run dev,在澜音「设置 → 插件管理 → 管理设置 → 插件开发者模式」添加终端打印的 JS 文件。
13
13
  4. 修改 src 中的代码;保存后自动类型检查并重载。
14
14
  5. 运行 npm run build,只分发 dist/plugin.js。
15
15
 
16
16
  ## 编辑器
17
17
 
18
- VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to Ceru plugin。
19
- 激活代码已经执行时,可点击“重新运行”再次命中断点。
18
+ VS Code 按 F5 选择 Watch Ceru plugin,会启动本地构建监听,不会另开 Electron。
19
+ 已在终端运行 npm run dev 时不必再按 F5。
20
20
  配置文件有 JSON Schema 提示,SDK 提供参数类型、图标名称与 Lodash 方法补全。
21
21
 
22
22
  `ceru.plugin.json` 的 `config` 直接写普通对象,业务代码从
@@ -31,18 +31,20 @@ VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to
31
31
  - 默认封面:await ctx.assets.url('placeholder.cover')。
32
32
  - 共享工具:ctx.utils.lodash。
33
33
 
34
- Vue/React 的生产运行代码、页面和样式直接编入发行 JS,宿主不提供框架。
34
+ 视图是否自带框架由清单的 `entry.views[].kind` 决定:`web` 页面打包自己用到的框架;`native` 由宿主绘制;`component` 复用宿主提供的 Vue、TDesign 和音乐组件。开发宿主风格的页面可选 `page-extension` 模板,播放器区域可选 `player-skin`,不需要复制桌面组件源码。
35
35
  TypeScript、Vue 编译器、构建工具与开发服务器不会进入产物。
36
- 运行 npm run preview 可只加载 dist/plugin.js 检查发布后的行为。
36
+ 运行 `npm run typecheck` 只检查工程,不生成发行文件。可选 `npm run preview` 验证构建产物并打印路径;将该文件加入桌面的插件开发者模式即可预览,不会启动服务器。
37
37
 
38
38
  若 VS Code 打开的是父目录,请打开本工程的 ceru-plugin.code-workspace,
39
- 再在“运行和调试”中选择 Launch Ceru plugin;已经运行 npm/pnpm dev 时选择 Attach to Ceru plugin。
39
+ 再在“运行和调试”中选择 Watch Ceru plugin。
40
40
  F5 执行当前下拉框中的配置,不会自动选择终端所在的子工程。
41
41
 
42
42
  ## 边界
43
43
 
44
- 本模板面向 v2 协议。开发工作台不是当前 v1 桌面 Host 的兼容层。
44
+ 本模板面向 v3 协议。需要支持 v3 的宿主。
45
45
  凭据保险箱、完整音乐业务和 Guest 安装需要正式 Host;不支持的调试调用会明确报错。
46
46
  不要把私人 API Key、卡密或发行私钥提交到仓库。
47
47
 
48
48
  此 demo 搜索三条本地元数据,不连接真实音乐服务,也不伪造可播放地址。
49
+
50
+ 为 `config.previewUrl` 配置可访问的 HTTP(S) 音频文件,即可试听搜索结果并显示示例歌词;留空时不提供播放地址。
@@ -1,34 +1,37 @@
1
1
  {
2
2
  "manifest": {
3
- "manifestVersion": 2,
3
+ "manifestVersion": 3,
4
4
  "id": "local.ts",
5
5
  "name": "ts",
6
6
  "version": "0.1.0",
7
- "description": "A Ceru Music v2 source plugin",
7
+ "description": "A Ceru Music v3 source plugin",
8
+ "dataSchemas": {
9
+ "config": 1,
10
+ "state": 1
11
+ },
8
12
  "engines": {
9
- "hostApi": "^2.0.0",
10
- "logicRuntime": "ceru-js@1",
11
- "uiSchema": "^1.0.0"
13
+ "hostApi": "^3.0.0",
14
+ "logicRuntime": "ceru-js@1"
12
15
  },
13
- "modules": {
16
+ "entry": {
14
17
  "logic": {
15
- "entry": "logic.main",
16
- "activation": ["onCommand:hello", "onProvider:catalog"]
18
+ "activation": [
19
+ "onCommand:hello",
20
+ "onProvider:catalog"
21
+ ],
22
+ "module": "logic.main"
17
23
  }
18
24
  },
19
- "contributes": {
20
- "commands": [
21
- {
22
- "id": "hello",
23
- "title": "Hello",
24
- "action": "hello"
25
- }
26
- ],
25
+ "provides": {
27
26
  "providers": [
28
27
  {
29
28
  "id": "catalog",
30
29
  "name": "ts",
31
- "protocols": ["music.search@1", "music.resolve@1"],
30
+ "protocols": [
31
+ "music.search@1",
32
+ "music.resolve@1",
33
+ "music.lyrics@1"
34
+ ],
32
35
  "icon": {
33
36
  "kind": "host",
34
37
  "name": "music-note"
@@ -36,20 +39,31 @@
36
39
  "connectionMode": "none"
37
40
  }
38
41
  ],
42
+ "actions": [
43
+ {
44
+ "id": "hello",
45
+ "title": "Hello"
46
+ }
47
+ ]
48
+ },
49
+ "uses": {
50
+ "permissions": []
51
+ },
52
+ "ui": {
39
53
  "homeSections": [
40
54
  {
41
55
  "id": "catalog-playlists",
42
56
  "title": "歌单",
43
57
  "kind": "playlists",
44
- "icon": { "kind": "host", "name": "library" },
45
- "providerIds": ["catalog"]
58
+ "icon": {
59
+ "kind": "host",
60
+ "name": "library"
61
+ },
62
+ "providerIds": [
63
+ "catalog"
64
+ ]
46
65
  }
47
66
  ]
48
- },
49
- "permissions": [],
50
- "dataSchemas": {
51
- "config": 1,
52
- "state": 1
53
67
  }
54
68
  },
55
69
  "config": {
@@ -58,9 +72,13 @@
58
72
  "sources": {
59
73
  "demo": {
60
74
  "name": "Demo Source",
61
- "qualities": ["320k", "flac"]
75
+ "qualities": [
76
+ "320k",
77
+ "flac"
78
+ ]
62
79
  }
63
- }
80
+ },
81
+ "previewUrl": ""
64
82
  },
65
83
  "entries": {
66
84
  "logic.main": "src/index.ts"
@@ -6,17 +6,17 @@
6
6
  "scripts": {
7
7
  "dev": "ceru-plugin dev",
8
8
  "build": "ceru-plugin build",
9
- "typecheck": "tsc --noEmit",
9
+ "typecheck": "ceru-plugin typecheck",
10
10
  "validate": "ceru-plugin validate dist/plugin.js",
11
- "preview": "ceru-plugin preview dist/plugin.js"
11
+ "preview": "ceru-plugin preview dist/plugin.js",
12
+ "check:compat": "ceru-plugin check-compat"
12
13
  },
13
14
  "dependencies": {
14
- "@shiqianjiang/ceru-plugin-sdk": "^0.3.16"
15
+ "@shiqianjiang/ceru-plugin-sdk": "^3.0.0"
15
16
  },
16
17
  "devDependencies": {
17
- "@shiqianjiang/ceru-plugin-cli": "^0.3.16",
18
+ "@shiqianjiang/ceru-plugin-cli": "^3.0.0",
18
19
  "typescript": "~5.9.3",
19
- "electron": "^44.4.2",
20
20
  "prettier": "^3.6.2"
21
21
  }
22
22
  }
@@ -41,19 +41,21 @@ export default definePlugin(async (ctx) => {
41
41
  },
42
42
  title: track.title,
43
43
  subtitle: track.artist,
44
- playable: false,
44
+ playable: !!config.previewUrl,
45
45
  metadata: { artists: [track.artist] },
46
- capabilities: [],
46
+ capabilities: config.previewUrl ? ['play'] : [],
47
47
  })),
48
48
  }
49
49
  },
50
50
 
51
- async resolve() {
52
- // 演示不会伪造播放地址。真实解析器返回 { ok: true, url, expiresAt? }。
53
- return ctx.playback.failure({
54
- code: 'UNSUPPORTED',
55
- message: '这是本地搜索 demo,尚未连接真实的音源服务。',
56
- })
51
+ async resolve(ref) {
52
+ if (config.previewUrl && tracks.some(track => track.id === ref.id))
53
+ return { ok: true, url: config.previewUrl }
54
+ return ctx.playback.failure({code:'UNSUPPORTED', message:'请在 previewUrl 配置自己的 HTTP(S) 试听文件。'})
55
+ },
56
+ async lyrics(ref) {
57
+ const track = tracks.find(item => item.id === ref.id)
58
+ return {format:'crlyric',version:1,track:ref,offsetMs:0,lines:track ? [{startTimeMs:0,text:track.title}] : []}
57
59
  },
58
60
  },
59
61
  })
@@ -2,35 +2,18 @@
2
2
  "version": "0.2.0",
3
3
  "configurations": [
4
4
  {
5
- "name": "Launch Ceru plugin",
6
- "type": "pwa-chrome",
7
- "request": "attach",
8
- "port": 9223,
9
- "preLaunchTask": "Ceru: dev",
10
- "webRoot": "${workspaceFolder}",
11
- "sourceMaps": true,
12
- "sourceMapPathOverrides": {
13
- "ceru:///*": "${workspaceFolder}/*"
14
- },
15
- "skipFiles": ["**/node_modules/**"],
16
- "address": "127.0.0.1",
17
- "urlFilter": "http://127.0.0.1:4179/",
18
- "timeout": 30000
19
- },
20
- {
21
- "name": "Attach to Ceru plugin",
22
- "type": "pwa-chrome",
23
- "request": "attach",
24
- "port": 9223,
25
- "webRoot": "${workspaceFolder}",
26
- "sourceMaps": true,
27
- "sourceMapPathOverrides": {
28
- "ceru:///*": "${workspaceFolder}/*"
29
- },
30
- "skipFiles": ["**/node_modules/**"],
31
- "address": "127.0.0.1",
32
- "urlFilter": "http://127.0.0.1:4179/",
33
- "timeout": 30000
5
+ "name": "Watch Ceru plugin",
6
+ "type": "node",
7
+ "request": "launch",
8
+ "program": "${workspaceFolder}/node_modules/@shiqianjiang/ceru-plugin-cli/dist/bin.js",
9
+ "args": [
10
+ "dev"
11
+ ],
12
+ "cwd": "${workspaceFolder}",
13
+ "console": "integratedTerminal",
14
+ "skipFiles": [
15
+ "<node_internals>/**"
16
+ ]
34
17
  }
35
18
  ]
36
19
  }
@@ -14,14 +14,13 @@
14
14
  "background": {
15
15
  "activeOnStart": true,
16
16
  "beginsPattern": "^.*$",
17
- "endsPattern": "^CERU_DEBUG_READY "
17
+ "endsPattern": "^CERU_BUILD_READY "
18
18
  }
19
19
  },
20
20
  "command": "node",
21
21
  "args": [
22
22
  "${workspaceFolder}/node_modules/@shiqianjiang/ceru-plugin-cli/dist/bin.js",
23
- "dev",
24
- "--ensure-running"
23
+ "dev"
25
24
  ],
26
25
  "options": {
27
26
  "cwd": "${workspaceFolder}"
@@ -1,22 +1,22 @@
1
1
  # vue / js
2
2
 
3
- Ceru Music v2 插件开发模板。此目录是源码,不是安装包。
3
+ Ceru Music v3 插件开发模板。此目录是源码,不是安装包。
4
4
 
5
5
  ## 运行 demo
6
6
 
7
- 1. 使用脚手架创建工程:
7
+ 1. 使用匹配的 v3 脚手架创建工程(本地开发套件可使用其 `npm run create` 命令):
8
8
 
9
- npm create ceru-plugin@latest my-plugin -- --template vue --lang js
9
+ ceru-plugin init my-plugin --template vue --lang js
10
10
 
11
11
  2. 进入目录,运行 npm install。
12
- 3. 运行 npm run dev,打开独立 Electron 调试工作台。
12
+ 3. 运行 npm run dev,在澜音「设置 → 插件管理 → 管理设置 → 插件开发者模式」添加终端打印的 JS 文件。
13
13
  4. 修改 src 中的代码;保存后自动类型检查并重载。
14
14
  5. 运行 npm run build,只分发 dist/plugin.js。
15
15
 
16
16
  ## 编辑器
17
17
 
18
- VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to Ceru plugin。
19
- 激活代码已经执行时,可点击“重新运行”再次命中断点。
18
+ VS Code 按 F5 选择 Watch Ceru plugin,会启动本地构建监听,不会另开 Electron。
19
+ 已在终端运行 npm run dev 时不必再按 F5。
20
20
  配置文件有 JSON Schema 提示,SDK 提供参数类型、图标名称与 Lodash 方法补全。
21
21
 
22
22
  ## 宿主资源
@@ -26,16 +26,16 @@ VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to
26
26
  - 默认封面:await ctx.assets.url('placeholder.cover')。
27
27
  - 共享工具:ctx.utils.lodash。
28
28
 
29
- Vue/React 的生产运行代码、页面和样式直接编入发行 JS,宿主不提供框架。
29
+ 视图是否自带框架由清单的 `entry.views[].kind` 决定:`web` 页面打包自己用到的框架;`native` 由宿主绘制;`component` 复用宿主提供的 Vue、TDesign 和音乐组件。开发宿主风格的页面可选 `page-extension` 模板,播放器区域可选 `player-skin`,不需要复制桌面组件源码。
30
30
  TypeScript、Vue 编译器、构建工具与开发服务器不会进入产物。
31
- 运行 npm run preview 可只加载 dist/plugin.js 检查发布后的行为。
31
+ 运行 `npm run typecheck` 只检查工程,不生成发行文件。可选 `npm run preview` 验证构建产物并打印路径;将该文件加入桌面的插件开发者模式即可预览,不会启动服务器。
32
32
 
33
33
  若 VS Code 打开的是父目录,请打开本工程的 ceru-plugin.code-workspace,
34
- 再在“运行和调试”中选择 Launch Ceru plugin;已经运行 npm/pnpm dev 时选择 Attach to Ceru plugin。
34
+ 再在“运行和调试”中选择 Watch Ceru plugin。
35
35
  F5 执行当前下拉框中的配置,不会自动选择终端所在的子工程。
36
36
 
37
37
  ## 边界
38
38
 
39
- 本模板面向 v2 协议。开发工作台不是当前 v1 桌面 Host 的兼容层。
39
+ 本模板面向 v3 协议。需要支持 v3 的宿主。
40
40
  凭据保险箱、完整音乐业务和 Guest 安装需要正式 Host;不支持的调试调用会明确报错。
41
41
  不要把私人 API Key、卡密或发行私钥提交到仓库。
@@ -1,49 +1,54 @@
1
1
  {
2
2
  "manifest": {
3
- "manifestVersion": 2,
3
+ "manifestVersion": 3,
4
4
  "id": "local.js",
5
5
  "name": "js",
6
6
  "version": "0.1.0",
7
- "description": "A Ceru Music v2 vue plugin",
7
+ "description": "A Ceru Music v3 vue plugin",
8
+ "dataSchemas": {
9
+ "config": 1,
10
+ "state": 1
11
+ },
8
12
  "engines": {
9
- "hostApi": "^2.0.0",
10
- "logicRuntime": "ceru-js@1",
11
- "uiSchema": "^1.0.0"
13
+ "hostApi": "^3.0.0",
14
+ "logicRuntime": "ceru-js@1"
12
15
  },
13
- "modules": {
16
+ "entry": {
14
17
  "logic": {
15
- "entry": "logic.main",
16
- "activation": ["onCommand:hello"]
18
+ "activation": [
19
+ "onCommand:hello"
20
+ ],
21
+ "module": "logic.main"
17
22
  },
18
- "surfaces": [
23
+ "views": [
19
24
  {
20
25
  "id": "page",
21
26
  "kind": "web",
22
- "entry": "view.main"
27
+ "module": "view.main"
23
28
  }
24
29
  ]
25
30
  },
26
- "contributes": {
27
- "commands": [
31
+ "provides": {
32
+ "actions": [
28
33
  {
29
34
  "id": "hello",
30
- "title": "Hello",
31
- "action": "hello"
35
+ "title": "Hello"
32
36
  }
33
- ],
34
- "sidebarItems": [
37
+ ]
38
+ },
39
+ "uses": {
40
+ "permissions": []
41
+ },
42
+ "ui": {
43
+ "pages": [
35
44
  {
36
45
  "id": "page",
37
46
  "group": "library",
38
47
  "title": "js",
39
- "view": "page"
48
+ "view": "page",
49
+ "mount": "sidebar"
40
50
  }
41
51
  ]
42
- },
43
- "permissions": [],
44
- "dataSchemas": {
45
- "config": 1,
46
- "state": 1
47
52
  }
48
53
  },
49
54
  "entries": {
@@ -6,17 +6,17 @@
6
6
  "scripts": {
7
7
  "dev": "ceru-plugin dev",
8
8
  "build": "ceru-plugin build",
9
- "typecheck": "tsc --noEmit",
9
+ "typecheck": "ceru-plugin typecheck",
10
10
  "validate": "ceru-plugin validate dist/plugin.js",
11
- "preview": "ceru-plugin preview dist/plugin.js"
11
+ "preview": "ceru-plugin preview dist/plugin.js",
12
+ "check:compat": "ceru-plugin check-compat"
12
13
  },
13
14
  "dependencies": {
14
- "@shiqianjiang/ceru-plugin-sdk": "^0.3.16"
15
+ "@shiqianjiang/ceru-plugin-sdk": "^3.0.0"
15
16
  },
16
17
  "devDependencies": {
17
- "@shiqianjiang/ceru-plugin-cli": "^0.3.16",
18
+ "@shiqianjiang/ceru-plugin-cli": "^3.0.0",
18
19
  "typescript": "~5.9.3",
19
- "electron": "^44.4.2",
20
20
  "prettier": "^3.6.2",
21
21
  "vue": "3.5.43"
22
22
  }
@@ -2,6 +2,6 @@ import { definePlugin } from '@shiqianjiang/ceru-plugin-sdk'
2
2
 
3
3
  export default definePlugin(async (ctx) => {
4
4
  ctx.actions.register('hello', async () => {
5
- await ctx.ui.notify({ key: 'hello', level: 'info', message: 'Hello Ceru v2!' })
5
+ await ctx.ui.notify({ key: 'hello', level: 'info', message: 'Hello Ceru v3!' })
6
6
  })
7
7
  })
@@ -2,35 +2,18 @@
2
2
  "version": "0.2.0",
3
3
  "configurations": [
4
4
  {
5
- "name": "Launch Ceru plugin",
6
- "type": "pwa-chrome",
7
- "request": "attach",
8
- "port": 9223,
9
- "preLaunchTask": "Ceru: dev",
10
- "webRoot": "${workspaceFolder}",
11
- "sourceMaps": true,
12
- "sourceMapPathOverrides": {
13
- "ceru:///*": "${workspaceFolder}/*"
14
- },
15
- "skipFiles": ["**/node_modules/**"],
16
- "address": "127.0.0.1",
17
- "urlFilter": "http://127.0.0.1:4179/",
18
- "timeout": 30000
19
- },
20
- {
21
- "name": "Attach to Ceru plugin",
22
- "type": "pwa-chrome",
23
- "request": "attach",
24
- "port": 9223,
25
- "webRoot": "${workspaceFolder}",
26
- "sourceMaps": true,
27
- "sourceMapPathOverrides": {
28
- "ceru:///*": "${workspaceFolder}/*"
29
- },
30
- "skipFiles": ["**/node_modules/**"],
31
- "address": "127.0.0.1",
32
- "urlFilter": "http://127.0.0.1:4179/",
33
- "timeout": 30000
5
+ "name": "Watch Ceru plugin",
6
+ "type": "node",
7
+ "request": "launch",
8
+ "program": "${workspaceFolder}/node_modules/@shiqianjiang/ceru-plugin-cli/dist/bin.js",
9
+ "args": [
10
+ "dev"
11
+ ],
12
+ "cwd": "${workspaceFolder}",
13
+ "console": "integratedTerminal",
14
+ "skipFiles": [
15
+ "<node_internals>/**"
16
+ ]
34
17
  }
35
18
  ]
36
19
  }
@@ -14,14 +14,13 @@
14
14
  "background": {
15
15
  "activeOnStart": true,
16
16
  "beginsPattern": "^.*$",
17
- "endsPattern": "^CERU_DEBUG_READY "
17
+ "endsPattern": "^CERU_BUILD_READY "
18
18
  }
19
19
  },
20
20
  "command": "node",
21
21
  "args": [
22
22
  "${workspaceFolder}/node_modules/@shiqianjiang/ceru-plugin-cli/dist/bin.js",
23
- "dev",
24
- "--ensure-running"
23
+ "dev"
25
24
  ],
26
25
  "options": {
27
26
  "cwd": "${workspaceFolder}"
@@ -1,22 +1,22 @@
1
1
  # vue / ts
2
2
 
3
- Ceru Music v2 插件开发模板。此目录是源码,不是安装包。
3
+ Ceru Music v3 插件开发模板。此目录是源码,不是安装包。
4
4
 
5
5
  ## 运行 demo
6
6
 
7
- 1. 使用脚手架创建工程:
7
+ 1. 使用匹配的 v3 脚手架创建工程(本地开发套件可使用其 `npm run create` 命令):
8
8
 
9
- npm create ceru-plugin@latest my-plugin -- --template vue --lang ts
9
+ ceru-plugin init my-plugin --template vue --lang ts
10
10
 
11
11
  2. 进入目录,运行 npm install。
12
- 3. 运行 npm run dev,打开独立 Electron 调试工作台。
12
+ 3. 运行 npm run dev,在澜音「设置 → 插件管理 → 管理设置 → 插件开发者模式」添加终端打印的 JS 文件。
13
13
  4. 修改 src 中的代码;保存后自动类型检查并重载。
14
14
  5. 运行 npm run build,只分发 dist/plugin.js。
15
15
 
16
16
  ## 编辑器
17
17
 
18
- VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to Ceru plugin。
19
- 激活代码已经执行时,可点击“重新运行”再次命中断点。
18
+ VS Code 按 F5 选择 Watch Ceru plugin,会启动本地构建监听,不会另开 Electron。
19
+ 已在终端运行 npm run dev 时不必再按 F5。
20
20
  配置文件有 JSON Schema 提示,SDK 提供参数类型、图标名称与 Lodash 方法补全。
21
21
 
22
22
  ## 宿主资源
@@ -26,16 +26,16 @@ VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to
26
26
  - 默认封面:await ctx.assets.url('placeholder.cover')。
27
27
  - 共享工具:ctx.utils.lodash。
28
28
 
29
- Vue/React 的生产运行代码、页面和样式直接编入发行 JS,宿主不提供框架。
29
+ 视图是否自带框架由清单的 `entry.views[].kind` 决定:`web` 页面打包自己用到的框架;`native` 由宿主绘制;`component` 复用宿主提供的 Vue、TDesign 和音乐组件。开发宿主风格的页面可选 `page-extension` 模板,播放器区域可选 `player-skin`,不需要复制桌面组件源码。
30
30
  TypeScript、Vue 编译器、构建工具与开发服务器不会进入产物。
31
- 运行 npm run preview 可只加载 dist/plugin.js 检查发布后的行为。
31
+ 运行 `npm run typecheck` 只检查工程,不生成发行文件。可选 `npm run preview` 验证构建产物并打印路径;将该文件加入桌面的插件开发者模式即可预览,不会启动服务器。
32
32
 
33
33
  若 VS Code 打开的是父目录,请打开本工程的 ceru-plugin.code-workspace,
34
- 再在“运行和调试”中选择 Launch Ceru plugin;已经运行 npm/pnpm dev 时选择 Attach to Ceru plugin。
34
+ 再在“运行和调试”中选择 Watch Ceru plugin。
35
35
  F5 执行当前下拉框中的配置,不会自动选择终端所在的子工程。
36
36
 
37
37
  ## 边界
38
38
 
39
- 本模板面向 v2 协议。开发工作台不是当前 v1 桌面 Host 的兼容层。
39
+ 本模板面向 v3 协议。需要支持 v3 的宿主。
40
40
  凭据保险箱、完整音乐业务和 Guest 安装需要正式 Host;不支持的调试调用会明确报错。
41
41
  不要把私人 API Key、卡密或发行私钥提交到仓库。