mirror of
https://github.com/stablyai/orca.git
synced 2026-11-01 01:27:35 +00:00
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.
135 lines
4.9 KiB
TypeScript
135 lines
4.9 KiB
TypeScript
import { isUsableSkillsCliAgentKey } from './skills-cli-agent-keys'
|
|
|
|
export const ORCA_SKILLS_REPOSITORY_URL = 'https://github.com/stablyai/orca'
|
|
|
|
export const ORCA_CLI_SKILL_NAME = 'orca-cli'
|
|
export const COMPUTER_USE_SKILL_NAME = 'computer-use'
|
|
export const ORCHESTRATION_SKILL_NAME = 'orchestration'
|
|
export const EPHEMERAL_VMS_SKILL_NAME = 'orca-per-workspace-env'
|
|
export const ORCA_LINEAR_SKILL_NAME = 'orca-linear'
|
|
export const LINEAR_TICKETS_SKILL_NAME = 'linear-tickets'
|
|
export const LINEAR_AGENT_SKILL_NAMES = [ORCA_LINEAR_SKILL_NAME, LINEAR_TICKETS_SKILL_NAME] as const
|
|
|
|
// Why: `yes` and `agents` default off so every Settings/onboarding string a human
|
|
// pastes keeps its interactive prompts and the CLI's own agent detection. Only an
|
|
// unattended spawn, which nothing can answer, opts in.
|
|
export type AgentFeatureSkillCommandOptions = {
|
|
global?: boolean
|
|
yes?: boolean
|
|
agents?: readonly string[]
|
|
}
|
|
|
|
export function buildAgentFeatureSkillInstallArgs(
|
|
skillNames: readonly string[],
|
|
options: AgentFeatureSkillCommandOptions = {}
|
|
): string[] {
|
|
if (skillNames.length === 0) {
|
|
throw new Error('At least one skill name is required.')
|
|
}
|
|
const global = options.global ?? true
|
|
// Why: -y with no --agent is the one combination that makes `skills add` install
|
|
// into every agent it knows. Refuse it here so no caller can express it.
|
|
const agents = options.agents ?? []
|
|
if (options.yes && agents.length === 0) {
|
|
throw new Error('An install target is required when skipping prompts.')
|
|
}
|
|
// Why: a value the skills CLI would drop leaves it with no target at all, which
|
|
// is the same all-agents install as passing no --agent.
|
|
const unusable = agents.find((agent) => !isUsableSkillsCliAgentKey(agent))
|
|
if (unusable !== undefined) {
|
|
throw new Error(`"${unusable}" is not a usable install target.`)
|
|
}
|
|
// Why: one flag per name remains compatible with both single-value and variadic parsers.
|
|
const skillArgs = skillNames.flatMap((name) => ['--skill', name])
|
|
return [
|
|
'skills',
|
|
'add',
|
|
ORCA_SKILLS_REPOSITORY_URL,
|
|
...skillArgs,
|
|
...(global ? ['--global'] : []),
|
|
// Why: an explicit --agent stops `skills add` calling its own detection, whose
|
|
// zero-detected branch installs into all ~75 known agents and litters a bare
|
|
// host with agent config directories it has no agent for.
|
|
...agents.flatMap((agent) => ['--agent', agent]),
|
|
// Why: without -y `skills add` opens an interactive agent picker and blocks
|
|
// forever on any TTY, which is every ssh session.
|
|
...(options.yes ? ['-y'] : [])
|
|
]
|
|
}
|
|
|
|
export function buildAgentFeatureSkillInstallCommand(
|
|
skillNames: readonly string[],
|
|
options: AgentFeatureSkillCommandOptions = {}
|
|
): string {
|
|
return `npx ${buildAgentFeatureSkillInstallArgs(skillNames, options).join(' ')}`
|
|
}
|
|
|
|
export function buildAgentFeatureSkillUpdateArgs(
|
|
skillNames: string | readonly string[],
|
|
options: AgentFeatureSkillCommandOptions = {}
|
|
): string[] {
|
|
const rawNames = typeof skillNames === 'string' ? [skillNames] : skillNames
|
|
const names = rawNames.map((name) => name.trim()).filter((name) => name.length > 0)
|
|
if (names.length === 0) {
|
|
throw new Error('A skill name is required.')
|
|
}
|
|
const global = options.global ?? true
|
|
return [
|
|
'skills',
|
|
'update',
|
|
...names,
|
|
global ? '--global' : '--project',
|
|
...(options.yes ? ['-y'] : [])
|
|
]
|
|
}
|
|
|
|
export function buildAgentFeatureSkillUpdateCommand(
|
|
skillNames: string | readonly string[],
|
|
options: AgentFeatureSkillCommandOptions = {}
|
|
): string {
|
|
return `npx ${buildAgentFeatureSkillUpdateArgs(skillNames, options).join(' ')}`
|
|
}
|
|
|
|
export const ORCA_CLI_SKILL_INSTALL_COMMAND = buildAgentFeatureSkillInstallCommand([
|
|
ORCA_CLI_SKILL_NAME
|
|
])
|
|
|
|
export const ORCA_CLI_SKILL_UPDATE_COMMAND =
|
|
buildAgentFeatureSkillUpdateCommand(ORCA_CLI_SKILL_NAME)
|
|
|
|
export const COMPUTER_USE_SKILL_INSTALL_COMMAND = buildAgentFeatureSkillInstallCommand([
|
|
COMPUTER_USE_SKILL_NAME
|
|
])
|
|
|
|
export const COMPUTER_USE_SKILL_UPDATE_COMMAND =
|
|
buildAgentFeatureSkillUpdateCommand(COMPUTER_USE_SKILL_NAME)
|
|
|
|
export const ORCHESTRATION_SKILL_INSTALL_COMMAND = buildAgentFeatureSkillInstallCommand([
|
|
ORCHESTRATION_SKILL_NAME
|
|
])
|
|
|
|
export const ORCHESTRATION_SKILL_UPDATE_COMMAND =
|
|
buildAgentFeatureSkillUpdateCommand(ORCHESTRATION_SKILL_NAME)
|
|
|
|
export const EPHEMERAL_VMS_SKILL_INSTALL_COMMAND = buildAgentFeatureSkillInstallCommand([
|
|
EPHEMERAL_VMS_SKILL_NAME
|
|
])
|
|
|
|
export const EPHEMERAL_VMS_SKILL_UPDATE_COMMAND =
|
|
buildAgentFeatureSkillUpdateCommand(EPHEMERAL_VMS_SKILL_NAME)
|
|
|
|
export const ORCA_CLI_ORCHESTRATION_SKILL_INSTALL_COMMAND = buildAgentFeatureSkillInstallCommand([
|
|
ORCA_CLI_SKILL_NAME,
|
|
ORCHESTRATION_SKILL_NAME
|
|
])
|
|
|
|
export const ORCA_LINEAR_SKILL_INSTALL_COMMAND = buildAgentFeatureSkillInstallCommand([
|
|
ORCA_LINEAR_SKILL_NAME
|
|
])
|
|
|
|
export const ORCA_LINEAR_SKILL_UPDATE_COMMAND =
|
|
buildAgentFeatureSkillUpdateCommand(ORCA_LINEAR_SKILL_NAME)
|
|
|
|
export const LINEAR_TICKETS_SKILL_UPDATE_COMMAND =
|
|
buildAgentFeatureSkillUpdateCommand(LINEAR_TICKETS_SKILL_NAME)
|