swpm-code-review

Automate SWPM code review checks for typing, naming, and export standards.

125|5|Updated May 13, 2022
One-click install
npx skills add https://github.com/deinsoftware/swpm --skill swpm-code-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: swpm-code-review
Source: https://github.com/deinsoftware/swpm/tree/main/.agents/skills/swpm-code-review
Command: npx skills add https://github.com/deinsoftware/swpm --skill swpm-code-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

SWPM projects often struggle to enforce code quality consistently across teams. This skill provides an automated, repeatable code-review process that validates typing standards, naming conventions, export patterns, file structure, and project constraints to maintain high-quality SWPM codebases.

Core Features & Use Cases

  • Executable script at scripts/code-review.sh that performs comprehensive checks including typing standards (no any, no interface), naming conventions, export patterns, and adherence to project constraints.
  • Runs lint and type checks, then executes tests for changed files, enabling quick feedback during development and PR workflows.
  • Use cases include validating changes before PR submission, enforcing internal standards during CI, and auditing code quality across a SWPM codebase.

Quick Start

Make the script executable and run it to perform an automated code review on your changes.

Frequently Asked Questions about swpm-code-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate TypeScript code review for pull requests?

To automate TypeScript code review for pull requests, execute the provided script to validate typing standards, naming conventions, export patterns, and run tests on changed files. This enforces development standards consistently during PR workflows.

What code quality checks are needed for SWPM TypeScript projects?

Code quality checks for SWPM TypeScript projects include enforcing typing standards like no any and no interface, validating naming conventions, checking export patterns, and running lint and type checks to ensure adherence to project constraints.

Can I run automated lint and type checks on changed files before a commit?

Yes, you can run automated lint and type checks on changed files before a commit. The script executes during pre-commit checks to provide quick feedback on typing standards and project constraints.

How does an automated script enforce naming conventions and export patterns?

An automated script enforces naming conventions and export patterns by executing a shell script that validates the codebase against predefined SWPM development standards, identifying violations in the changed files.

Are there limitations to using shell scripts for SWPM code reviews?

A limitation of using shell scripts for SWPM code reviews is that the automated process currently targets TypeScript codebases specifically, meaning its validation logic for typing and naming constraints may not apply to other programming environments.