@neezco/cache 0.1.1 → 0.2.0

package/docs/contributing/scripts.md

@@ -0,0 +1,38 @@
+# Available Scripts
+
+Use these scripts during development:
+
+## Building
+
+| Script             | Purpose                                        |
+| ------------------ | ---------------------------------------------- |
+| `pnpm build`       | Transpiles TypeScript to JavaScript            |
+| `pnpm build:watch` | Watches for changes and rebuilds automatically |
+
+## Linting & Formatting
+
+| Script                 | Purpose                                   |
+| ---------------------- | ----------------------------------------- |
+| `pnpm lint`            | Runs ESLint to detect code quality issues |
+| `pnpm lint:fix`        | Automatically fixes ESLint problems       |
+| `pnpm format:prettier` | Formats the entire codebase with Prettier |
+| `pnpm format:all`      | Runs linting fixes and Prettier together  |
+
+## Type Checking & Validation
+
+| Script           | Purpose                                                                  |
+| ---------------- | ------------------------------------------------------------------------ |
+| `pnpm typecheck` | Runs TypeScript type checker without emitting files                      |
+| `pnpm check:all` | **Run before committing.** Runs formatting and type checking in parallel |
+
+## Testing
+
+| Script               | Purpose                                              |
+| -------------------- | ---------------------------------------------------- |
+| `pnpm test`          | Runs the test suite once                             |
+| `pnpm test:watch`    | Runs tests in watch mode (useful during development) |
+| `pnpm test:coverage` | Generates test coverage reports                      |
+
+---
+
+**Before committing:** Always run `pnpm check:all` to ensure everything passes.

package/docs/contributing/setup.md

@@ -0,0 +1,49 @@
+# Setting Up Your Environment
+
+## Prerequisites
+
+This repository comes pre-configured with:
+
+- **ESLint** for linting
+- **Prettier** for formatting
+- **Husky** for Git hooks
+- **Conventional Commits** validation
+- **Type checking** and **test scripts**
+
+## Installation
+
+1. **Fork and clone** the repository:
+
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/cache.git
+   cd cache
+   ```
+
+2. **Add upstream repository**:
+
+   ```bash
+   git remote add upstream https://github.com/neezco/cache.git
+   ```
+
+3. **Install dependencies**:
+
+   ```bash
+   pnpm install
+   ```
+
+4. **Initialize Husky** for Git hooks:
+
+   ```bash
+   pnpm prepare
+   ```
+
+## What Husky Does
+
+Once initialized, Husky automatically validates your changes:
+
+| Hook           | What it runs                        |
+| -------------- | ----------------------------------- |
+| **Pre-commit** | ESLint, Prettier, and type checking |
+| **Pre-push**   | Full test suite                     |
+
+You're ready to start contributing!

package/docs/contributing/workflow.md

@@ -0,0 +1,71 @@
+# Contribution Workflow
+
+## 1. Create a Feature Branch
+
+```bash
+git checkout -b feat/your-feature-name
+```
+
+Use conventional commit types for branch names:
+
+- `feat/` for features
+- `fix/` for bug fixes
+- `docs/` for documentation
+- `refactor/` for refactoring
+
+## 2. Make Your Changes
+
+Follow the [Code Style Guidelines](code-style.md).
+
+## 3. Verify Your Work
+
+Run the full check suite before committing:
+
+```bash
+pnpm check:all
+```
+
+This runs formatting, linting, and type checking in parallel.
+
+## 4. Commit with Conventional Commits
+
+```bash
+git commit -m "feat: add your feature"
+```
+
+Husky validates your commit message. Use these types:
+
+| Type        | Purpose                                   |
+| ----------- | ----------------------------------------- |
+| `feat:`     | A new feature                             |
+| `fix:`      | A bug fix                                 |
+| `docs:`     | Documentation changes                     |
+| `style:`    | Formatting only (no code changes)         |
+| `refactor:` | Code refactoring without behavior changes |
+| `test:`     | Adding or updating tests                  |
+| `chore:`    | Maintenance tasks (configs, tooling, CI)  |
+
+### Examples
+
+```bash
+git commit -m "feat: add has method to LocalTtlCache"
+git commit -m "fix: prevent expired entries from being returned"
+git commit -m "test: add test coverage for stale window behavior"
+git commit -m "docs: update API reference"
+```
+
+## 5. Push and Create a Pull Request
+
+```bash
+git push origin feat/your-feature-name
+```
+
+Then create a pull request on GitHub:
+
+- Reference any related issues
+- Provide a clear description of your changes
+- Ensure all tests and checks pass
+
+---
+
+**That's it!** The maintainers will review your PR soon.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@neezco/cache",
   "type": "module",
-  "module": "./dist/node/index.mjs",
+  "module": "./dist/browser/index.js",
   "main": "./dist/node/index.cjs",
   "types": "./dist/node/index.d.cts",
   "author": {
@@ -20,7 +20,7 @@
   "exports": {
     ".": {
       "require": "./dist/node/index.cjs",
-      "import": "./dist/node/index.mjs"
+      "import": "./dist/browser/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -89,5 +89,5 @@
     "node": ">=24.12.0",
     "pnpm": ">=10.27.0"
   },
-  "version": "0.1.1"
+  "version": "0.2.0"
 }