skills.rest
Esposter
EsposterOFFICIAL
Explore all skills by this author →
GitHub

naming

Enforce Esposter naming conventions for identifiers in Vue, Pinia, and TRPC projects.

23|3|Updated Jun 28, 2022
Search Tags:#typescript#vue#coding#conventions#naming#pinia
One-click install
npx skills add https://github.com/Esposter/Esposter --skill naming-esposter
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: naming
Source: https://github.com/Esposter/Esposter/tree/main/.agents/skills/naming
Command: npx skills add https://github.com/Esposter/Esposter --skill naming-esposter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Inconsistent identifiers slow down code comprehension and increase maintenance costs. This skill enforces Esposter naming rules to promote clarity and consistency across a codebase.

Core Features & Use Cases

  • Boolean naming: enforces the is* prefix for boolean variables/properties, promotes check* for boolean-returning functions, and restricts banned prefixes like show* to is*Visible.
  • Function & variable naming: uses get* for derivations, read* for async data fetchers, store* for state updates, and requires full, non-abbreviated variable names (with time suffix Ms where appropriate).
  • Regex & types naming: suffix _REGEX for regex constants, A-prefix for abstract classes, and interfaces/classes using full domain-type names (no With prefixes).
  • Consistency rules: no abbreviations, Ms suffix for time, userId for session user, and descriptive, consistent names across frameworks (Vue/Pinia/trpc).

Quick Start

Apply these naming rules to all new identifiers in your codebase to ensure consistent conventions.

Frequently Asked Questions about naming

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

FAQPage Schema
How do I enforce consistent naming conventions for variables and functions in a Vue and Pinia codebase?▼

Consistent naming conventions for Vue, Pinia, and TRPC projects are enforced by applying specific prefixes and suffixes to identifiers, such as using get* for derivations and read* for async data fetchers, ensuring clarity and reducing maintenance costs across teams.

What is the best way to name boolean variables and functions in TypeScript to improve code comprehension?▼

Boolean variables and properties require an is* prefix, boolean-returning functions use check*, and banned prefixes like show* are restricted to is*Visible to enforce clarity and consistency across your TypeScript codebase.

Does this naming convention skill apply to state management updates and async data fetching in tRPC?▼

Yes, this naming convention applies to tRPC, Vue, and Pinia projects, specifically enforcing read* for async data fetchers and store* for state updates to ensure consistent identifier naming across different frameworks.

How do I standardize interface and class naming to avoid abbreviations in my codebase?▼

Interface and class naming is standardized by using full, non-abbreviated domain-type names, applying an A-prefix for abstract classes, and avoiding With prefixes to ensure descriptive and consistent identifiers.

What are the specific naming rules for time values and regular expression constants in TypeScript?▼

Time values require a Ms suffix, regular expression constants must use a _REGEX suffix, and session users are identified by userId to enforce descriptive, non-abbreviated naming across your TypeScript codebase.

Related Skills

Explore More Software Engineering Skills→
travisjneumantravisjneuman
88

vue-development

Guide Vue.js 3 development with Composition API, TypeScript, Pinia, and Nuxt 3.

Community
Advanced
actionbookactionbook
1.4k

coding-guidelines

Standardize Rust naming, formatting, and linting conventions across codebases.

Official
Basic
massCodeIOmassCodeIO
6.9k

vue-renderer-standards

Standardize Vue 3 renderer components with Composition API and script setup patterns.

Official
Advanced
chad3814chad3814

Global Coding Style

Enforce TypeScript and Remotion coding conventions with ESLint rules and path aliases.

Community
Intermediate