Skip to content

Commit 0690ab4

Browse files
committed
docs: update README and CLAUDE.md for v0.4.0 release
- Added SSR/SSG feature to README features list - Updated element support count (30+ elements) - Updated version references from 0.3.1 to 0.4.0 - Updated test count to 258 tests - Listed v0.4.0 major improvements Authored by: Aaron Lippold<lippold@gmail.com>
1 parent 0530671 commit 0690ab4

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

CLAUDE.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
44

55
## Project Overview
66

7-
Nuxt SmartScript is a Nuxt 3 module that performs automatic typography transformations in the browser. It transforms patterns like (TM) → ™, ordinals (1st, 2nd), chemical formulas (H2O), and mathematical notation (x^2, x_n) using client-side DOM manipulation.
7+
Nuxt SmartScript is a Nuxt 3 module that performs automatic typography transformations both server-side and client-side. It transforms patterns like (TM) → ™, ordinals (1st, 2nd), chemical formulas (H2O), and mathematical notation (x^2, x_n) using DOM manipulation.
88

9-
**Current Version**: 0.3.0 (broken) → 0.3.1 (ready for release)
9+
**Current Version**: 0.3.0 → 0.4.0 (ready for release with SSR support)
1010

1111
## Critical Implementation Details
1212

@@ -50,7 +50,7 @@ pnpm prepack
5050

5151
### Testing
5252
```bash
53-
# Run all tests (227 tests across all categories)
53+
# Run all tests (258 tests across all categories)
5454
pnpm test
5555

5656
# Run tests in watch mode
@@ -213,7 +213,7 @@ Test helpers in `test/helpers/setup.ts` provide utilities:
213213
- `createTestConfig()` - Config generation
214214
- `countTransformedElements()` - Verification helpers
215215

216-
All 227 tests must pass before committing.
216+
All 258 tests must pass before committing.
217217

218218
## Key Technical Considerations
219219

@@ -265,12 +265,14 @@ The module is configured for npm publishing:
265265
- Entry: `dist/module.mjs`
266266
- Types: `dist/types.d.mts`
267267
- Build: `pnpm prepack`
268-
- Current Version: 0.3.0 (has critical bugs)
269-
- Next Version: 0.3.1 (fixes all v0.3.0 issues)
268+
- Current Version: 0.3.0
269+
- Next Version: 0.4.0 (SSR support, expanded selectors)
270270
- License: Apache-2.0
271271

272-
### v0.3.1 Critical Fixes
273-
- Fixed config merging to include all properties (cssVariables were missing)
274-
- Implemented hybrid element approach (SPAN for TM/R, SUP/SUB for others)
275-
- Fixed registered symbol to use superscript
276-
- Updated all tests for new element types
272+
### v0.4.0 Major Improvements
273+
- Full SSR/SSG support using jsdom in nitro plugin
274+
- Expanded selector coverage (30+ HTML elements)
275+
- Fixed navigation bug (missing selectors like p, li, td, th)
276+
- DRY improvement with shared-defaults.ts
277+
- Fixed runtime config access with useRuntimeConfig from #imports
278+
- All 258 tests passing

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,12 @@ Smart typography transformations for Nuxt - automatic superscript, subscript, an
1717
- 🔢 **Ordinal Numbers** - 1st, 2nd, 3rd with proper superscript
1818
- 🧪 **Chemical Formulas** - H2O, CO2 with subscripts
1919
- 📐 **Mathematical Notation** - x^2 superscript, x_1 subscript
20-
-**Performance Optimized** - Debounced processing, batch updates
21-
- 🎨 **Fully Customizable** - Adjust positioning for different fonts
20+
- 🚀 **Full SSR/SSG Support** - Server-side rendering and static generation (v0.4.0+)
21+
- 🎯 **30+ HTML Elements** - Headings, paragraphs, lists, tables, links, and more
22+
-**Performance Optimized** - Debounced processing, batch updates, caching
23+
- 🎨 **Fully Customizable** - CSS variables and configurable selectors
2224
-**Accessible** - Proper ARIA labels for screen readers
23-
- 🔧 **TypeScript Support** - Full type safety
25+
- 🔧 **TypeScript Support** - Full type safety with module builder
2426

2527
## Quick Setup
2628

0 commit comments

Comments
 (0)