@dsh-workbench/shared 1.1.0 → 1.1.2

package/src/host/market-index.ts

@@ -32,7 +32,10 @@ export const MARKET_INDEX_README_LINES: readonly string[] = [
   'dsh-wb-module release --index <本仓库地址> --index-policy artifacts-in-repo',
   '```',
   '',
-  '产物会提交到 `packages/<unit>/`，并更新 `market.json`。',
+  '产物会提交到 `packages/<包名>/`（带 scope 时是 `packages/@scope/名字/`），并更新 `market.json`。',
+  '',
+  '一个包名归第一次发布的人（`market.json` 里的 `owner`）。换一个署名发同名会被拒；要换人，先把这一条的 `owner` 改成新的人。',
+  '同一个市场里，一个模块 id（`metadata.unit`）只能被一个条目使用；另一个包名想用同一个 id / 产物目录也会被拒。',
   '',
   '## 使用这个索引',
   '',
@@ -152,9 +155,20 @@ function iconProblem(icon: string): MarketIndexProblem | undefined {
   return problem('icon', 'icon 只能是 base64 data URL 或 http(s) URL');
 }
 
+const MAX_OWNER_CHARS = 200;
+const UNIT_ID = /^[a-z][a-z0-9-]*$/;
+
+function ownerProblem(owner: string): MarketIndexProblem | undefined {
+  if (/[\r\n]/u.test(owner)) return problem('owner', 'owner 只能是一行署名');
+  if (owner.length > MAX_OWNER_CHARS) return problem('owner', 'owner 超过 200 字');
+  return undefined;
+}
+
 function metadataOf(raw: unknown): MarketIndexEntry['metadata'] {
   const record = asRecord(raw);
   if (record === undefined) return undefined;
+  const workbench = record['workbench'] === true;
+  const unit = asText(record['unit']);
   const category = asText(record['category']);
   const labels = asTextArray(record['labels']);
   const keywords = asTextArray(record['keywords']);
@@ -168,6 +182,8 @@ function metadataOf(raw: unknown): MarketIndexEntry['metadata'] {
           ),
         );
   return {
+    ...(workbench ? { workbench: true } : {}),
+    ...(unit === '' ? {} : { unit }),
     ...(category === '' ? {} : { category }),
     ...(labels.length === 0 ? {} : { labels }),
     ...(keywords.length === 0 ? {} : { keywords }),
@@ -192,14 +208,23 @@ function entryOf(raw: unknown, at: string): MarketIndexEntry | MarketIndexProble
   const title = asLocalized(record['title']);
   const description = asLocalized(record['description']);
   const author = asText(record['author']);
+  const owner = asText(record['owner']);
+  if (owner !== '') {
+    const badOwner = ownerProblem(owner);
+    if (badOwner !== undefined) return badOwner;
+  }
   const homepage = asText(record['homepage']);
   const metadata = metadataOf(record['metadata']);
+  if (metadata?.unit !== undefined && !UNIT_ID.test(metadata.unit)) {
+    return problem('unit', `metadata.unit 只能是小写字母开头的 a-z0-9-（现在是 ${JSON.stringify(metadata.unit)}）`, at);
+  }
   return {
     name,
     versions,
     ...(title === undefined ? {} : { title }),
     ...(description === undefined ? {} : { description }),
     ...(author === '' ? {} : { author }),
+    ...(owner === '' ? {} : { owner }),
     ...(homepage === '' ? {} : { homepage }),
     ...(icon === '' ? {} : { icon }),
     ...(metadata === undefined ? {} : { metadata }),
@@ -272,8 +297,14 @@ export function upsertMarketEntry(index: MarketIndex, entry: MarketIndexEntry):
   const merged = new Map<string, MarketIndexVersion>();
   for (const one of current.versions) merged.set(one.version, one);
   for (const one of entry.versions) merged.set(one.version, one);
+  const owner = current.owner ?? entry.owner;
   const plugins = [...index.plugins];
-  plugins[found] = { ...current, ...entry, versions: sortMarketVersions([...merged.values()]) };
+  plugins[found] = {
+    ...current,
+    ...entry,
+    ...(owner === undefined ? {} : { owner }),
+    versions: sortMarketVersions([...merged.values()]),
+  };
   return { ...index, plugins };
 }
 

package/src/host.ts

@@ -72,4 +72,5 @@ export * from './host/extension.js';
 export * from './host/port-types.js';
 export * from './host/version-range.js';
 export * from './host/market-index.js';
+export * from './host/market-index-claim.js';
 export * from './host/changelog.js';

package/src/i18n/en.ts

@@ -299,12 +299,19 @@ export const en: Record<keyof WorkbenchMessages, string> = {
   'panels.discover.addingSource': 'Adding…',
   'panels.discover.addFirstSource': 'Add index source',
   'panels.discover.removeSource': 'Remove',
-  'panels.discover.removeSourceNamed': 'Remove {url}',
-  'panels.discover.useSource': 'Use',
-  'panels.discover.useSourceNamed': 'Use {label}',
-  'panels.discover.sourceCurrent': 'In use',
+  'panels.discover.removeTitle': 'Remove this index source?',
+  'panels.discover.removeBody': '"{label}" will be removed from this list; the repository itself is not deleted, and you can add it back later.',
+  'panels.discover.sourceActions': 'Actions for {label}',
+  'panels.discover.sourceStateWritable': 'Publish target',
+  'panels.discover.sourceStateReadOnly': 'Read-only list',
+  'panels.discover.sourceEnable': 'Set up for publishing',
+  'panels.discover.sourceDisable': 'Set to read-only',
+  'panels.discover.sourceWorking': 'Updating…',
+  'panels.discover.sourceEnabled': '"{label}" is ready for publishing',
+  'panels.discover.sourceReadOnly': '"{label}" is now read-only',
   'panels.discover.refresh': 'Refresh',
   'panels.discover.search': 'Search modules',
+  'panels.discover.clearSearch': 'Clear search',
   'panels.discover.all': 'All',
   'panels.discover.sourceLabel': 'Name',
   'panels.discover.sourceKind': 'Type',
@@ -328,7 +335,7 @@ export const en: Record<keyof WorkbenchMessages, string> = {
   'panels.discover.missingIndex': 'This repository has no {path} yet.',
   'panels.discover.initTitle': 'Initialize this repository as a module market index?',
   'panels.discover.initCta': 'Initialize market index',
-  'panels.discover.initWhat': 'It will write market.json and README.md on {branch}, commit once, and push. Modules you publish from this workbench will commit their build files under packages/<unit>/. The repository stays owned by its owner.',
+  'panels.discover.initWhat': 'It will write market.json and README.md on {branch}, commit once, and push. Modules you publish from this workbench will commit their build files under packages/<package-name>/. The repository stays owned by its owner.',
   'panels.discover.initBranch': 'Branch',
   'panels.discover.initBranchHint': 'The index and build files go to this branch; an empty repository gets it created.',
   'panels.discover.initBranchBad': 'Use only letters, digits, dots, underscores, slashes, or dashes in a branch name.',
@@ -646,6 +653,13 @@ export const en: Record<keyof WorkbenchMessages, string> = {
   'approval.publish.version': 'Version',
   'approval.publish.author': 'Author',
   'approval.publish.authorMissing': 'unsigned',
+  'approval.publish.owner': 'Owner',
+  'approval.publish.ownerUnowned': 'originally unattributed',
+  'approval.publish.ownerTaken': 'Owned by {owner}',
+  'approval.publish.unit': 'Module id',
+  'approval.publish.unitTaken': 'Taken by {entry}',
+  'approval.publish.path': 'Artifact dir',
+  'approval.publish.pathTaken': 'Taken by {entry}',
   'approval.publish.registry': 'Registry',
   'approval.publish.repo': 'Repository',
   'approval.publish.branch': 'Branch',
@@ -656,6 +670,7 @@ export const en: Record<keyof WorkbenchMessages, string> = {
   'approval.publish.twoCommits': 'build files + market.json in 2 commits, one push',
   'approval.publish.reading': 'Reading…',
   'approval.publish.changelog': 'Changelog for {version}',
+  'approval.publish.changelogPending': 'This release writes the {version} changelog entry',
   'approval.publish.changelogMissing': 'No changelog entry for {version}; publishing will be blocked',
   'approval.publish.targetAuto': 'configured default',
   'approval.publish.targetTeam': 'team registry',
@@ -664,6 +679,15 @@ export const en: Record<keyof WorkbenchMessages, string> = {
   'approval.publish.targetGit': 'git repository',
   'approval.publish.targetMarket': 'module market index',
   'approval.publish.targetLocal': 'keep local',
+  'approval.market.source': 'Index source',
+  'approval.market.url': 'URL',
+  'approval.market.action': 'This action',
+  'approval.market.policy': 'Current state',
+  'approval.market.enable': 'make it publishable',
+  'approval.market.disable': 'make it read-only',
+  'approval.market.writable': 'publishable',
+  'approval.market.readOnly': 'read-only module list',
+  'approval.market.reading': 'Reading…',
   'markdown.copy': 'Copy',
   'markdown.copied': 'Copied',
   'markdown.footnotes': 'Footnotes',

package/src/i18n/zh.ts

@@ -296,12 +296,19 @@ export const zh = {
   'panels.discover.addingSource': '正在添加…',
   'panels.discover.addFirstSource': '添加索引源',
   'panels.discover.removeSource': '移除',
-  'panels.discover.removeSourceNamed': '移除 {url}',
-  'panels.discover.useSource': '使用',
-  'panels.discover.useSourceNamed': '使用 {label}',
-  'panels.discover.sourceCurrent': '当前使用',
+  'panels.discover.removeTitle': '移除这个索引源？',
+  'panels.discover.removeBody': '会把「{label}」从这份列表里移除；仓库本身不会被删，之后还能再添加。',
+  'panels.discover.sourceActions': '「{label}」的操作',
+  'panels.discover.sourceStateWritable': '可发布',
+  'panels.discover.sourceStateReadOnly': '仅读取模块列表',
+  'panels.discover.sourceEnable': '设为可发布',
+  'panels.discover.sourceDisable': '设为只读',
+  'panels.discover.sourceWorking': '设置中…',
+  'panels.discover.sourceEnabled': '已把「{label}」设为可发布',
+  'panels.discover.sourceReadOnly': '已把「{label}」设为只读',
   'panels.discover.refresh': '刷新',
   'panels.discover.search': '搜索模块',
+  'panels.discover.clearSearch': '清除搜索',
   'panels.discover.all': '全部',
   'panels.discover.sourceLabel': '名字',
   'panels.discover.sourceKind': '类型',
@@ -325,7 +332,7 @@ export const zh = {
   'panels.discover.missingIndex': '仓库里还没有索引文件 {path}',
   'panels.discover.initTitle': '把这个仓库初始化成模块市场索引？',
   'panels.discover.initCta': '初始化成市场索引',
-  'panels.discover.initWhat': '会在 {branch} 分支写 market.json 与 README.md，提交一次并推上去；之后从这个工作台发布的模块会把打包好的文件提交到 packages/<unit>/。仓库的写权限归它的所有者。',
+  'panels.discover.initWhat': '会在 {branch} 分支写 market.json 与 README.md，提交一次并推上去；之后从这个工作台发布的模块会把打包好的文件提交到按包名分的 packages/<包名>/。仓库的写权限归它的所有者。',
   'panels.discover.initBranch': '分支',
   'panels.discover.initBranchHint': '索引和打包文件都发到这个分支；空仓库会新建它。',
   'panels.discover.initBranchBad': '分支名只能用字母、数字、点、下划线、斜杠或短横线',
@@ -641,6 +648,13 @@ export const zh = {
   'approval.publish.version': '版本',
   'approval.publish.author': '作者',
   'approval.publish.authorMissing': '未署名',
+  'approval.publish.owner': '认领人',
+  'approval.publish.ownerUnowned': '原来没署名',
+  'approval.publish.ownerTaken': '已有主人：{owner}',
+  'approval.publish.unit': '模块 id',
+  'approval.publish.unitTaken': '已被 {entry} 占用',
+  'approval.publish.path': '产物目录',
+  'approval.publish.pathTaken': '已被 {entry} 占用',
   'approval.publish.registry': '源',
   'approval.publish.repo': '仓库',
   'approval.publish.branch': '分支',
@@ -651,6 +665,7 @@ export const zh = {
   'approval.publish.twoCommits': '打包文件 + market.json 两次提交，一次推送',
   'approval.publish.reading': '读取中…',
   'approval.publish.changelog': '{version} 的更新日志',
+  'approval.publish.changelogPending': '{version} 这一版会写进更新日志，随包发布',
   'approval.publish.changelogMissing': '这一版还没有更新日志（{version}），发布会被拦下',
   'approval.publish.targetAuto': '按配置默认',
   'approval.publish.targetTeam': '团队源',
@@ -659,6 +674,15 @@ export const zh = {
   'approval.publish.targetGit': 'git 仓库',
   'approval.publish.targetMarket': '模块市场索引',
   'approval.publish.targetLocal': '留在本机',
+  'approval.market.source': '索引源',
+  'approval.market.url': '地址',
+  'approval.market.action': '这次操作',
+  'approval.market.policy': '当前状态',
+  'approval.market.enable': '设为可发布',
+  'approval.market.disable': '改回只读',
+  'approval.market.writable': '可发布',
+  'approval.market.readOnly': '仅读取模块列表',
+  'approval.market.reading': '正在读取…',
   'markdown.copy': '复制',
   'markdown.copied': '已复制',
   'markdown.footnotes': '脚注',

package/src/testing/__tests__/declaration.test.ts

@@ -34,7 +34,8 @@ describe('模块作者写用例时读自己那份声明', () => {
 
     expect(manifest.id).toBe('demo');
     expect(manifest.title).toEqual({ zh: '演示', en: 'Demo' });
-    expect(manifest.card).toEqual({ titleKey: unitTitleKey('demo'), order: 7 });
+    expect(manifest.titleKey).toBe(unitTitleKey('demo'));
+    expect(manifest.card).toEqual({ order: 7 });
     expect(manifest.tools).toEqual([{ name: 'workbench_demo_list', writes: false }]);
   });
 

package/src/testing/needs.ts

@@ -10,6 +10,7 @@ import type {
 import type { NeedState } from '../contract/unit-capability.js';
 import type { UnitCapability } from '../contract/unit-capability.js';
 import type { UnitManifest } from '../contract/unit.js';
+import { unitTitleKey } from '../contract/unit.js';
 
 export const fakeNpmSource: SupplySource = {
   kind: 'npm',
@@ -47,9 +48,11 @@ export function manifestOf(
     readonly card?: UnitManifest['card'];
   } = {},
 ): UnitManifest {
+  const id = options.id ?? 'fixture';
   return {
-    id: options.id ?? 'fixture',
-    card: options.card === undefined ? { titleKey: `${options.id ?? 'fixture'}.mine`, order: 10 } : options.card,
+    id,
+    titleKey: unitTitleKey(id),
+    card: options.card === undefined ? { order: 10 } : options.card,
     tools: [],
     host: { inject: [] },
     ...(options.needs === undefined ? {} : { needs: options.needs }),