docs(gantt): make QuickFilterBar JSDoc English and point at the bundle keys (#4021) by yinlianghui · Pull Request #4883 · objectstack-ai/objectui

yinlianghui · 2026-08-16T23:42:14Z

改了什么

packages/plugin-gantt/src/QuickFilterBar.tsx 三处中文注释改成纯英文 —— 诫条 #-1 的措辞覆盖 code comments,不止用户可见文案。

模块头 JSDoc(第 10 行)的括注 "快速筛选栏";
QuickFilterLabels 的 all(第 41 行)与 clear(第 43 行)成员注释。

顺带把该 interface 四个成员的注释都指向宿主词条键(卡内建议形态),并给 interface 本身加了一句说明回退行为。

为什么不只是换语言

那两条成员注释里的中文同时也是过期信息:它们引的是宿主曾经硬编码的字面量,而 objectstack#5427 已把四条文案挪进 gantt.quickFilter.* 词条,注释里的引文不再对应任何调用点。所以不是原样翻译,而是改写成"这个 label 由宿主从哪个键取值":

all -- gantt.quickFilter.all
clear -- gantt.quickFilter.clear
empty -- gantt.quickFilter.empty
resultSummary -- gantt.quickFilter.resultSummary(并注明它是单花括号占位符、由调用点 .replace 解析,不是 i18next 插值 —— 这条约定在 useGanttTranslation.ts 与 gantt-quickfilter-locale-parity.test.ts 里都被钉住,objectui#4157 是把它写反的前情)

四个键均先核实存在再落笔:packages/i18n/src/locales/en.ts:871 的 quickFilter 块、packages/plugin-gantt/src/useGanttTranslation.ts:90-102 的独立回退表、调用点 packages/plugin-gantt/src/ObjectGantt.tsx:1417-1423。

interface 头新增的那句(all/clear/empty 回退英文默认值,resultSummary 省略即隐藏 summary)也按实现核过:QuickFilterBar.tsx:288-290 与 :314。

范围

⛔ 未动任何行为代码:diff 纯注释,无代码/类型/字符串变更。
⛔ 未动 QuickFilterBar.test.tsx:40 一带的中文夹具 —— issue 正文已裁明那是被验证的测试数据,是否统一改写由维护者定,不属本单。
本包其余源码文件仍有中文注释(见下"相邻发现"),按"不扩围"另单记录,本 PR 不碰。

验证

注释-only 改动没有任何门可以为它变红,如实记录:仓内没有任何 lint 规则或脚本机械强制诫条 #-1 的英文注释条款(eslint.config.js 与 scripts/ 均无对应规则,这也正是这类残留能长期存在的原因)。因此判据是下面两条正向核验,而不是"改前红、改后绿":

中文字符归零(ripgrep \p{Han},该文件):改前 3 行(10 / 41 / 43),改后 No matches found。
词条键实存:上面四个键的三处落点均已核实,并跑绿了钉住它们的测试。

跑过的命令:

pnpm exec vitest run packages/plugin-gantt/src/QuickFilterBar.test.tsx --maxWorkers=2
  -- Test Files 1 passed (1) / Tests 10 passed (10)

pnpm exec vitest run packages/i18n/src/__tests__/gantt-quickfilter-locale-parity.test.ts \
  packages/plugin-gantt/src/ObjectGantt.quickfilter.i18n.test.tsx \
  packages/plugin-gantt/src/ObjectGantt.quickfilter.i18n.fallback.test.tsx --maxWorkers=2
  -- Test Files 3 passed (3) / Tests 26 passed (26)

pnpm exec turbo run type-check --concurrency=2
  -- Tasks: 81 successful, 81 total

node scripts/check-control-bytes.mjs
  -- OK (scanned 4369 tracked text file(s); skipped 85 binary)

node scripts/check-changeset-presence.mjs
  -- OK,1 changeset,EMPTY frontmatter(该门明文的免除形态)

changeset

按 check-changeset-presence 自身读数处理:packages/plugin-gantt/src/** 在受守面内,故必须声明;而这是零行为变更,用该门明文承认的空 frontmatter 形态声明(.changeset/quickfilterbar-jsdoc-english.md),不发版本。

相邻发现(不扩围)

plugin-gantt 其余源码文件仍有同形中文注释 —— GanttView.tsx(93 行)、ObjectGantt.tsx(51)、shifts.ts(9)、scheduling.ts(8)、ResourceWorkload.tsx(1)、workload.ts(1)。已逐一确认全部位于注释内(JSDoc 括注、行尾注释、JSX 注释块),非测试源码里没有中文运行期字符串,故与本单同属 observation-class。按"别的文件不扩围"另开单记录,不在本 PR 处理。

Generated by Claude Code

…e keys (#4021) Commandment #-1 covers code comments, not just user-facing text. Three lines in `QuickFilterBar.tsx` carried Chinese copy: the module header's parenthetical and the `all` / `clear` members of `QuickFilterLabels`. The Chinese in those two member docs was also stale. It quoted the literals the host used to hardcode; objectstack#5427 moved all four strings into the `gantt.quickFilter.*` bundle namespace, so the quoted copy no longer matched any call site. Each member now names the bundle key `ObjectGantt` resolves it from, and the interface gains a short header stating the fallback behaviour. Comment-only: no code, type, or string changed. Co-authored-by: Claude <noreply@anthropic.com>

github-actions · 2026-08-16T23:43:18Z

✅ Console Performance Budget

Metric	Value	Budget
Main entry (gzip)	24.7 KB	350 KB
Entry file	`index-DW9vXhq4.js`	—
Status	PASS	—

📦 Bundle Size Report

Package	Size	Gzipped
app-shell (index.js)	9.56KB	3.59KB
app-shell (runtime-config.js)	7.42KB	2.32KB
app-shell (types.js)	0.01KB	0.04KB
app-shell (urlParams.js)	8.92KB	3.41KB
auth (AuthContext.js)	0.31KB	0.24KB
auth (AuthGuard.js)	1.17KB	0.53KB
auth (AuthProvider.js)	25.13KB	5.40KB
auth (AuthShell.js)	3.49KB	1.40KB
auth (ForgotPasswordForm.js)	12.21KB	3.45KB
auth (LoginForm.js)	18.13KB	5.39KB
auth (PreviewBanner.js)	0.90KB	0.50KB
auth (RegisterForm.js)	6.64KB	2.21KB
auth (SocialSignInButtons.js)	9.60KB	3.89KB
auth (UserMenu.js)	3.40KB	1.22KB
auth (auth-gate-events.js)	1.29KB	0.66KB
auth (authStyles.js)	5.04KB	1.72KB
auth (createAuthClient.js)	38.46KB	10.17KB
auth (createAuthenticatedFetch.js)	6.34KB	2.43KB
auth (index.js)	2.35KB	1.07KB
auth (org-roles.js)	6.66KB	2.78KB
auth (phone-identifier.js)	1.11KB	0.66KB
auth (types.js)	0.59KB	0.35KB
auth (useAuth.js)	5.02KB	0.88KB
auth (useIsWorkspaceAdmin.js)	1.61KB	0.85KB
collaboration (CommentThread.js)	26.07KB	7.56KB
collaboration (LiveCursors.js)	3.17KB	1.27KB
collaboration (PresenceAvatars.js)	6.49KB	2.64KB
collaboration (PresenceProvider.js)	2.79KB	1.13KB
collaboration (index.js)	1.65KB	0.73KB
collaboration (useCollaborationTranslation.js)	6.05KB	2.52KB
collaboration (useCommentSearch.js)	1.98KB	0.88KB
collaboration (useConflictResolution.js)	7.75KB	1.86KB
collaboration (useMentionNotifications.js)	1.81KB	0.68KB
collaboration (usePresence.js)	6.33KB	1.84KB
collaboration (useRealtimeSubscription.js)	7.91KB	2.01KB
components (index.js)	498.36KB	111.03KB
core (index.js)	3.79KB	1.52KB
create-plugin (index.js)	10.08KB	3.26KB
data-objectstack (index.js)	157.05KB	43.28KB
fields (index.js)	231.73KB	57.60KB
i18n (LocalizationContext.js)	1.76KB	0.96KB
i18n (currency.js)	1.22KB	0.64KB
i18n (i18n.js)	4.28KB	1.75KB
i18n (index.js)	3.35KB	1.38KB
i18n (pickLocalized.js)	3.69KB	1.73KB
i18n (provider.js)	23.12KB	7.62KB
i18n (useDisplayLocale.js)	2.84KB	1.45KB
i18n (useObjectLabel.js)	27.59KB	6.63KB
i18n (useSafeTranslation.js)	7.77KB	3.13KB
layout (index.js)	38.86KB	10.83KB
mobile (MobileProvider.js)	0.92KB	0.49KB
mobile (ResponsiveContainer.js)	0.94KB	0.38KB
mobile (breakpoints.js)	1.51KB	0.70KB
mobile (createOfflineDataSource.js)	5.61KB	1.74KB
mobile (index.js)	1.50KB	0.62KB
mobile (offlineQueue.js)	3.91KB	1.35KB
mobile (pwa.js)	0.97KB	0.49KB
mobile (serviceWorker.js)	1.48KB	0.62KB
mobile (serviceWorkerSource.js)	3.41KB	1.48KB
mobile (useBreakpoint.js)	1.54KB	0.65KB
mobile (useGesture.js)	6.96KB	1.98KB
mobile (useOfflineSync.js)	1.99KB	0.72KB
mobile (usePullToRefresh.js)	2.53KB	0.85KB
mobile (useResponsive.js)	0.71KB	0.42KB
mobile (useResponsiveConfig.js)	1.36KB	0.63KB
mobile (useSpecGesture.js)	4.32KB	1.64KB
mobile (useTouchTarget.js)	1.01KB	0.54KB
permissions (MePermissionsProvider.js)	9.35KB	3.31KB
permissions (PermissionContext.js)	0.31KB	0.25KB
permissions (PermissionGuard.js)	0.89KB	0.45KB
permissions (PermissionProvider.js)	4.42KB	1.42KB
permissions (evaluator.js)	5.12KB	1.74KB
permissions (index.js)	0.91KB	0.41KB
permissions (store.js)	0.91KB	0.42KB
permissions (useFieldPermissions.js)	1.28KB	0.52KB
permissions (usePermissions.js)	1.81KB	0.83KB
plugin-ai (index.js)	15.75KB	3.80KB
plugin-calendar (index.js)	46.62KB	12.83KB
plugin-charts (index.js)	64.75KB	18.37KB
plugin-chatbot (index.js)	181.21KB	43.14KB
plugin-dashboard (index.js)	128.14KB	32.58KB
plugin-designer (index.js)	212.39KB	42.83KB
plugin-detail (index.js)	239.81KB	59.97KB
plugin-editor (index.js)	2.46KB	1.10KB
plugin-form (index.js)	115.34KB	27.74KB
plugin-gantt (index.js)	164.06KB	39.94KB
plugin-grid (index.js)	192.23KB	51.30KB
plugin-kanban (index.js)	52.72KB	14.54KB
plugin-list (index.js)	111.23KB	26.97KB
plugin-map (index.js)	17.91KB	5.72KB
plugin-markdown (index.js)	13.72KB	4.69KB
plugin-report (index.js)	41.70KB	11.19KB
plugin-timeline (index.js)	26.68KB	7.66KB
plugin-tree (index.js)	8.50KB	2.88KB
plugin-view (index.js)	83.81KB	20.49KB
providers (DataSourceProvider.js)	0.75KB	0.39KB
providers (MetadataProvider.js)	1.37KB	0.59KB
providers (ThemeProvider.js)	1.90KB	0.85KB
providers (UploadProvider.js)	11.66KB	3.50KB
providers (index.js)	0.44KB	0.22KB
providers (types.js)	0.01KB	0.04KB
react-runtime (index.js)	5.62KB	2.34KB
react (LazyPluginLoader.js)	3.77KB	1.33KB
react (SchemaRenderer.js)	27.53KB	9.41KB
react (data-invalidation.js)	5.05KB	2.08KB
react (index.js)	1.28KB	0.68KB
react (schema-input.js)	1.45KB	0.83KB
react (spec-input.js)	0.20KB	0.18KB
sdui-parser (codegen.js)	4.09KB	1.74KB
sdui-parser (index.js)	4.47KB	2.03KB
sdui-parser (parse.js)	10.04KB	2.82KB
sdui-parser (types.js)	0.29KB	0.24KB
sdui-parser (validate.js)	4.69KB	1.48KB
types (ai.js)	0.20KB	0.17KB
types (api-types.js)	0.20KB	0.18KB
types (app.js)	2.87KB	0.99KB
types (base.js)	0.20KB	0.18KB
types (blocks.js)	0.20KB	0.18KB
types (complex.js)	0.20KB	0.18KB
types (crud.js)	0.20KB	0.18KB
types (dashboard-filter-alias.js)	6.23KB	2.74KB
types (data-display.js)	0.20KB	0.18KB
types (data-protocol.js)	0.20KB	0.19KB
types (data.js)	0.20KB	0.18KB
types (designer.js)	1.87KB	0.85KB
types (disclosure.js)	0.20KB	0.18KB
types (error-code.js)	1.54KB	0.88KB
types (feedback.js)	0.20KB	0.18KB
types (field-types.js)	0.20KB	0.18KB
types (form.js)	0.20KB	0.18KB
types (http-retry.js)	4.32KB	2.02KB
types (index.js)	3.05KB	1.52KB
types (layout.js)	0.20KB	0.18KB
types (managed-by.js)	0.19KB	0.18KB
types (mobile.js)	2.59KB	1.31KB
types (navigation.js)	0.20KB	0.18KB
types (objectql.js)	0.20KB	0.18KB
types (overlay.js)	0.20KB	0.18KB
types (permissions.js)	0.20KB	0.18KB
types (plugin-scope.js)	0.20KB	0.18KB
types (record-components.js)	0.20KB	0.19KB
types (record-semantics.js)	1.28KB	0.67KB
types (registry.js)	0.20KB	0.18KB
types (reports.js)	0.20KB	0.18KB
types (spec-report.js)	5.05KB	1.93KB
types (system-fields.js)	3.33KB	1.54KB
types (theme.js)	0.20KB	0.18KB
types (ui-action.js)	3.40KB	1.71KB
types (views.js)	0.20KB	0.18KB
types (widget.js)	0.20KB	0.18KB

Size Limits

✅ Core packages should be < 50KB gzipped
✅ Component packages should be < 100KB gzipped
⚠️ Plugin packages should be < 150KB gzipped

yinlianghui · 2026-08-16T23:53:12Z

【PM 验收 · ACCEPT】objectui 分片 PM(session_01GTRjn8xBqp75dk7kFupVRt)对 #4021(XS,Commandment #-1 注释英文化)的实施验收:

实物核验:2 文件,QuickFilterBar.tsx 的 22 行改动非注释行为 0(PM 逐行核),空 frontmatter changeset(门认可形态);测试夹具中文按卡内裁定未动。模型标识 0、releases 0。判据:zh 字符 grep 该文件归零(before 3 行 after 0);四个词条键实存核验带 file:line(en 词条 :871、插件回退表、宿主调用点)+ locale-parity 钉子绿;行为测试 10/10 不变。反向验证如实记「无门可红」且给出成因证据(grep eslint/scripts 零门强制该条款)—— 不假称有门,判据换正向核验,合规。CI 亲读:19 项全 completed(17 success + 2 skipped),零失败。

新 finding #4884(plugin-gantt 其余六文件 163 行中文注释 + 「仓内无门强制该条款」成因)查重合格,留分诊 —— 它同时是「要不要建门」的机制化候选,分诊轮一并定。

处置:undraft + auto-merge(SQUASH)。

Generated by Claude Code

…bjectstack-ai#4884) (objectstack-ai#4888) * docs(gantt): make the remaining plugin-gantt source comments English (objectstack-ai#4884) Commandment #-1 covers code comments, not just user-facing text. The sequel to objectstack-ai#4021 / PR objectstack-ai#4883, which cleared the same package's `QuickFilterBar.tsx`: the six remaining non-test source files carried 163 lines of Chinese in JSDoc, trailing `//` notes and JSX comment blocks. All 163 are now English. Where a comment named a UI label it now points at the `gantt.*` bundle key that actually resolves it, rather than quoting a Chinese literal no call site holds: `gantt.toolbar.saveLayout`, `gantt.toolbar.refresh`, `gantt.menu.removeDependency`, `gantt.menu.addPredecessor` / `addSuccessor`, `gantt.menu.view`, `gantt.column.start` / `end`, `gantt.conflict.confirm` / `cancel`, `gantt.autoScheduleDlg.none`. Same class of staleness PR objectstack-ai#4883 fixed for the quick-filter labels. Two facts corrected to match the code as it stands: - The drag-conflict dialog's comment block sat above the auto-schedule dialog (`pendingAutoSchedule`); the dialog it describes is ~60 lines further down at `pendingConflict`. Moved back over its own JSX. - `ObjectGantt.tsx`'s `timeSegments` JSDoc example used Chinese band labels. The example now uses English labels, matching `ShiftBandConfig.label`'s own doc in `shifts.ts`; the doc states explicitly that `label` is caller-localized display text, which is what the example is illustrating. Also removed one CJK bracket pair that `\p{Han}` does not match, so the package's non-test sources are clean under both a Han scan and a CJK-punctuation scan. Comment-only: every one of the six files is byte-identical after stripping comments with the TypeScript compiler, so no code, type, or string changed. Co-authored-by: Claude <noreply@anthropic.com> * docs(gantt): tighten comment rewrap in GanttView/ObjectGantt (objectstack-ai#4884) Follow-up polish on the same comment-only change, no new translation: - `rescheduleOnConflict` JSDoc lost its sentence-ending period when the Chinese parenthetical was dropped, running two sentences together. - Three comment blocks (the resize grab-zone note, `borderColorField`, `summaryExtent`, and the hidden-native-scrollbar CSS note) had ragged wraps left over from substituting longer English text; reflowed. Still byte-identical after comment stripping on all six files. Co-authored-by: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>

github-actions Bot added the plugin label Aug 16, 2026

yinlianghui mentioned this pull request Aug 16, 2026

[finding] plugin-gantt 其余六个源码文件共 163 行中文注释(诫条 #-1),仓内无任何门机械强制该条款 #4884

Closed

yinlianghui marked this pull request as ready for review August 16, 2026 23:53

yinlianghui added this pull request to the merge queue Aug 16, 2026

Merged via the queue into main with commit 372d9f9 Aug 16, 2026
20 checks passed

yinlianghui deleted the claude/issue-4021-quickfilter-jsdoc-english branch August 16, 2026 23:53

yinlianghui mentioned this pull request Aug 17, 2026

docs(gantt): make the remaining plugin-gantt source comments English (#4884) #4888

Merged

Navigation Menu

Uh oh!

docs(gantt): make QuickFilterBar JSDoc English and point at the bundle keys (#4021) - #4883

docs(gantt): make QuickFilterBar JSDoc English and point at the bundle keys (#4021)#4883
yinlianghui merged 1 commit into
mainfrom
claude/issue-4021-quickfilter-jsdoc-english

yinlianghui commented Aug 16, 2026

Uh oh!

github-actions Bot commented Aug 16, 2026

Uh oh!

yinlianghui commented Aug 16, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

yinlianghui commented Aug 16, 2026

改了什么

为什么不只是换语言

范围

验证

changeset

相邻发现(不扩围)

Uh oh!

github-actions Bot commented Aug 16, 2026

✅ Console Performance Budget

📦 Bundle Size Report

Size Limits

Uh oh!

yinlianghui commented Aug 16, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants