coding-standards

Enforce coding standards for TypeScript, JavaScript, React, and Node.js projects.

Updated Dec 8, 2024
One-click install
npx skills add https://github.com/daehyunpy/my-nix-config --skill coding-standards-daehyunpy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: coding-standards
Source: https://github.com/daehyunpy/my-nix-config/tree/main/home-files/cursor/skills/coding-standards
Command: npx skills add https://github.com/daehyunpy/my-nix-config --skill coding-standards-daehyunpy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive set of universal coding standards, best practices, and patterns to ensure high code quality, readability, and maintainability across TypeScript, JavaScript, React, and Node.js projects.

Core Features & Use Cases

  • Code Quality Principles: Enforces principles like Readability First, KISS, DRY, and YAGNI.
  • Language-Specific Standards: Offers detailed guidelines for TypeScript/JavaScript (naming, immutability, error handling, async/await, type safety) and React (component structure, custom hooks, state management, conditional rendering).
  • API Design & Organization: Outlines best practices for REST API conventions, response formats, input validation, project structure, and file naming.
  • Documentation & Performance: Covers commenting strategies, JSDoc usage, memoization, lazy loading, and efficient database queries.
  • Testing & Code Smells: Provides guidance on test structure/naming and identifies common code smells to avoid.
  • Use Case: A development team can use this Skill to establish and enforce a consistent coding style across their entire codebase, reducing bugs and improving collaboration.

Quick Start

Apply the coding standards outlined in this skill to the provided codebase.

Frequently Asked Questions about coding-standards

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

FAQPage Schema
What are the best practices for maintaining TypeScript and React code quality?

Best practices for TypeScript and React code quality include enforcing naming conventions, immutability, type safety, and structured component design. This Skill provides detailed guidelines to improve readability, maintainability, and consistency across your projects.

How do I structure REST APIs and organize files in a Node.js project?

Structuring REST APIs in a Node.js project involves following specific response formats, input validation, and file naming conventions. This Skill provides universal coding standards to organize your project structure and enforce consistent API design.

Can I use these coding standards for both JavaScript and TypeScript development?

Yes, these coding standards support both JavaScript and TypeScript development. They offer language-specific guidelines covering error handling, async/await, and type safety to elevate code consistency across mixed environments.

Does this Skill cover testing strategies and common code smell detection?

This Skill covers testing strategies and code smell detection by providing guidance on test structure, test naming, and identifying common anti-patterns. It aims to improve overall code readability and maintainability.

What's the best way to optimize React component performance and write documentation?

The best way to optimize React performance and write documentation is using memoization, lazy loading, and JSDoc commenting strategies. This Skill provides standards to enhance performance optimization and documentation clarity.