Files
orca/config/scripts/tool-preview-whitespace-benchmark.mjs
T
Neil 231e805b1e fix(lint): enable anti-slop/no-shape-in-symbol-names (#20785)
Flip `anti-slop/no-shape-in-symbol-names` from "off" to "error" and clear
every violation under src, config, tests and mobile.

What the rule bans
------------------
The case-insensitive substring "shape" in any JS/TS identifier: variables,
functions, parameters, types, type parameters, class members, private names,
object-literal keys and JSX identifiers. The one exemption is a statically
accessed member read owned by another value (`zodObject.shape` is fine), so
third-party APIs stay readable without a suppression.

"Shape" names a value's structure rather than its domain role. `UserShape`,
`validateArgShape` and `errorShape` all tell you the symbol is "an object
with some fields" -- which is already what a type says -- while saying
nothing about what the value is for or who owns it. The rule forces the
name to carry the domain instead.

Violations fixed
----------------
689 violations across 109 files at baseline (verified by re-running the
audit against the pre-change tree with the rule set to "error").

Fix pattern
-----------
Rename for the domain role, not the structure:

  -type FieldShape = 'list' | 'map' | 'whole'
  -const FIELD_SHAPES = { ... } satisfies Record<keyof Observation, FieldShape>
  +type FieldEncoding = 'list' | 'map' | 'whole'
  +const FIELD_ENCODINGS = { ... } satisfies Record<keyof Observation, FieldEncoding>

  -function assertGitPushTargetShape(target: unknown): void
  +function assertValidGitPushTarget(target: unknown): void

  -function describeReadDirPathShape(p: string): ReadDirPathKind
  +function classifyReadDirPath(p: string): ReadDirPathKind

Predicates became statements about the value (`isDeltaShapedProviderFrameKind`
-> `isDeltaProviderFrameKind`, `isDeleteShapedDiscardEntry` ->
`discardDeletesEntryFile`, `isSkillsCliAgentKeyShaped` ->
`isUsableSkillsCliAgentKey`). Type aliases dropped the suffix where the
remaining name was already unambiguous (`GhGraphqlErrorShape` ->
`GhGraphqlError`).

No wire-visible name was renamed: no IPC or RPC channel, stream opcode,
request/response param, persisted field, or i18n key. The `--shape=symlink|copy`
CLI flag read by .github/workflows/skill-update-roundtrip.yml is unchanged --
only the local variable holding it was renamed.

Exemptions
----------
They are file-scoped entries in config/oxlint-anti-slop.json, not inline
`oxlint-disable` comments. An inline directive naming an anti-slop rule reads
back as an UNUSED directive under the root lint scan, which does not load this
plugin -- the changed-code quality gate counts that warning, so the comment form
cannot be used for a rule that lives only in this config.

* src/renderer/src/components/browser-pane/annotate/**:
  in the screenshot annotator a "shape" is the drawn geometry -- pen, arrow,
  rect, ellipse, highlight. That is a genuine domain noun, and it pervades
  every symbol in the module.
* repo-icon.tsx, repo-header-project-actions.tsx, mobile MobileRepoIcon.tsx:
  lucide exports the icon component as `Shapes`. The name is theirs, and the
  matching REPO_LUCIDE_ICONS key is the persisted icon name shared with the
  desktop picker -- renaming it would orphan saved repo icons.
* src/shared/onboarding-state-types.ts, src/shared/constants.ts:
  `shapedSidebar` is a persisted onboarding-checklist field and a telemetry
  enum member; renaming it would orphan saved state.
* src/shared/rpc-contract/rpc-send-params.ts: matching zod's own literal `shape`
  property is what selects the ZodObject branch of the conditional type.

No exemption was added merely to avoid a rename. Eight symbols initially
suppressed as "a cross-module refactor outside this change" were proven to have
zero non-TypeScript references repo-wide and renamed instead.

Zod's `ZodRawShape` needed no exemption at all: `Readonly<Record<string,
z.ZodType>>` is its definition, so repo-update-params.ts and
ui-update-value-tolerance-params.ts spell it out instead. Likewise
telemetry-event-classification.ts now reads `.shape` through an `in` narrowing,
which also retires two pre-existing type assertions; three more assertions the
rename had dragged onto changed lines (two `JSON.parse` sites, one node:sqlite
row read) became annotations and an explicit row mapping.

Verified
--------
* Audit reports zero violations; confirmed the rule genuinely fires by
  planting a probe violation.
* node config/scripts/run-typecheck-projects-in-parallel.mjs exits 0.
* Vitest over src/shared, src/main/github/project-view, the annotate module,
  the repo-icon components and the Chromium SameSite electron spec: all green.
* All 66 removed "shape" identifiers grepped repo-wide across every file type;
  none survive.
* node config/scripts/generate-rpc-params-catalog.mjs --check exits 0.
* node --check on every changed .mjs; oxfmt clean on all changed files.
* `pnpm run check:code-quality:changed` reports 0 findings.

Not machine-verified: the 3 mobile/ files (its Vitest run cannot resolve
`expo/tsconfig.base.json` in this worktree), and the WSL- and Playwright-gated
specs. All are rename- or comment-only hunks, read in full.
2026-09-15 02:00:27 -07:00

115 lines
3.0 KiB
JavaScript

import fs from 'node:fs'
import { execFileSync } from 'node:child_process'
import { dirname, resolve } from 'node:path'
import assert from 'node:assert/strict'
import { build } from 'esbuild'
const file = 'src/shared/native-chat-tool-summary.ts'
const baseline = process.argv[2] ?? '20ab9950654'
const beforeSource = execFileSync('git', ['show', `${baseline}:${file}`], {
encoding: 'utf8',
windowsHide: true
})
const afterSource = fs.readFileSync(file, 'utf8')
async function load(contents) {
const { outputFiles } = await build({
stdin: { contents, loader: 'ts', resolveDir: dirname(resolve(file)) },
bundle: true,
platform: 'node',
format: 'esm',
write: false
})
return import(
`data:text/javascript;base64,${Buffer.from(outputFiles[0].text).toString('base64')}`
)
}
const before = await load(beforeSource),
after = await load(afterSource)
const display = (m, input) => {
const d = m.createToolInputDisplay(input)
return { ...d, formatDetail: d.formatDetail() }
}
let seed = 8121
const random = (max) => {
seed = (Math.imul(seed, 1664525) + 1013904223) >>> 0
return Math.floor((seed / 4294967296) * max)
}
const pieces = [
'a',
'b',
'…',
'😀',
'\ud800',
'\udc00',
'\0',
'\t',
'\r',
'\n',
' ',
'\v',
'\f',
'\u00a0',
'\u1680',
'\u2000',
'\u200a',
'\u2028',
'\u2029',
'\u202f',
'\u205f',
'\u3000',
'\ufeff',
'\u0085',
'\u200b'
]
for (let i = 0; i < 3000; i++) {
const input = Array.from({ length: random(500) }, () => pieces[random(pieces.length)]).join('')
assert.equal(after.summarizeToolInput(input), before.summarizeToolInput(input))
assert.deepEqual(display(after, input), display(before, input))
}
for (const input of [
`${'a'.repeat(79)}…`,
'a'.repeat(80) + ' '.repeat(500),
' '.repeat(100000),
`${'\n'.repeat(100000)}x`,
{ command: 'a '.repeat(50000) },
{ file_path: 'a '.repeat(500) },
{ x: 'a '.repeat(500) },
JSON.stringify({ command: 'a '.repeat(50000) })
]) {
assert.deepEqual(display(after, input), display(before, input))
}
for (const [caseName, input] of [
['tiny', 'ls -la'],
['100KB', 'a b\n\t'.repeat(15000)],
['1MB', 'a b\n\t'.repeat(150000)],
['all-space', ' '.repeat(1000000)],
['leading', `${' '.repeat(1000000)}x`],
['trailing', `x${' '.repeat(1000000)}`],
['long-word', 'x'.repeat(1000000)]
]) {
const samples = { before: [], after: [] }
for (let i = 0; i < 20; i++) {
before.createToolInputDisplay(input)
after.createToolInputDisplay(input)
}
for (let r = 0; r < 8; r++) {
for (const [label, m] of r % 2
? [
['after', after],
['before', before]
]
: [
['before', before],
['after', after]
]) {
global.gc()
const start = process.cpuUsage()
for (let i = 0; i < 20; i++) {
m.createToolInputDisplay(input)
}
const cpu = process.cpuUsage(start)
samples[label].push((cpu.user + cpu.system) / 20000)
}
}
console.log(JSON.stringify({ caseName, samples }))
}