chore: wip

chore: wip

chore: wip

chore: wip

chore: wip

chore: wip

Author: chrisbbreuer

.cursor/rules/code-style.mdc

@@ -0,0 +1,12 @@
+---
+description: Code Style & Structure specifics
+globs: 
+---
+## Code Style & Structure
+
+- Write concise, technical TypeScript code with accurate examples in the docblock
+- If Bun native modules are available, use them
+- Use functional and declarative programming patterns; avoid classes unless needed
+- Prefer iteration and modularization over code duplication
+- Use descriptive variable names with auxiliary verbs (e.g., `isLoading`, `hasError`)
+- Use proper jsdoc comments for functions, types, interfaces, and ensure examples are accurate

.cursor/rules/documentation.mdc

@@ -0,0 +1,9 @@
+---
+description: Documentation specific rules
+globs: docs/**/*.md
+---
+## Documentation
+
+- Write documentation for all functions, types, interfaces, and ensure examples are accurate
+- The `./docs` directory is where the vitepress markdown documentation is stored
+- Make sure to update the docs markdown files

.cursor/rules/error-handling.mdc

@@ -0,0 +1,11 @@
+---
+description: Error Handling and Validation specifics
+globs: 
+---
+## Error Handling and Validation
+
+- Prioritize error handling: handle errors and edge cases early
+- Use early returns and guard clauses
+- Implement proper error logging and user-friendly messages
+- Use error boundaries for unexpected errors
+- when `neverthrow` is available, ensure errors are typed

.cursor/rules/key-conventions.mdc

@@ -0,0 +1,11 @@
+---
+description: Key code conventions
+globs: 
+---
+## Key Conventions
+
+- If there are two equally valid implementations, the browser version should be preferred
+- Aim for 100% test coverage
+- Avoid usage of `any`
+- Reuse eslint-ignore comments where present, unless not needed
+- ensure we log everything properly, including for debug reasons

.cursor/rules/project-structure.mdc

@@ -0,0 +1,11 @@
+---
+description: Project structure information
+globs: 
+---
+## Project Structure
+
+- the `./src` directory is the source code
+- the `./test` directory is the test code
+- the `./bin` directory is the command-line code
+  - you can also call the CLI via `./clarity ...`
+- the `./docs` directory is the documentation

.cursor/rules/readme.mdc

@@ -0,0 +1,5 @@
+---
+description: General information based on the latest ./README.md content
+globs: 
+---
+# ts-security

.cursor/rules/syntax-formatting.mdc

@@ -0,0 +1,9 @@
+---
+description: Syntax and Formatting specifics
+globs: 
+---
+## Syntax and Formatting
+
+- Use the "function" keyword for pure functions
+- Avoid unnecessary curly braces in conditionals; use concise syntax for simple statements
+- Make sure everything is properly commented

.cursor/rules/testing.mdc

@@ -0,0 +1,10 @@
+---
+description: Testing specifics
+globs: 
+---
+## Testing
+
+- Write tests for all functions, types, interfaces, and ensure examples are accurate
+- The `./test` directory is where the tests are stored
+- Use `bun test` to run the tests
+- Use bun native modules for testing from `import { x, y, z } from 'bun:test'`

.cursor/rules/typescript.mdc

@@ -0,0 +1,9 @@
+---
+description: TypeScript Usage specifics
+globs: docs/**/*.md
+---
+## TypeScript Usage
+
+- Use TypeScript for all code; prefer interfaces over types
+- Avoid enums; use `maps` instead, or `as const`
+- Use functional components with TypeScript interfaces

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true