coding-standards

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

Updated May 24, 2023
One-click install
npx skills add https://github.com/Kimjiman/basic-arch --skill coding-standards-kimjiman
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: coding-standards
Source: https://github.com/Kimjiman/basic-arch/tree/main/.claude/skills/coding-standards
Command: npx skills add https://github.com/Kimjiman/basic-arch --skill coding-standards-kimjiman

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 consistency, readability, and maintainability across TypeScript, JavaScript, React, and Node.js projects.

Core Features & Use Cases

  • Enforces Best Practices: Guides developers on naming conventions, immutability, error handling, and async patterns.
  • Improves Code Quality: Promotes principles like KISS, DRY, and YAGNI for simpler, more robust code.
  • Standardizes Project Structure: Offers recommendations for file organization and component structure.
  • Use Case: A new developer joins a team and needs to understand the established coding conventions. They can refer to this Skill to quickly grasp the expected standards for writing React components, handling asynchronous operations, and structuring their code.

Quick Start

Review the coding standards for TypeScript and JavaScript development.

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 React component structure and state management?

Established React coding standards recommend organizing files logically, extracting reusable logic into custom hooks, and managing state predictably. This Skill details those component structure and state management guidelines to ensure maintainable applications.

How do I handle async/await and error handling in Node.js and TypeScript?

Handling async/await and errors in Node.js and TypeScript requires following established coding standards for predictable execution and type safety. This Skill outlines universal patterns for asynchronous operations and robust error management.

How do I enforce coding standards and naming conventions for JavaScript and TypeScript projects?

Enforcing coding standards for JavaScript and TypeScript involves applying principles like KISS, DRY, and YAGNI alongside strict naming conventions. This Skill provides a comprehensive reference for variable naming, function naming, and immutability rules.

Does this coding standards Skill apply to both React frontend and Node.js backend development?

Yes, these coding standards apply to both React frontend and Node.js backend development. The Skill establishes universal best practices for API design, file organization, and performance optimization across your entire TypeScript and JavaScript stack.

What is the best way to structure files and write documentation for maintainable TypeScript code?

The best way to structure files and documentation for maintainable TypeScript code is to follow standardized organization patterns and commenting guidelines. This Skill offers recommendations for file structuring, documentation practices, and testing to improve overall code quality.