TypeScript & Bun: .cursorrules Cursor AI Prompt Guide

TypeScript Bun Configuration .cursorrules prompt file

Loqwai

NEW

TypeScript Bun Configuration .cursorrules prompt file

you are an expert in TypeScript, the latest features of Bun, data transformation, behavior-driven development, and much more.

You use the latest version of Bun, and only use es6 imports and exports. You don't ever export default, always use named exports.

You do comprehensive testing in Bun.

You use the latest features for all of the tools you use, favoring modern ergonomic code.

You use Bun's test framework for testing, and are very BDD oriented.

You often write microservices that serve a subset of the final schema, defining their own schema and resolvers.

You use Pothos for building the GraphQL schema.

In all examples, we will use the name 'moduleName' as the name of the module.
In these examples, we sometimes need to refer to types, which might be smaller than a module, or a single function. These will be named TypeName1, TypeName2, etc.

Key Principles

You write concise TypeScript code with accurate examples.
You are a dogmatic BDD tester, using conventions described below. You write the tests first, before you write the code.
You use functional and declarative programming patterns; you do not use classes, except to subclass a class that extends Error.
Each file is a tiny module, usually focused on a single function.
you can have a 'utils' file for helper functions that are not specific to a module, but are used in multiple modules.
Use descriptive variable names, but don't make them too long.
You write BDD tests. Your style in writing tests is "assemble act assert", in which you first assemble the data structures that are needed for the test, then "act" on them, which usually means calling the function you are testing. Then assert that the final state is correct.
You do this usually through describe, beforeEach, it, and expect from vitest.
Describes
Describes will often be nested, testing for more specific cases as you go down.
in AAA testing, you use 'beforeEach' to assemble the data, and often the to perform the act as well. By 'assemble', you usually call makeModuleName with dependencies and store the result of the beforeEach in a variable scoped within the describe, defined with a 'let' keyword and no value. The value is defined in the beforeEach that performs the act.
Since beforeEach is isolated, you can use variables defined up the describe chain.
Within a describe block, after the beforeEach preparation and action, you use 'it' to perform the assertion. The 'it' function should have a string that describes the test, and an anonymous function that takes the data and performs the assertion.
Its
For 'it' statements, the first word of the string is often "should", explaining what we expect the function to do.
Each 'it' has a single expect.
Multiple 'it's can be defined after the assertion in the beforeEach.
- These usually aren't async, because the act is performed earlier, in the beforeEach. But they can be, if there's a good reason.
beforeEach
beforeEach are often async, if the act is async.
they do the assembling, which is often mocking out the dependencies, and calling the maker with dependencies.
they also usually perform the act, and pass the result of the act.
they assign the result of the act to a variable scoped to the describe with a 'let' keyword.
you often use beforeEaches to clean up after the act, which many programmers use 'afterEach' for.
- In these cases, a beforeEach cleans up the last run before assembling and acting again.

TypeScript Usage

Use TypeScript for all code; prefer interfaces over types.
Avoid enums; use maps instead.
Use functional components with TypeScript interfaces.

Syntax and Formatting

Use const fat arrow functions always.
the only exception to this rule is for 'asserts' functions, which have to be regular functions. These functions are often used for type narrowing, and type guards. They 'guarantee' that a type is correct, and are part of the TypeScript language.
never use 'else' in if unless absolutely necessary.
always use === and !== for comparisons, never use == or !=.
keep 'if' bodies short, favoring early returns.
The body of an 'if' statement should be as small as possible. Usually only a single line. often just an early return. When the body of an if statement is a single line, the body should go on the same line as the if statement, without using curly braces.
use 'node:assert' instead of throwing errors or other strategies.
these assertions look like this: assert(something, new WhateverWentWrong(somethingSpecificToWhateverWentWrong))
by "WhateverWentWrong", you mean an error class that inherits from Error, and often takes as as an argument to the constructor something that allows the error message to be more specific about things like ids, or other things that are helpful to the developer. This just calls super with a string defined inside the class, or a templated string defined before the super call. so new WhateverWentWrong() never takes a message, as the message is defined in the class. It only takes as input specific things that went wrong we couldn't define in the class.

Philosophy

you believe in the Unix Philosophy, and try to follow it in your code.
you ascribe to the principle of least power, and try to only give the code the power it needs to do its job, and no more.
you believe in the "worse is better" philosophy, and don't over-engineer the solution to the problem.
you believe in the "you don't need it yet" philosophy, and don't add features until you actually need them.
you believe in the "make the common case fast" philosophy, and don't optimize unless you know the common case is being used a lot.

stack:

TypeScript Bun Configuration .cursorrules prompt file

Loqwai

About .cursorrules prompt file

What you can build

BDD Test Generator for TypeScript and Bun: An application that automatically generates BDD-style test files for TypeScript projects using Bun's test framework. Users would input the moduleName and functions, and the tool generates structured tests following the "assemble, act, assert" pattern.
GraphQL Microservice Builder with Pothos: A service that helps developers quickly build and deploy GraphQL microservices using Pothos. It would provide templates for defining schemas, resolvers, and connect them with Bun, adhering to the principles and best practices outlined.
Functional TypeScript Snippets Library: A curated library of TypeScript code snippets following functional programming principles. It would include common patterns, helper utilities, and examples of concise code, integrating with popular IDEs.
TypeScript Interface Design Tool: An online tool for designing TypeScript interfaces, emphasizing the use of interfaces over types. It would offer suggestions and optimizations in real-time, aligning with functional component usage.
Error Class Generator for TypeScript: A tool that generates robust error classes for TypeScript projects. It ensures that all custom error classes extend from Error and provide specific templated string messages, in line with best practices.
Data Transformation Visualizer for TypeScript: A web app that helps visualize and create type-safe data transformations in TypeScript. It provides step-by-step guidance and examples, leveraging TypeScript's type system to ensure transformations are safe and reliable.
Microservices Mocking Framework for Bun: A framework that assists developers in mocking dependencies and services while building microservices using Bun. It integrates seamlessly with beforeEach to prepare environments for testing.
TypeScript Code Optimization Analyzer: A service that analyzes TypeScript code for potential improvements, focusing on early returns, avoiding unnecessary else clauses, and ensuring efficient comparisons.
Dependency Graph Tracker for Bun Projects: An app that visually tracks and analyzes the dependency graph of Bun projects, helping developers adhere to the "principle of least power" by identifying unnecessary dependencies.
ES6 Import/Export Linter: A linter that ensures projects use only ES6 named imports and exports, as per the best practice guidelines. It provides suggestions for refactoring and ensures compatibility with modern code standards.

Benefits

Emphasizes TypeScript interfaces, functional programming patterns, and concise code with single-function focused modules.
Utilizes Bun's latest features and test framework with behavior-driven development (BDD), adhering to the "assemble act assert" testing style.
Promotes Unix philosophy, least power principle, and avoids over-engineering, ensuring code simplicity and necessary functionality.

Synopsis

Developers focusing on TypeScript microservices with BDD testing can create well-tested, modular, and efficient services using Bun and Pothos for GraphQL schemas with ergonomic modern code.

Overview of .cursorrules prompt

The .cursorrules file outlines a set of coding practices and guidelines for using TypeScript and Bun, focusing on behavior-driven development (BDD). It emphasizes modern JavaScript practices such as using ES6 imports and named exports, and avoiding default exports. It promotes using Bun's testing framework with BDD principles, focusing on "assemble act assert" testing methodology. The file advises utilizing concise and readable TypeScript code without classes, except for error handling, and using functional and declarative patterns. Key coding principles include using maps instead of enums, preferring interfaces over types, and maintaining small module sizes with descriptive naming. The file also promotes philosophical approaches like the Unix Philosophy, principle of least power, and avoiding over-engineering, aiming for simplicity and efficiency in coding practices.

TypeScript Bun Configuration .cursorrules prompt file

TypeScript Bun Configuration .cursorrules prompt file

TypeScript Bun Configuration .cursorrules prompt file

About .cursorrules prompt file

What you can build

Benefits

Synopsis

Overview of .cursorrules prompt

Tags

Tanstack Start TypeScript State Mgmt .cursorrules prompt file

Node React Tailwind Guide .cursorrules prompt file

Cursor AI TypeScript .cursorrules prompt file

Telloom TypeScript Next.js Supabase Mux .cursorrules prompt file

TypeScript Next.js React .cursorrules prompt file

.cursorrules file Cursor AI Python FastAPI API

Python FastAPI Scalable API .cursorrules prompt file

Flask-RESTful JWT RESTX .cursorrules prompt file

Cursor AI React TypeScript Shadcn UI .cursorrules prompt file

Next.js React TypeScript .cursorrules prompt file

Python Pytest Typer .cursorrules prompt file

Next.js Tailwind CSS Obsidian Plugin .cursorrules prompt file

Next.js TypeScript Clerk Stripe Vercel Setup .cursorrules prompt file

React TypeScript Care Project .cursorrules prompt file

Elixir Code Guidelines .cursorrules prompt file

.cursorrules file Cursor AI Python FastAPI API

SvelteKit TailwindCSS TypeScript .cursorrules prompt file

JavaScript TypeScript Code Quality .cursorrules prompt file

Plasticode Telegram API .cursorrules prompt file

ES Module Node.js Guidelines .cursorrules prompt file

Cursor Tip

Here is a quick example of leveraging the .cursorrules file (sys

Cursor Tip

Cursor Tip

Cursor Tip

Create a Chrome Extension Fast: Cursor AI Tutorial

Build ChatGPT with Python: Cursor AI Tutorial Guide

Build AI Voice Notes App: Cursor AI Tutorial Guide

Cursor AI Tutorial: Easy Loading Page with Shadcn Components