Skip to content

Commit b037e6e

Browse files
authored
Merge pull request #6 from Encryptioner/pre/release/1.0.3
Pre/release/1.0.3
2 parents 28a3313 + cda817d commit b037e6e

11 files changed

Lines changed: 328 additions & 50 deletions

.github/PUBLISHING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -625,9 +625,13 @@ For common scenarios like needing to republish with fixes, use the helper script
625625

626626
```bash
627627
./scripts/publish-patch.sh
628+
629+
./scripts/publish-minor.sh
630+
631+
./scripts/publish-major.sh
628632
```
629633

630-
This script handles:
634+
These scripts handles:
631635
- Version bumping
632636
- Tag management
633637
- Committing and pushing

docs/FRAMEWORK_AGNOSTIC_GUIDE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -639,10 +639,10 @@ jobs:
639639

640640
## Benefits
641641

642-
✅ **No Version Conflicts**: Uses project's own dependencies
643-
✅ **Smaller Bundle**: No duplicate dependencies
644-
✅ **Framework Agnostic**: Works with any framework or vanilla JS
645-
✅ **Type Safe**: Full TypeScript support
646-
✅ **Tree Shakeable**: Import only what you need
647-
✅ **Future Proof**: Easy to add more framework adapters
648-
✅ **Wide Node Support**: Works with Node 16-22
642+
- ✅ **No Version Conflicts**: Uses project's own dependencies
643+
- ✅ **Smaller Bundle**: No duplicate dependencies
644+
- ✅ **Framework Agnostic**: Works with any framework or vanilla JS
645+
- ✅ **Type Safe**: Full TypeScript support
646+
- ✅ **Tree Shakeable**: Import only what you need
647+
- ✅ **Future Proof**: Easy to add more framework adapters
648+
- ✅ **Wide Node Support**: Works with Node 16-22

docs/NPM_READY.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -156,16 +156,16 @@ See PUBLISH.md for detailed publishing instructions.
156156

157157
## Key Features
158158

159-
**Framework Agnostic** - Works with React, Vue, Svelte, or vanilla JS
160-
**Multi-page PDFs** - Automatic page splitting with smart pagination
161-
**GoFullPage Approach** - Captures full content height, no viewport limits
162-
**TypeScript First** - Full type definitions included
163-
**Tree Shakeable** - Import only what you need
164-
**Zero Config** - Works out of the box with sensible defaults
165-
**Progress Tracking** - Real-time progress callbacks
166-
**Image Handling** - SVG conversion, optimization, background images
167-
**Table Support** - Smart table splitting with header repetition
168-
**Device Independent** - Same output on all devices
159+
- **Framework Agnostic** - Works with React, Vue, Svelte, or vanilla JS
160+
- **Multi-page PDFs** - Automatic page splitting with smart pagination
161+
- **GoFullPage Approach** - Captures full content height, no viewport limits
162+
- **TypeScript First** - Full type definitions included
163+
- **Tree Shakeable** - Import only what you need
164+
- **Zero Config** - Works out of the box with sensible defaults
165+
- **Progress Tracking** - Real-time progress callbacks
166+
- **Image Handling** - SVG conversion, optimization, background images
167+
- **Table Support** - Smart table splitting with header repetition
168+
- **Device Independent** - Same output on all devices
169169

170170
## Package Size
171171

docs/SETUP_SUMMARY.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,14 @@ Comprehensive publishing guide covering:
3333

3434
### 3. Helper Scripts
3535

36-
#### `scripts/publish-patch.sh`
37-
Automated patch version publishing:
36+
#### `scripts/publish-*.sh`
37+
Automated version publishing:
3838
```bash
3939
./scripts/publish-patch.sh
40+
41+
./scripts/publish-minor.sh
42+
43+
./scripts/publish-major.sh
4044
```
4145
- Bumps version
4246
- Manages tags

docs/WEB_SEARCH_IMPLEMENTATION_STATUS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -388,10 +388,10 @@ imageOptions: {
388388

389389
**Version 1.0.0 addresses ALL critical pain points** identified in web research:
390390

391-
**Image Quality** - Completely solved with Phase 4 enhancements
392-
**Text Searchability** - Built-in from day 1
393-
**Core Features** - All high-demand features implemented
394-
**Production Ready** - 50+ exports, full TypeScript, 4 framework adapters
391+
- **Image Quality** - Completely solved with Phase 4 enhancements
392+
- **Text Searchability** - Built-in from day 1
393+
- **Core Features** - All high-demand features implemented
394+
- **Production Ready** - 50+ exports, full TypeScript, 4 framework adapters
395395

396396
The library is **production-ready** and addresses the most common user complaints found in web research. Future enhancements (forms, multi-column, PDF/A) are lower priority features that can be added based on user demand.
397397

documentation/index.md

Lines changed: 29 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -90,20 +90,20 @@ function MyComponent() {
9090

9191
## Key Features at a Glance
9292

93-
**Multi-page support** with smart pagination
94-
**Framework adapters** for React, Vue, Svelte
95-
**OKLCH color support** and Tailwind CSS compatibility
96-
**Image optimization** with SVG conversion & DPI control
97-
**Table pagination** with header repetition
98-
**Watermarks** (text and image)
99-
**Headers/Footers** with dynamic template variables
100-
**PDF Metadata** (title, author, subject, keywords)
101-
**PDF Security** (password protection & permissions)
102-
**PDF Preview** (real-time preview with live updates)
103-
**Media type emulation** (@media print support)
104-
**Full TypeScript support**
105-
**Progress tracking**
106-
**Batch generation** with PDF merging
93+
- **Multi-page support** with smart pagination
94+
- **Framework adapters** for React, Vue, Svelte
95+
- **OKLCH color support** and Tailwind CSS compatibility
96+
- **Image optimization** with SVG conversion & DPI control
97+
- **Table pagination** with header repetition
98+
- **Watermarks** (text and image)
99+
- **Headers/Footers** with dynamic template variables
100+
- **PDF Metadata** (title, author, subject, keywords)
101+
- **PDF Security** (password protection & permissions)
102+
- **PDF Preview** (real-time preview with live updates)
103+
- **Media type emulation** (@media print support)
104+
- **Full TypeScript support**
105+
- **Progress tracking**
106+
- **Batch generation** with PDF merging
107107

108108
---
109109

@@ -114,8 +114,8 @@ documentation/
114114
├── index.md (you are here)
115115
116116
├── guides/
117-
│ ├── getting-started.md # Quick start tutorial
118-
│ ├── installation.md # Installation guide
117+
│ ├── getting-started.md # Quick start tutorial
118+
│ ├── installation.md # Installation guide
119119
│ ├── react-guide.md # React integration
120120
│ ├── vue-guide.md # Vue integration
121121
│ ├── svelte-guide.md # Svelte integration
@@ -125,13 +125,26 @@ documentation/
125125
│ └── troubleshooting.md # Common issues
126126
127127
├── features/
128+
│ └── colors.md # Color support
129+
│ └── images.md # Image support
130+
│ └── page-breaks.md # Handling page break
128131
│ └── multi-page.md # Page splitting
132+
│ └── tables.md # Table support
129133
130134
├── advanced/
135+
│ └── batch-generation.md # Combine multiple content items
136+
│ └── headers-footers.md # Dynamic header/footer templates
131137
│ └── image-optimization.md # DPI control & print quality
138+
│ └── metadata.md # Set document properties
139+
│ └── preview.md # Real-time PDF preview with live updates
140+
│ └── security.md # Password protection & permissions
141+
│ └── url-to-pdf.md # Convert web pages to PDF
142+
│ └── watermarks.md # Add text & image watermarks
132143
133144
├── api/
134145
│ └── options.md # All options
146+
|
147+
├── tutorials/* # Tutorials for react, svelte, vue & vanilla JS
135148
136149
└── examples/
137150
├── code-examples.md # Code samples

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@encryptioner/html-to-pdf-generator",
3-
"version": "1.0.2",
3+
"version": "1.0.3",
44
"description": "Modern multi-page PDF generator from HTML content with smart pagination and styling support",
55
"keywords": [
66
"pdf",

scripts/README.md

Lines changed: 103 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,34 @@
11
# Publishing Scripts
22

3-
Helper scripts for managing package releases.
3+
Helper scripts for managing package releases following semantic versioning.
4+
5+
## Overview
6+
7+
Three scripts automate version bumping and publishing:
8+
- **publish-patch.sh** - Bug fixes (1.0.0 → 1.0.1)
9+
- **publish-minor.sh** - New features (1.0.5 → 1.1.0)
10+
- **publish-major.sh** - Breaking changes (1.5.3 → 2.0.0)
11+
12+
All scripts:
13+
- Automatically calculate the new version
14+
- Commit the version bump
15+
- Clean up any existing tags (from previous failed attempts)
16+
- Create and push new version tag
17+
- Trigger GitHub Actions publish workflow
18+
19+
**Making scripts executable:**
20+
```bash
21+
chmod +x scripts/publish-patch.sh scripts/publish-minor.sh scripts/publish-major.sh
22+
```
423

524
## publish-patch.sh
625

7-
Automates the complete patch version release workflow.
26+
Automates patch version releases for bug fixes and minor improvements.
827

928
**What it does:**
1029
1. Bumps patch version in package.json (e.g., 1.0.0 → 1.0.1)
1130
2. Commits the version bump
12-
3. Deletes old tag if it exists (both local and remote)
31+
3. Deletes NEW version tag if it exists (from previous failed attempt)
1332
4. Creates new version tag
1433
5. Pushes everything to trigger GitHub Actions publish workflow
1534

@@ -21,8 +40,8 @@ Automates the complete patch version release workflow.
2140
**When to use:**
2241
- Publishing bug fixes
2342
- After making workflow/configuration changes
24-
- When you need to republish after fixing issues
25-
- Moving a tag to a newer commit
43+
- Documentation updates
44+
- Performance improvements without API changes
2645

2746
**Prerequisites:**
2847
- All changes committed
@@ -45,14 +64,92 @@ Continue? (y/n) y
4564
4665
Step 1: Updating version to 1.0.1...
4766
Step 2: Committing version bump...
48-
Step 3: Deleting old v1.0.0 tag if it exists...
67+
Step 3: Deleting v1.0.1 tag if it exists (from previous failed attempt)...
4968
Step 4: Creating v1.0.1 tag...
5069
Step 5: Getting current branch...
5170
Step 6: Pushing to remote...
5271
5372
✅ Done!
5473
```
5574

75+
## publish-minor.sh
76+
77+
Automates minor version releases for new features.
78+
79+
**What it does:**
80+
1. Bumps minor version in package.json (e.g., 1.0.5 → 1.1.0)
81+
2. Commits the version bump
82+
3. Deletes NEW version tag if it exists (from previous failed attempt)
83+
4. Creates new version tag
84+
5. Pushes everything to trigger GitHub Actions publish workflow
85+
86+
**Usage:**
87+
```bash
88+
./scripts/publish-minor.sh
89+
```
90+
91+
**When to use:**
92+
- Adding new features
93+
- New framework adapters
94+
- New configuration options
95+
- Backwards-compatible API additions
96+
97+
**Prerequisites:**
98+
- All changes committed
99+
- Clean working directory
100+
- On the correct branch
101+
- New features tested and documented
102+
103+
**Example:**
104+
```
105+
Current: 1.2.5
106+
New: 1.3.0
107+
```
108+
109+
## publish-major.sh
110+
111+
Automates major version releases for breaking changes.
112+
113+
**What it does:**
114+
1. Bumps major version in package.json (e.g., 1.5.3 → 2.0.0)
115+
2. Commits the version bump with BREAKING CHANGE notice
116+
3. Deletes NEW version tag if it exists (from previous failed attempt)
117+
4. Creates new version tag
118+
5. Pushes everything to trigger GitHub Actions publish workflow
119+
120+
**Usage:**
121+
```bash
122+
./scripts/publish-major.sh
123+
```
124+
125+
**When to use:**
126+
- Breaking API changes
127+
- Removing deprecated features
128+
- Major refactoring that affects public API
129+
- Incompatible updates to dependencies
130+
131+
**Prerequisites:**
132+
- All changes committed
133+
- Clean working directory
134+
- **CHANGELOG.md updated with breaking changes**
135+
- **Migration guide prepared**
136+
- Breaking changes reviewed and documented
137+
138+
**Example:**
139+
```
140+
⚠️ WARNING: This is a MAJOR version bump!
141+
142+
Current version: 1.5.3
143+
New version will be: 2.0.0
144+
145+
⚠️ This is a breaking change! Make sure you've:
146+
- Updated CHANGELOG.md with breaking changes
147+
- Updated migration guide
148+
- Reviewed all breaking API changes
149+
150+
Are you sure you want to continue? (y/n)
151+
```
152+
56153
## verify-package.cjs
57154

58155
Verifies package structure before publishing.

0 commit comments

Comments
 (0)