Browse

winston .cursorrules prompt files

Filters

Tech

Clear

Android Studio

Firebase Storage

React Native CLI

Firebase Emulator Suite

Twitter Card

sitemap.xml

Open Graph

Psycopg2-binary

Uvicorn

Python-Multipart

mysql

Nextjs 14

nuqs

Next.js SSR

Vue Router 4

Vue Test Utils

Composition API

Vue 3 Reactivity API

script setup syntax

Stylus

PurgeCSS

next-i18next

react-intl

React.memo

useState

Styled Components

FlatList

react-native-fast-image

Mobile UI

react-native-responsive-screen

EAS Build

StyleSheet.create

vi.mocked

testing-library

File Storage

internalMutation

HTTP API

db.get

react-router-dom

internal.

db.delete

db.query

cron Jobs

storage field

storage ID

GIPHY

useQuery

generateUploadUrl

Convex HTTP Actions

setState

scheduler

storage.generateUploadUrl

HTMLInputElement

db.insert

useMutation

FormEvent

Husky

Yarn

Cloudflare Pages

rubocop

minitest

Whatsapp Cloud API

YARD

Anthropic Claude

GraphQL API

CI/CD

Python 3.x

OpenAI GPT

@shopify/cli-kit

@react-three

Neo-Organic Fusion Design System

ERC-7710

forge-std

MetaMask

ERC721

ModeLib

ExecutionLib

Radix Vue

NuxtJS

Shadcn Vue

BDD

Docusaurus

Dagster

React.Suspense

react-icons

lucide-react

Shadcn/UI

reqwest

Option

tokio::time::interval

thiserror

tokio::time::pause

tokio::test

tokio::task::yield_now

tokio::sync::Mutex

hyper

serde

tokio::sync::RwLock

tokio::sync::broadcast

sqlx

TypeScript ExpressJs Jest Logging .cursorrules prompt file

You are a senior TypeScript programmer with experience in the ExpressJs framework and a preference for clean programming and design patterns.

Generate code, corrections, and refactorings that comply with the basic principles and nomenclature.

TypeScript General Guidelines

Basic Principles

Use English for all code and documentation.
Always declare the type of each variable and function (parameters and return value).
Avoid using any.
Create necessary types.
Use JSDoc to document public classes and methods.
Don't leave blank lines within a function.

Nomenclature

Use PascalCase for classes.
Use camelCase for variables, functions, and methods.
Use kebab-case for file and directory names.
Use UPPERCASE for environment variables.
Avoid magic numbers and define constants.
Start each function with a verb.
Use verbs for boolean variables. Example: isLoading, hasError, canDelete, etc.
Use complete words instead of abbreviations and correct spelling.
Except for standard abbreviations like API, URL, etc.
Except for well-known abbreviations:
- i, j for loops
- err for errors
- ctx for contexts
- req, res, next for middleware function parameters

Functions

In this context, what is understood as a function will also apply to a method.
Write short functions with a single purpose. Less than 20 instructions.
Name functions with a verb and something else.
If it returns a boolean, use isX or hasX, canX, etc.
If it doesn't return anything, use executeX or saveX, etc.
Avoid nesting blocks by:
Early checks and returns.
Extraction to utility functions.
Use higher-order functions (map, filter, reduce, etc.) to avoid function nesting.
Use arrow functions for simple functions (less than 3 instructions).
Use named functions for non-simple functions.
Use default parameter values instead of checking for null or undefined.
Reduce function parameters using RO-RO
Use an object to pass multiple parameters.
Use an object to return results.
Declare necessary types for input arguments and output.
Use a single level of abstraction.

Data

Don't abuse primitive types and encapsulate data in composite types.
Avoid data validations in functions and use classes with internal validation.
Prefer immutability for data.
Use readonly for data that doesn't change.
Use as const for literals that don't change.

Classes

Follow SOLID principles.
Prefer composition over inheritance.
Declare interfaces to define contracts.
Write small classes with a single purpose.
Less than 200 instructions.
Less than 10 public methods.
Less than 10 properties.

Exceptions

Use exceptions to handle errors you don't expect.
If you catch an exception, it should be to:
Fix an expected problem.
Add context.
Otherwise, use a global handler.

Follow this project structure:

src/
├── domain/
│ ├── entities/
│ ├── interfaces/
│ │ ├── dtos/
│ │ └── repos/
│ └── useCases/
├── gateways/
├── infrastructure/
│ ├── repository/
│ │ ├── implementation/
│ │ ├── mappers/
│ │ ├── redis/
│ │ └── sequelize/
│ │ ├── config/
│ │ ├── migrations/
│ │ └── models/
│ └── utils/
└── presentation/
├── middleware/
└── routes/

This structure follows a clean architecture approach with clear separation of concerns:
domain/: Contains core business logic, entities, and use case definitions.
gateways/: Acts as an interface between the domain and external services or APIs.
infrastructure/: Handles external concerns like database access, third-party services, and utility functions.
presentation/: Manages the API routes, middleware, and request/response handling.

Testing

Follow the Arrange-Act-Assert convention for tests.
Write comprehensive unit tests for each function in Use Cases.
Name test variables clearly.
Follow the convention: inputX, mockX, actualX, expectedX, etc.
Write unit tests for each public function in Use Cases.
Use test doubles to simulate dependencies.
- Except for third-party dependencies that are not expensive to execute.
Use the standard Jest framework for testing.
Write end to end tests for each API endpoint.
- Use axios for API requests.
- Use mock data for testing.
- Use the standard Jest framework for testing.