mirror of
https://github.com/stablyai/orca.git
synced 2026-10-07 16:02:29 +00:00
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.
This commit is contained in:
@@ -592,9 +592,9 @@ describe('GitHub GraphQL rate-limit guard', () => {
|
||||
})
|
||||
|
||||
it.each([
|
||||
{ stackShape: 'omits stack', stackField: {} },
|
||||
{ stackShape: 'sets stack to null', stackField: { stack: null } }
|
||||
])('keeps legacy merge when an ordinary GitHub response $stackShape', async (scenario) => {
|
||||
{ stackVariant: 'omits stack', stackField: {} },
|
||||
{ stackVariant: 'sets stack to null', stackField: { stack: null } }
|
||||
])('keeps legacy merge when an ordinary GitHub response $stackVariant', async (scenario) => {
|
||||
ghExecFileAsyncMock
|
||||
.mockResolvedValueOnce({
|
||||
stdout: JSON.stringify({
|
||||
|
||||
@@ -164,7 +164,7 @@ function primeGitExecForDefaultBranch({
|
||||
})
|
||||
}
|
||||
|
||||
type RestPRShape = {
|
||||
type RestPROverrides = {
|
||||
number?: number
|
||||
state?: string
|
||||
merged_at?: string | null
|
||||
@@ -178,7 +178,7 @@ function restPR({
|
||||
merged_at = null,
|
||||
head_ref = 'master',
|
||||
head_sha = 'stale-master-oid'
|
||||
}: RestPRShape = {}): Record<string, unknown> {
|
||||
}: RestPROverrides = {}): Record<string, unknown> {
|
||||
return {
|
||||
number,
|
||||
title: 'Historical PR',
|
||||
|
||||
@@ -17,7 +17,7 @@ import {
|
||||
classifyProjectError,
|
||||
driftError,
|
||||
rateLimitedError,
|
||||
type GhGraphqlErrorShape
|
||||
type GhGraphqlError
|
||||
} from './project-error-classification'
|
||||
|
||||
export {
|
||||
@@ -172,7 +172,7 @@ export async function runGraphql<T>(
|
||||
...(exec?.host ? { host: exec.host } : {})
|
||||
})
|
||||
try {
|
||||
const parsed = JSON.parse(stdout) as { data?: T; errors?: GhGraphqlErrorShape[] }
|
||||
const parsed: { data?: T; errors?: GhGraphqlError[] } = JSON.parse(stdout)
|
||||
if (parsed.errors && parsed.errors.length > 0) {
|
||||
return {
|
||||
ok: false,
|
||||
|
||||
@@ -4,14 +4,14 @@
|
||||
import type { GitHubProjectViewError } from '../../../shared/github/project-result-types'
|
||||
import { githubProjectHost } from '../../../shared/github/project-identity'
|
||||
|
||||
export type GhGraphqlErrorShape = {
|
||||
export type GhGraphqlError = {
|
||||
type?: string
|
||||
message?: string
|
||||
path?: (string | number)[]
|
||||
extensions?: { code?: string }
|
||||
}
|
||||
|
||||
export function extractGraphqlErrors(stderr: string, stdout: string): GhGraphqlErrorShape[] {
|
||||
export function extractGraphqlErrors(stderr: string, stdout: string): GhGraphqlError[] {
|
||||
// `gh api graphql` prints the response JSON to stdout even on GraphQL
|
||||
// errors, and the stderr carries a summary. Try stdout first; if parsing
|
||||
// fails, fall back to stderr.
|
||||
@@ -21,7 +21,7 @@ export function extractGraphqlErrors(stderr: string, stdout: string): GhGraphqlE
|
||||
continue
|
||||
}
|
||||
try {
|
||||
const parsed = JSON.parse(src) as { errors?: GhGraphqlErrorShape[] }
|
||||
const parsed: { errors?: GhGraphqlError[] } = JSON.parse(src)
|
||||
if (parsed.errors && parsed.errors.length > 0) {
|
||||
return parsed.errors
|
||||
}
|
||||
@@ -32,7 +32,7 @@ export function extractGraphqlErrors(stderr: string, stdout: string): GhGraphqlE
|
||||
return []
|
||||
}
|
||||
|
||||
export function errorsIndicateParentField(errors: GhGraphqlErrorShape[], stderr: string): boolean {
|
||||
export function errorsIndicateParentField(errors: GhGraphqlError[], stderr: string): boolean {
|
||||
const lower = stderr.toLowerCase()
|
||||
// Preview-header shape: gh returns a 4xx with "preview" in the message.
|
||||
if (lower.includes('preview') && lower.includes('parent')) {
|
||||
|
||||
@@ -14,7 +14,7 @@ import {
|
||||
classifyProjectError,
|
||||
driftError,
|
||||
rateLimitedError,
|
||||
type GhGraphqlErrorShape
|
||||
type GhGraphqlError
|
||||
} from './project-error-classification'
|
||||
import { ownerQueryRoot } from './project-view-config'
|
||||
import type { RawItem } from './project-view-item-normalization'
|
||||
@@ -47,7 +47,7 @@ export async function fetchItemsPageWithRaw(args: {
|
||||
| {
|
||||
ok: false
|
||||
error: GitHubProjectViewError
|
||||
rawErrors: GhGraphqlErrorShape[]
|
||||
rawErrors: GhGraphqlError[]
|
||||
stderr: string
|
||||
}
|
||||
> {
|
||||
@@ -117,7 +117,7 @@ export async function fetchItemsPageWithRaw(args: {
|
||||
stdout = extracted.stdout
|
||||
execFailed = true
|
||||
}
|
||||
let parsed: { data?: Record<string, unknown>; errors?: GhGraphqlErrorShape[] } = {}
|
||||
let parsed: { data?: Record<string, unknown>; errors?: GhGraphqlError[] } = {}
|
||||
try {
|
||||
parsed = JSON.parse(stdout)
|
||||
} catch {
|
||||
|
||||
Reference in New Issue
Block a user