swift-code-reviewer-skill 1.1.1 → 1.2.1

package/CHANGELOG.md

@@ -5,6 +5,46 @@ All notable changes to the Swift Code Reviewer Agent Skill will be documented in
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [1.2.1] - 2026-04-21
+
+### Fixed
+
+- `bin/install.js` now copies `skills/` and `templates/` directories during install — companion skill references in `SKILL.md` and `init` command templates were silently missing from `~/.claude/skills/` after install
+
+## [1.2.0] - 2026-04-21
+
+### Added
+
+- **Bundled companion skills** under `skills/` — five Swift/SwiftUI knowledge bases ship in-tree:
+  - `swiftui-expert-skill` — SwiftUI state management, view composition, Liquid Glass, macOS patterns ([@Dimillian](https://github.com/Dimillian))
+  - `swift-concurrency` — actors, Sendable, async/await, Swift 6 migration ([@AvdLee](https://github.com/AvdLee))
+  - `swift-testing` — Swift Testing framework, test doubles, snapshots, XCTest migration ([@AvdLee](https://github.com/AvdLee))
+  - `swift-expert` — Swift 6+ specialist: protocols, memory, concurrency, architecture ([@bocato](https://github.com/bocato))
+  - `swiftui-ui-patterns` — 32 component-level SwiftUI pattern references ([@Dimillian](https://github.com/Dimillian))
+- `skills/README.md` — full index with attribution table and update instructions
+- `NOTICE.md` per bundled skill with primary-author attribution and license note
+- `bundledSkills` array in `skill.json` for tooling enumeration
+- **`init` command**: scaffold review agent + `/review` slash command into any project via `npx swift-code-reviewer-skill init`
+- **templates/ directory**: bundled agent (`swift-code-reviewer.md`) and command (`review.md`) templates
+- `setup` alias for `init` in both installers
+- **skill-review GitHub Action**: auto-reviews any `SKILL.md` changed in a PR for instant quality signal ([#2](https://github.com/Viniciuscarvalho/swift-code-reviewer-skill/pull/2), [@yogesh-tessl](https://github.com/yogesh-tessl))
+- `npx skills add` as primary installation method in README
+
+### Changed
+
+- `SKILL.md` cut by 71% — condensed to structured format with finding examples and phase checkpoints
+- `SKILL.md` "Integration with Existing Skills" replaced by "Bundled Companion Skills" — cross-references point to in-tree `skills/<name>/references/` paths
+- README "Integration with Other Skills" replaced by "Bundled Companion Skills" section with directory layout, author credits, and per-skill links
+- README rewritten with `npx skills add` as primary install method; `init` as step 2
+- `package.json` `files` array now includes `skills/` so bundled skills ship in the npm tarball
+- `bin/install.js` and `install-skill.sh` now show `init` hint after install
+
+### Fixed
+
+- Resolves [#1](https://github.com/Viniciuscarvalho/swift-code-reviewer-skill/issues/1): companion knowledge bases now bundled directly in-repo instead of requiring a separate install step
+
 ## [1.1.1] - 2026-03-24
 
 ### Fixed
@@ -16,7 +56,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- increase adjusts from Dimillian skill and more scenarios to cover
+- Increase adjusts from Dimillian skill and more scenarios to cover
 
 ## [1.0.0] - 2026-02-10
 
@@ -62,13 +102,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **feedback-templates.md** (666 lines): Review templates and severity guidelines
 - **custom-guidelines.md** (852 lines): Project standards integration guide
 
-#### Integration Features
-
-- **swift-best-practices skill** integration for Swift 6+ language patterns
-- **swiftui-expert-skill** integration for SwiftUI best practices
-- **swiftui-performance-audit** integration for performance analysis
-- **Independent operation** with comprehensive built-in checklists
-
 #### Platform Support
 
 - Swift 6.0+
@@ -76,169 +109,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - GitHub and GitLab integration
 - Local git repository support
 
-### Documentation
-
-- **README.md**: Comprehensive overview with examples and usage patterns
-- **CONTRIBUTING.md**: Contribution guidelines and development setup
-- **LICENSE**: MIT License
-- **CHANGELOG.md**: Version history and change tracking
-- **.gitignore**: Standard macOS and editor ignores
-
-### Features in Detail
-
-#### Swift Quality Checks
-
-- Actor isolation and MainActor usage
-- Sendable conformance validation
-- Data race prevention
-- Typed throws (Swift 6+)
-- Force unwrap detection (!, as!, try!)
-- Optional handling patterns
-- Access control enforcement
-- Swift API Design Guidelines compliance
-
-#### SwiftUI Checks
-
-- @Observable pattern adoption (iOS 17+)
-- Property wrapper selection guide
-- NavigationStack vs NavigationView
-- .task vs .onAppear for async work
-- Modern .onChange syntax
-- State ownership rules
-- View composition guidelines
-- Accessibility compliance
-
-#### Performance Checks
-
-- View update optimization
-- Equatable conformance for ViewModels
-- ForEach identity stability
-- GeometryReader overuse detection
-- Layout thrash prevention
-- AsyncImage for remote images
-- Memory leak detection
-- Retain cycle prevention
-
-#### Security Checks
-
-- Keychain usage for credentials
-- Biometric authentication
-- HTTPS enforcement
-- Certificate pinning
-- API key protection
-- Input validation
-- SQL injection prevention
-- XSS prevention in WebViews
-- Sensitive data logging prevention
-
-#### Architecture Checks
-
-- MVVM pattern validation
-- Repository pattern implementation
-- Dependency injection verification
-- Use Case pattern detection
-- Coordinator pattern for navigation
-- Protocol-based abstractions
-- Testability assessment
-- Code organization (MARK comments, extensions)
-
-#### Project Standards
-
-- .claude/CLAUDE.md parsing and validation
-- Custom architecture pattern validation
-- Design system compliance (colors, fonts, spacing)
-- Error handling pattern conformance
-- Testing requirement verification
-- Navigation pattern compliance
-
-### Templates and Examples
-
-#### Positive Feedback Templates
-
-- Modern API adoption
-- Architecture excellence
-- Code quality
-- Performance optimization
-- Accessibility support
-- Security awareness
-
-#### Issue Report Templates
-
-- Critical issues (security, crashes, data races)
-- High priority (performance, anti-patterns)
-- Medium priority (code quality, documentation)
-- Low priority (style, suggestions)
-
-#### Refactoring Suggestions
-
-- Extract subview
-- Simplify complex logic
-- Extract reusable component
-- Performance optimization opportunities
-
-### Example Review Reports
-
-Provided complete examples for:
-
-- Reviewing uncommitted changes
-- Reviewing against project standards
-- Pull request reviews
-- File-specific reviews
-- Multi-file reviews
-
-## [Unreleased]
-
-### Planned Features
-
-- **Swift 6.1 support**: Add new language features
-- **iOS 18 patterns**: Add latest SwiftUI APIs
-- **Xcode 16 integration**: Better Xcode project analysis
-- **Custom rule engine**: User-defined review rules
-- **Machine learning**: Pattern learning from reviewed code
-- **Team metrics**: Aggregate review statistics
-- **CI/CD integration**: Automated PR review comments
-- **VSCode extension**: Direct editor integration
-
-### Potential Enhancements
-
-- **Video tutorials**: Screen recordings showing usage
-- **Interactive examples**: Live code review demonstrations
-- **Best practices database**: Searchable pattern library
-- **Quick fixes**: Automated code corrections
-- **Review presets**: Configurable review profiles
-- **Multi-language support**: Objective-C, C++, SwiftUI previews
+---
 
 ## Version History Summary
 
+- **1.2.1** (2026-04-21): Fix installer not copying `skills/` and `templates/` directories
+- **1.2.0** (2026-04-21): Bundle five companion Swift skills, add `init` scaffolding command, skill-review CI action, SKILL.md condensed 71%
 - **1.1.1** (2026-03-24): Fix incorrect `install-skill.sh` (was XcodeBuildMCP installer)
 - **1.1.0** (2026-03-16): Increase adjusts from Dimillian skill and more scenarios to cover
 - **1.0.0** (2026-02-10): Initial release with comprehensive review capabilities
 
 ---
 
-## How to Read This Changelog
-
-- **Added**: New features
-- **Changed**: Changes in existing functionality
-- **Deprecated**: Soon-to-be removed features
-- **Removed**: Removed features
-- **Fixed**: Bug fixes
-- **Security**: Vulnerability fixes
-
-## Contributing
-
-See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on proposing changes.
-
-## Release Process
-
-1. Update version in SKILL.md
-2. Update CHANGELOG.md with changes
-3. Create git tag: `git tag -a v1.0.0 -m "Release 1.0.0"`
-4. Push tag: `git push origin v1.0.0`
-5. Create GitHub release with notes from CHANGELOG
-
----
-
 **Note**: This skill follows [Semantic Versioning](https://semver.org/):
 
 - **MAJOR**: Incompatible API changes

package/README.md

@@ -7,19 +7,49 @@ A code review skill for [Claude Code](https://docs.anthropic.com/en/docs/claude-
 
 ## Quick Start
 
+### 1. Install the skill (global, once)
+
 ```bash
-npx swift-code-reviewer-skill
+npx skills add Viniciuscarvalho/swift-code-reviewer-skill
+```
+
+To update to the latest version later:
+
+```bash
+npx swift-code-reviewer-skill@latest
 ```
 
-That's it. The skill is installed and ready to use. Run it again anytime to update to the latest version.
+### 2. Add the review agent to your project (optional)
 
-> No cloning, no manual setup. NPX always fetches the latest version automatically.
+```bash
+cd ~/Projects/YourApp
+npx swift-code-reviewer-skill init
+```
+
+This scaffolds two files into your project:
+
+```
+.claude/
+  agents/swift-code-reviewer.md   # review agent
+  commands/review.md              # /review slash command
+```
+
+Existing files are never overwritten.
+
+### The review flow
+
+```
+You code  -->  /review before push (free, local)  -->  done
+```
+
+- `/review` runs the full review checklist against your staged or unstaged Swift changes
+- `@swift-code-reviewer` invokes the agent directly for deeper analysis
 
 ## Usage
 
 ![Swift Code Reviewer in action](assets/demo.png)
 
-Just ask Claude to review your code:
+Ask Claude to review your code:
 
 ```
 Review this PR
@@ -29,6 +59,12 @@ Review all ViewModels in the Features folder
 Check if this follows our coding standards
 ```
 
+Or use the slash command after running `init`:
+
+```
+/review
+```
+
 The skill automatically activates, reads your `.claude/CLAUDE.md` for project standards, and generates a structured report with severity levels, code examples, and prioritized action items.
 
 ### Example Output
@@ -42,11 +78,11 @@ The skill automatically activates, reads your `.claude/CLAUDE.md` for project st
 
 ## File: LoginViewModel.swift
 
-✅ **Excellent Modern API Usage** (line 12)
+Pass **Excellent Modern API Usage** (line 12)
 
 - Using @Observable instead of ObservableObject
 
-🟡 **Force Unwrap Detected** (line 89)
+Issue **Force Unwrap Detected** (line 89)
 Current: `let user = repository.currentUser!`
 Fix:
 guard let user = repository.currentUser else {
@@ -54,7 +90,7 @@ logger.error("No current user")
 return
 }
 
-🔴 **Violates Design System Standard** (line 45)
+Issue **Violates Design System Standard** (line 45)
 Current: `.foregroundColor(.blue)`
 Fix: `.foregroundColor(AppColors.primary)`
 
@@ -77,12 +113,12 @@ Fix: `.foregroundColor(AppColors.primary)`
 
 ### Severity Levels
 
-| Icon | Severity | Action                  |
-| ---- | -------- | ----------------------- |
-| 🔴   | Critical | Must fix before merge   |
-| 🟡   | High     | Should fix before merge |
-| 🟠   | Medium   | Fix in current sprint   |
-| 🔵   | Low      | Consider for future     |
+| Icon     | Severity | Action                  |
+| -------- | -------- | ----------------------- |
+| Critical | Critical | Must fix before merge   |
+| High     | High     | Should fix before merge |
+| Medium   | Medium   | Fix in current sprint   |
+| Low      | Low      | Consider for future     |
 
 ## Platform Support
 
@@ -115,6 +151,15 @@ Add a `.claude/CLAUDE.md` to your project and the skill will validate against yo
 
 ## Alternative Installation
 
+<details>
+<summary>NPX installer (installs skill only)</summary>
+
+```bash
+npx swift-code-reviewer-skill
+```
+
+</details>
+
 <details>
 <summary>Clone this repository</summary>
 
@@ -125,13 +170,13 @@ git clone https://github.com/Viniciuscarvalho/swift-code-reviewer-skill.git ~/.c
 </details>
 
 <details>
-<summary>Manual installation</summary>
+<summary>Update to latest version</summary>
 
 ```bash
-mkdir -p ~/.claude/skills/swift-code-reviewer-skill/references
+npx swift-code-reviewer-skill@latest
 ```
 
-Download the files from this repository into the directory, then restart Claude.
+This replaces the existing `~/.claude/skills/swift-code-reviewer-skill/` with the latest files.
 
 </details>
 
@@ -144,16 +189,41 @@ npx swift-code-reviewer-skill uninstall
 
 </details>
 
-## Integration with Other Skills
+## Bundled Companion Skills
+
+This repo ships five companion skills under `skills/` so you get a complete, self-contained knowledge base after a single install — no extra steps required.
+
+```
+skills/
+├── README.md                    ← full index + attribution
+├── swiftui-expert-skill/        ← SwiftUI state, Liquid Glass, macOS patterns
+├── swift-concurrency/           ← actors, Sendable, Swift 6 migration
+├── swift-testing/               ← Swift Testing framework, doubles, snapshots
+├── swift-expert/                ← Swift 6+ specialist: protocols, memory, architecture
+└── swiftui-ui-patterns/         ← 32 component references (nav, sheets, grids…)
+```
+
+The reviewer's `SKILL.md` points to specific reference files inside each skill, so during a review Claude can read the exact guidance it needs without any extra configuration.
+
+### Thanks to the original authors
+
+The bundled skills are based on the public Swift/SwiftUI work of:
+
+| Author              | GitHub                                     |
+| ------------------- | ------------------------------------------ |
+| Antoine van der Lee | [@AvdLee](https://github.com/AvdLee)       |
+| Thomas Ricouard     | [@Dimillian](https://github.com/Dimillian) |
+| Eduardo Bocato      | [@bocato](https://github.com/bocato)       |
 
-This skill optionally leverages **swift-best-practices**, **swiftui-expert-skill**, and **swiftui-performance-audit** for deeper analysis. It works independently with its own comprehensive checklists.
+Each skill folder contains a `NOTICE.md` with attribution details. Upstream folders carried no `LICENSE` or `AUTHORS` files — if you are an original author and want attribution updated or content removed, please [open an issue](https://github.com/Viniciuscarvalho/swift-code-reviewer-skill/issues).
 
 ## Contributing
 
 1. Edit `SKILL.md` for main skill logic
 2. Update reference files in `references/` for specific checklists
-3. Test with real Swift/SwiftUI code
-4. Submit a pull request
+3. Add/modify templates in `templates/` for agent and command scaffolding
+4. Test with real Swift/SwiftUI code
+5. Submit a pull request
 
 ## License
 
@@ -161,7 +231,7 @@ MIT License - See [LICENSE](LICENSE) file for details.
 
 ---
 
-**Made with ❤️ for the Swift community**
+**Made with care for the Swift community**
 
 If this skill helps your code reviews, please star the repository!