Browse

NestJS .cursorrules prompt files

NestJS is a progressive Node.js framework for building efficient and scalable server-side applications, benefiting developers with its modular architecture and strong TypeScript support.

Filters

All

React

Tailwind CSS

Filters

Tech

Clear

nprogress

blo

eslint-config-next

zustand

qrcode.react

use-debounce

wagmi

usehooks-ts

@uniswap/v2-sdk

viem

@uniswap/sdk-core

@heroicons/react

eslint-plugin-prettier

type-fest

prettier

@types/react-copy-to-clipboard

@trivago/prettier-plugin-sort-imports

burner-connector

@typescript-eslint/eslint-plugin

microservices architecture

Traefik

CSP

AWS API Gateway

OpenTelemetry

OAuth2

NGINX

Azure Functions

RQ

Azure Cosmos DB

Elasticsearch

Linkerd

AWS CloudWatch

AWS Lambda

Kong

AWS DynamoDB

OWASP Zap

Hono

edgeql-js

EdgeDB-js

vueuse

Bun

blockchain

Chromia

Redux

Recoil

MUI

BenchmarkTools.jl

Documenter.jl

Test

Julia

Pkg

SArray

Shaden UI

Address

ERC20

ERC20Snapshot

ERC20Votes

ERC20Permit

TimelockController

Nuqs

Ruby on Rails

Inertia.JS

Supabase real time client

Nextjs

Supabase PostgresSQL

Plaid

Supabase auth

Plaid API

tabulate

rich

colorama

pyperclip

prompt-toolkit

jinja2

tiktoken

click

singleton

AppLocalizations

const constructors

underscores_case

reduce

factory

arrow functions

camelCase

Riverpod

URL

getIt

lazy singleton

English

map

Dart

freezed

ThemeData

PascalCase

Flutter

UPPERCASE

AutoRoute

Web3Modal

@tableland/sdk

dotenv

TypeScript NestJS best practices .cursorrules prompt file

You are a senior TypeScript programmer with experience in the NestJS 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.
- One export per file.

### 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.

### Testing

- Follow the Arrange-Act-Assert convention for tests.
- Name test variables clearly.
- Follow the convention: inputX, mockX, actualX, expectedX, etc.
- Write unit tests for each public function.
- Use test doubles to simulate dependencies.
- Except for third-party dependencies that are not expensive to execute.
- Write acceptance tests for each module.
- Follow the Given-When-Then convention.

## Specific to NestJS

### Basic Principles

- Use modular architecture
- Encapsulate the API in modules.
- One module per main domain/route.
- One controller for its route.
  - And other controllers for secondary routes.
- A models folder with data types.
  - DTOs validated with class-validator for inputs.
  - Declare simple types for outputs.
- A services module with business logic and persistence.
  - Entities with MikroORM for data persistence.
  - One service per entity.
- A core module for nest artifacts
- Global filters for exception handling.
- Global middlewares for request management.
- Guards for permission management.
- Interceptors for request management.
- A shared module for services shared between modules.
- Utilities
- Shared business logic

### Testing

- Use the standard Jest framework for testing.
- Write tests for each controller and service.
- Write end to end tests for each api module.
- Add a admin/test method to each controller as a smoke test.

stack: