Swift Api Design Guidelines

supabase/supabase-swift/.claude/skills/swift-api-design-guidelines

codingOfficial

Official Provider SkillView repo

Use whenever you write, name, or review any public (or internal-but-API-shaped) Swift declaration in this repo — a method, function, initializer, property, protocol, or parameter — and especially before opening a PR that adds or renames public API. Covers naming clarity, argument labels, factory/initializer conventions, boolean and mutating/nonmutating naming, and terms of art, per https://www.swift.org/documentation/api-design-guidelines/. Also use when reviewing a PR's diff for naming issues,

Files1 files

SKILL.md138 lines

Loading editor…

Install

Recommended

One command — your agent picks it up automatically.

Select AI agent

Select an AI agent above to see the install command.

Manual Install

More steps

Download the file and paste it into your agent's system prompt.

Skill details

Versionv1.0.0

AuthorSupabase

Categorycoding

Skill IDsupabase/supabase-swift/.claude/skills/swift-api-design-guidelines

Related skills

Swift DoccUse when adding triple-slash comments to Swift types, methods, or properties; creating a .docc catalog folder; writing articles or extension files for a Swift package; fixing DocC build warnings about broken symbol links or missing documentation; or setting up module-level documentation for the first time.Writing Migration GuidesUse when a change is a breaking change — a `fix!:`/`feat!:` commit, a `BREAKING CHANGE:` footer, or any edit that changes a public API's shape or behavior — and needs an entry in the root `V<N>_MIGRATION.md` file. Also use when reviewing a PR that has one, to check it against this format.Link Workspace PackagesLink workspace packages in monorepos (npm, yarn, pnpm, bun). USE WHEN: (1) you just created or generated new packages and need to wire up their dependencies, (2) user imports from a sibling package and needs to add it as a dependency, (3) you get resolution errors for workspace packages (@org/*) like "cannot find module", "failed to resolve import", "TS2307", or "cannot resolve". DO NOT patch around with tsconfig paths or manual package.json edits - use the package manager's workspace commands t Nx ImportImport, merge, or combine repositories into an Nx workspace using nx import. USE WHEN the user asks to adopt Nx across repos, move projects into a monorepo, or bring code/history from another repository.Nx PluginsFind and add Nx plugins. USE WHEN user wants to discover available plugins, install a new plugin, or add support for a specific framework or technology to the workspace.Nx WorkspaceExplore and understand Nx workspaces. USE WHEN answering questions about the workspace, projects, or tasks. ALSO USE WHEN an nx command fails or you need to check available targets/configuration before running a task. EXAMPLES: 'What projects are in this workspace?', 'How is project X configured?', 'What depends on library Y?', 'What targets can I run?', 'Cannot find configuration for task', 'debug nx task failure'.