mirror of
https://github.com/stablyai/orca.git
synced 2026-10-30 16:47:34 +00:00
Neil
231e805b1e
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.
73 lines
2.6 KiB
TypeScript
73 lines
2.6 KiB
TypeScript
import { describe, expect, it } from 'vitest'
|
|
import { buildReadDirErrorBreadcrumb, classifyReadDirPath } from './readdir-error-diagnostics'
|
|
|
|
describe('classifyReadDirPath', () => {
|
|
it('classifies a WSL UNC path without leaking it', () => {
|
|
const classification = classifyReadDirPath(
|
|
'\\\\wsl.localhost\\Ubuntu\\home\\u\\repo',
|
|
undefined
|
|
)
|
|
expect(classification).toEqual({ hasConnectionId: false, isUNC: true, isWsl: true })
|
|
})
|
|
|
|
it('classifies the legacy \\\\wsl$ root as WSL', () => {
|
|
expect(classifyReadDirPath('\\\\wsl$\\Ubuntu\\home', undefined).isWsl).toBe(true)
|
|
})
|
|
|
|
it('classifies a plain network UNC share as UNC but not WSL', () => {
|
|
const classification = classifyReadDirPath('\\\\fileserver\\share\\dir', undefined)
|
|
expect(classification).toMatchObject({ isUNC: true, isWsl: false })
|
|
expect(classification.driveLetter).toBeUndefined()
|
|
})
|
|
|
|
it('extracts an uppercased drive letter for mapped drives', () => {
|
|
expect(classifyReadDirPath('z:\\projects\\repo', undefined)).toEqual({
|
|
hasConnectionId: false,
|
|
isUNC: false,
|
|
isWsl: false,
|
|
driveLetter: 'Z'
|
|
})
|
|
})
|
|
|
|
it('flags the SSH connection without recording it', () => {
|
|
const classification = classifyReadDirPath('/remote/repo', 'ssh-1')
|
|
expect(classification).toEqual({ hasConnectionId: true, isUNC: false, isWsl: false })
|
|
})
|
|
|
|
it('never includes the raw path in the classification', () => {
|
|
const classification = classifyReadDirPath('\\\\wsl.localhost\\Ubuntu\\secret\\path', 'ssh-9')
|
|
expect(JSON.stringify(classification)).not.toContain('secret')
|
|
})
|
|
})
|
|
|
|
describe('buildReadDirErrorBreadcrumb', () => {
|
|
it('captures throw site, error code/name, and path classification', () => {
|
|
const breadcrumb = buildReadDirErrorBreadcrumb({
|
|
dirPath: '\\\\wsl.localhost\\Ubuntu\\home\\u\\repo',
|
|
connectionId: undefined,
|
|
throwSite: 'readdir',
|
|
error: Object.assign(new Error('EIO: i/o error'), { code: 'EIO' })
|
|
})
|
|
expect(breadcrumb).toEqual({
|
|
throwSite: 'readdir',
|
|
errorName: 'Error',
|
|
errorCode: 'EIO',
|
|
hasConnectionId: false,
|
|
isUNC: true,
|
|
isWsl: true
|
|
})
|
|
})
|
|
|
|
it('omits errorCode when the error has none', () => {
|
|
const breadcrumb = buildReadDirErrorBreadcrumb({
|
|
dirPath: '/remote/repo',
|
|
connectionId: 'ssh-1',
|
|
throwSite: 'ssh-provider',
|
|
error: new Error('Remote connection dropped.')
|
|
})
|
|
expect(breadcrumb).toMatchObject({ throwSite: 'ssh-provider', errorName: 'Error' })
|
|
expect(breadcrumb.errorCode).toBeUndefined()
|
|
expect(breadcrumb.hasConnectionId).toBe(true)
|
|
})
|
|
})
|