portapack 0.3.2 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/README.md +5 -39
- package/dist/cli/cli-entry.cjs.map +1 -1
- package/dist/index.js.map +1 -1
- package/docs/.vitepress/config.ts +2 -0
- package/docs/architecture.md +186 -0
- package/docs/getting-started.md +1 -2
- package/docs/roadmap.md +233 -0
- package/examples/main.ts +0 -22
- package/package.json +1 -1
- package/src/core/bundler.ts +0 -2
- package/src/core/extractor.ts +0 -5
- package/tsup.config.ts +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
## [0.3.3](https://github.com/manicinc/portapack/compare/v0.3.2...v0.3.3) (2025-04-20)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* typo in link ([e79e1d1](https://github.com/manicinc/portapack/commit/e79e1d105f800550d067d62ec04d0af6888eb82d))
|
|
7
|
+
|
|
1
8
|
## [0.3.2](https://github.com/manicinc/portapack/compare/v0.3.1...v0.3.2) (2025-04-18)
|
|
2
9
|
|
|
3
10
|
|
package/README.md
CHANGED
|
@@ -19,6 +19,8 @@ _Minimal input. Maximal output._
|
|
|
19
19
|
- [⚙️ CLI Reference](https://manicinc.github.io/portapack/cli)
|
|
20
20
|
- [🛠 Configuration Guide](https://manicinc.github.io/portapack/configuration)
|
|
21
21
|
- [💻 API Reference](https://manicinc.github.io/portapack/api/)
|
|
22
|
+
- [🏛️ Architecture](https://manicinc.github.io/portapack/architecture/)
|
|
23
|
+
- [🚧 Roadmap](https://manicinc.github.io/portapack/roadmap/)
|
|
22
24
|
- [🤝 Contributing Guidelines](https://manicinc.github.io/portapack/contributing)
|
|
23
25
|
|
|
24
26
|
## 🚀 Quick Start
|
|
@@ -33,26 +35,6 @@ npm install -g portapack
|
|
|
33
35
|
npx portapack ./index.html -o bundle.html
|
|
34
36
|
```
|
|
35
37
|
|
|
36
|
-
### 🧰 CLI Options
|
|
37
|
-
|
|
38
|
-
```bash
|
|
39
|
-
portapack [input] [options]
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
| Option | Description |
|
|
43
|
-
| ---------------------- | --------------------------------------- |
|
|
44
|
-
| `-o, --output <file>` | Output file path |
|
|
45
|
-
| `-r, --recursive [n]` | Crawl site up to n levels deep |
|
|
46
|
-
| `--max-depth <n>` | Explicit crawl depth |
|
|
47
|
-
| `-m, --minify` | Enable all minification |
|
|
48
|
-
| `--no-minify-*` | Disable html, css, or js minify |
|
|
49
|
-
| `-e, --embed-assets` | Inline all assets (default: true) |
|
|
50
|
-
| `--no-embed-assets` | Leave links as-is |
|
|
51
|
-
| `-b, --base-url <url>` | Override base URL resolution |
|
|
52
|
-
| `-v, --verbose` | Show debug output |
|
|
53
|
-
| `--log-level <lvl>` | Set log level: debug, info, warn, error |
|
|
54
|
-
| `-d, --dry-run` | Run without writing file |
|
|
55
|
-
|
|
56
38
|
### 📋 CLI Examples
|
|
57
39
|
|
|
58
40
|
```bash
|
|
@@ -93,6 +75,7 @@ console.log(result.html); // bundled HTML
|
|
|
93
75
|
|
|
94
76
|
```typescript
|
|
95
77
|
import { pack, LogLevel } from 'portapack';
|
|
78
|
+
import fs from 'fs';
|
|
96
79
|
|
|
97
80
|
const result = await pack('https://example.com', {
|
|
98
81
|
minifyCss: true,
|
|
@@ -101,14 +84,9 @@ const result = await pack('https://example.com', {
|
|
|
101
84
|
output: 'site.html',
|
|
102
85
|
logLevel: LogLevel.INFO,
|
|
103
86
|
});
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
### Save to Disk
|
|
107
87
|
|
|
108
|
-
|
|
109
|
-
import fs from 'fs';
|
|
88
|
+
// Save to disk
|
|
110
89
|
fs.writeFileSync('output.html', result.html);
|
|
111
|
-
```
|
|
112
90
|
|
|
113
91
|
### Advanced API Usage
|
|
114
92
|
|
|
@@ -118,8 +96,7 @@ You can access individual building blocks too:
|
|
|
118
96
|
import {
|
|
119
97
|
generatePortableHTML,
|
|
120
98
|
generateRecursivePortableHTML,
|
|
121
|
-
bundleMultiPageHTML
|
|
122
|
-
fetchAndPackWebPage,
|
|
99
|
+
bundleMultiPageHTML
|
|
123
100
|
} from 'portapack';
|
|
124
101
|
```
|
|
125
102
|
|
|
@@ -127,19 +104,8 @@ import {
|
|
|
127
104
|
| --------------------------------- | ------------------------------------- |
|
|
128
105
|
| `generatePortableHTML()` | Bundle a single file or URL |
|
|
129
106
|
| `generateRecursivePortableHTML()` | Crawl & bundle entire site |
|
|
130
|
-
| `fetchAndPackWebPage()` | Just fetch HTML (no asset processing) |
|
|
131
107
|
| `bundleMultiPageHTML()` | Combine multiple HTMLs with router |
|
|
132
108
|
|
|
133
|
-
## 🤝 Contribute
|
|
134
|
-
|
|
135
|
-
```bash
|
|
136
|
-
# Get started
|
|
137
|
-
git clone https://github.com/manicinc/portapack
|
|
138
|
-
cd portapack
|
|
139
|
-
npm install
|
|
140
|
-
npm run dev
|
|
141
|
-
```
|
|
142
|
-
|
|
143
109
|
## 📊 Project Health
|
|
144
110
|
|
|
145
111
|
| Metric | Value |
|