portapack 0.3.0 → 0.3.2

package/.eslintrc.json

@@ -1,9 +1,68 @@
 {
-    "singleQuote": true,
-    "semi": true,
-    "tabWidth": 2,
-    "printWidth": 100,
-    "trailingComma": "es5",
-    "arrowParens": "avoid",
-    "endOfLine": "lf"
-  }
+  // Specifies this is the root config; ESLint won't look higher up.
+  "root": true,
+
+  // Specifies the parser ESLint should use. Needed for TypeScript.
+  "parser": "@typescript-eslint/parser",
+
+  // Configures parser options.
+  "parserOptions": {
+    "ecmaVersion": "latest", // Use the latest ECMAScript features
+    "sourceType": "module" // Use ES modules, matching your package.json "type": "module"
+    // "project": "./tsconfig.json" // Uncomment this line if you want to enable rules that require type information.
+    // This can provide more powerful linting but might slow down linting.
+    // Ensure your tsconfig.json is correctly set up if you enable this.
+  },
+
+  // Defines the global environments available.
+  "env": {
+    "node": true, // Enable Node.js global variables and Node.js scoping.
+    "es2022": true, // Enable ES2022 globals (aligns with ecmaVersion: 'latest').
+    "jest/globals": true // Enable Jest global variables (like describe, it, expect). Requires eslint-plugin-jest.
+  },
+
+  // Specifies plugins to use.
+  "plugins": [
+    "@typescript-eslint", // Plugin for TypeScript-specific linting rules.
+    "jest" // Plugin for Jest-specific linting rules.
+  ],
+
+  // Extends base configurations. Rules are inherited and potentially overridden.
+  "extends": [
+    // Base recommended ESLint rules.
+    "eslint:recommended",
+
+    // Recommended rules from the @typescript-eslint plugin.
+    "plugin:@typescript-eslint/recommended",
+
+    // Recommended rules from the eslint-plugin-jest.
+    "plugin:jest/recommended",
+
+    // IMPORTANT: This MUST be the LAST configuration in the extends array.
+    // It uses 'eslint-config-prettier' to disable ESLint rules that would conflict with Prettier formatting.
+    // This lets Prettier handle all formatting concerns without fighting ESLint.
+    "prettier"
+  ],
+
+  // Custom rules or overrides for rules from extended configs.
+  "rules": {
+    // --- Add specific rule overrides here if needed ---
+    // Example: Warn about unused variables, but allow if prefixed with _
+    // "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }],
+    // Example: Warn instead of error for console logs
+    // "no-console": "warn",
+    // You can turn off specific rules if they are too noisy or don't fit your style:
+    // "@typescript-eslint/no-explicit-any": "off",
+    // Add any other custom rules or overrides here.
+  },
+
+  // Specifies files and directories that ESLint should ignore.
+  "ignorePatterns": [
+    "node_modules/",
+    "dist/", // Your build output directory
+    "coverage/", // Your test coverage directory
+    "docs/.vitepress/dist/", // Your VitePress build output
+    "*.cjs" // Often auto-generated CommonJS wrappers might not need linting
+    // Add any other patterns for generated files or directories
+  ]
+}

package/.github/workflows/ci.yml

@@ -23,11 +23,12 @@ jobs:
           cache: 'npm'
 
       - run: npm ci
-      # - run: npm run test:ci
-      # - run: npm run lint
-      # - run: npm run format:check
-      - run: npm run build # for now we keep it simple to release
+      - run: npm run test:ci
 
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
 # coverage:
 #   needs: build
 #   runs-on: ubuntu-latest

package/.releaserc.js

@@ -1,29 +1,27 @@
 module.exports = {
-    branches: ['main'],
-    plugins: [
-      '@semantic-release/commit-analyzer',
-      '@semantic-release/release-notes-generator',
-      '@semantic-release/npm',
-      [
-        '@semantic-release/github',
-        {
-          assets: [
-            { path: 'dist/**', label: 'Distribution' },
-          ],
-        },
-      ],
-      [
-        '@semantic-release/changelog',
-        {
-          changelogFile: 'CHANGELOG.md',
-        },
-      ],
-      [
-        '@semantic-release/git',
-        {
-          assets: ['package.json', 'CHANGELOG.md'],
-          message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}',
-        },
-      ],
+  branches: ['main'],
+  plugins: [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
+    '@semantic-release/npm',
+    [
+      '@semantic-release/github',
+      {
+        assets: [{ path: 'dist/**', label: 'Distribution' }],
+      },
     ],
-  };
+    [
+      '@semantic-release/changelog',
+      {
+        changelogFile: 'CHANGELOG.md',
+      },
+    ],
+    [
+      '@semantic-release/git',
+      {
+        assets: ['package.json', 'CHANGELOG.md'],
+        message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}',
+      },
+    ],
+  ],
+};

package/CHANGELOG.md

@@ -1,33 +1,26 @@
-# [0.3.0](https://github.com/manicinc/portapack/compare/v0.2.1...v0.3.0) (2025-04-13)
+## [0.3.2](https://github.com/manicinc/portapack/compare/v0.3.1...v0.3.2) (2025-04-18)
 
 
 ### Bug Fixes
 
-* **cli:** fix CLI execution via npx and global install ([88774e8](https://github.com/manicinc/portapack/commit/88774e80d28d0ac9292906ac7454d4528a5396ec))
-
-
-### Features
-
-* api upgrades / revamps; update types; more robust core features and test fixes; update docs ([34e7b4a](https://github.com/manicinc/portapack/commit/34e7b4af55c6c934af8be0f1c43d427fd00a9594))
-
-## [0.2.1](https://github.com/manicinc/portapack/compare/v0.2.0...v0.2.1) (2025-04-11)
+* add mit license ([17ad892](https://github.com/manicinc/portapack/commit/17ad89295c98eee56704841ae25670559874f4fb))
+* cleanup comments; add back in missing tests; fix docs ([1348aab](https://github.com/manicinc/portapack/commit/1348aab5561842e29b6e434d6bb109780b95c486))
+* linting and fix eslintjson ([76edb19](https://github.com/manicinc/portapack/commit/76edb19c96e563c778cadf06a00a27f7171041a2))
+* more formatting ([7730aad](https://github.com/manicinc/portapack/commit/7730aadefc6310a58f483bfcdce2243e3279bdb2))
 
+## [0.3.1](https://github.com/manicinc/portapack/compare/v0.3.0...v0.3.1) (2025-04-14)
 
 ### Bug Fixes
 
-* rmv prepublishOnly for debug release ([6469768](https://github.com/manicinc/portapack/commit/6469768d6c14bd2ab243acfd5358115b7771f612))
+- **ci:** update Codecov config [skip release] ([593b126](https://github.com/manicinc/portapack/commit/593b1262183d05a9a7099463b6da0f4deb916576))
+- **extractor:** resolve test failures and coverage issues ([40ea42c](https://github.com/manicinc/portapack/commit/40ea42cbdbeec67657225c50eb97ef0965cd2769))
 
-# [0.2.0](https://github.com/manicinc/portapack/compare/v0.1.0...v0.2.0) (2025-04-11)
-
-
-### Features
-
-* cleanup rerelease ([f8e599b](https://github.com/manicinc/portapack/commit/f8e599b596b18c62941e5bd46740283b013262b1))
+# [0.3.0](https://github.com/manicinc/portapack/compare/v0.2.1...v0.3.0) (2025-04-13)
 
-# [1.2.0](https://github.com/manicinc/portapack/compare/v1.1.0...v1.2.0) (2025-04-11)
+### Bug Fixes
 
+- **cli:** fix CLI execution via npx and global install ([88774e8](https://github.com/manicinc/portapack/commit/88774e80d28d0ac9292906ac7454d4528a5396ec))
 
 ### Features
 
-* cleanup rerelease ([f8e599b](https://github.com/manicinc/portapack/commit/f8e599b596b18c62941e5bd46740283b013262b1))
-* fix right version; trigger first release ([96147fc](https://github.com/manicinc/portapack/commit/96147fc61f5dc8e8f39e9d4343e22c79b25f0139))
+- api upgrades / revamps; update types; more robust core features and test fixes; update docs ([34e7b4a](https://github.com/manicinc/portapack/commit/34e7b4af55c6c934af8be0f1c43d427fd00a9594))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2025] [Manic.agency]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,11 +2,16 @@
 
 [![npm version](https://img.shields.io/npm/v/portapack.svg?style=for-the-badge&logo=npm&color=CB3837)](https://www.npmjs.com/package/portapack)
 [![Build Status](https://img.shields.io/github/actions/workflow/status/manicinc/portapack/ci.yml?branch=master&style=for-the-badge&logo=github)](https://github.com/manicinc/portapack/actions)
-[![Coverage Status](https://img.shields.io/coveralls/github/manicinc/portapack?style=for-the-badge&logo=codecov)](https://coveralls.io/github/manicinc/portapack)
+[![Codecov](https://img.shields.io/codecov/c/github/manicinc/portapack?style=for-the-badge&logo=codecov)](https://codecov.io/gh/manicinc/portapack)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg?style=for-the-badge)](./LICENSE)
 
-**PortaPack** bundles your entire website — HTML, CSS, JS, images, and fonts — into one  self-contained HTML file. Perfect for snapshots, demos, testing, and offline apps.
+<p align="center">
+  <img src="https://raw.githubusercontent.com/manicinc/portapack/master/docs/public/portapack-transparent.png" alt="PortaPack Logo" width="200"/>
+</p>
 
-*Minimal input. Maximal output.*
+**PortaPack** bundles your entire website — HTML, CSS, JS, images, and fonts — into one self-contained HTML file. Perfect for snapshots, demos, testing, and offline apps.
+
+_Minimal input. Maximal output._
 
 ## 📚 Documentation
 
@@ -34,19 +39,19 @@ npx portapack ./index.html -o bundle.html
 portapack [input] [options]
 ```
 
-| Option | Description |
-|--------|-------------|
-| `-o, --output <file>` | Output file path |
-| `-r, --recursive [n]` | Crawl site up to n levels deep |
-| `--max-depth <n>` | Explicit crawl depth |
-| `-m, --minify` | Enable all minification |
-| `--no-minify-*` | Disable html, css, or js minify |
-| `-e, --embed-assets` | Inline all assets (default: true) |
-| `--no-embed-assets` | Leave links as-is |
-| `-b, --base-url <url>` | Override base URL resolution |
-| `-v, --verbose` | Show debug output |
-| `--log-level <lvl>` | Set log level: debug, info, warn, error |
-| `-d, --dry-run` | Run without writing file |
+| Option                 | Description                             |
+| ---------------------- | --------------------------------------- |
+| `-o, --output <file>`  | Output file path                        |
+| `-r, --recursive [n]`  | Crawl site up to n levels deep          |
+| `--max-depth <n>`      | Explicit crawl depth                    |
+| `-m, --minify`         | Enable all minification                 |
+| `--no-minify-*`        | Disable html, css, or js minify         |
+| `-e, --embed-assets`   | Inline all assets (default: true)       |
+| `--no-embed-assets`    | Leave links as-is                       |
+| `-b, --base-url <url>` | Override base URL resolution            |
+| `-v, --verbose`        | Show debug output                       |
+| `--log-level <lvl>`    | Set log level: debug, info, warn, error |
+| `-d, --dry-run`        | Run without writing file                |
 
 ### 📋 CLI Examples
 
@@ -94,7 +99,7 @@ const result = await pack('https://example.com', {
   minifyJs: false,
   recursive: 2,
   output: 'site.html',
-  logLevel: LogLevel.INFO
+  logLevel: LogLevel.INFO,
 });
 ```
 
@@ -118,21 +123,12 @@ import {
 } from 'portapack';
 ```
 
-| Function | Purpose |
-|----------|---------|
-| `generatePortableHTML()` | Bundle a single file or URL |
-| `generateRecursivePortableHTML()` | Crawl & bundle entire site |
-| `fetchAndPackWebPage()` | Just fetch HTML (no asset processing) |
-| `bundleMultiPageHTML()` | Combine multiple HTMLs with router |
-
-## 🧪 Use Cases
-
-- Archive pages for offline use
-- Create demo bundles without a web server
-- Simplify distribution of small apps
-- QA test static assets
-- Embed pages in PDFs or ebooks
-- Analyze asset weight impact
+| Function                          | Purpose                               |
+| --------------------------------- | ------------------------------------- |
+| `generatePortableHTML()`          | Bundle a single file or URL           |
+| `generateRecursivePortableHTML()` | Crawl & bundle entire site            |
+| `fetchAndPackWebPage()`           | Just fetch HTML (no asset processing) |
+| `bundleMultiPageHTML()`           | Combine multiple HTMLs with router    |
 
 ## 🤝 Contribute
 
@@ -146,10 +142,12 @@ npm run dev
 
 ## 📊 Project Health
 
-(Metrics auto-generated coming soon)
+| Metric      | Value                                                                                                                                                           |
+| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 📦 Version  | [![npm](https://img.shields.io/npm/v/portapack.svg)](https://www.npmjs.com/package/portapack)                                                                   |
+| ✅ Build    | [![Build Status](https://img.shields.io/github/actions/workflow/status/manicinc/portapack/ci.yml?branch=master)](https://github.com/manicinc/portapack/actions) |
+| 🧪 Coverage | [![Codecov](https://img.shields.io/codecov/c/github/manicinc/portapack)](https://codecov.io/gh/manicinc/portapack)                                              |
 
 ## 📄 License
 
-MIT — Built with ✨ by Manic Agency
-
-*Open Source Empowering Designers and Developers 🖥️*
+MIT — Built by Manic.agency

package/commitlint.config.js

@@ -1,36 +1,32 @@
 module.exports = {
-    extends: ['@commitlint/config-conventional'],
-    rules: {
-      'body-leading-blank': [1, 'always'],
-      'body-max-line-length': [2, 'always', 100],
-      'footer-leading-blank': [1, 'always'],
-      'footer-max-line-length': [2, 'always', 100],
-      'header-max-length': [2, 'always', 100],
-      'subject-case': [
-        2,
-        'never',
-        ['sentence-case', 'start-case', 'pascal-case', 'upper-case'],
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'body-leading-blank': [1, 'always'],
+    'body-max-line-length': [2, 'always', 100],
+    'footer-leading-blank': [1, 'always'],
+    'footer-max-line-length': [2, 'always', 100],
+    'header-max-length': [2, 'always', 100],
+    'subject-case': [2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],
+    'subject-empty': [2, 'never'],
+    'subject-full-stop': [2, 'never', '.'],
+    'type-case': [2, 'always', 'lower-case'],
+    'type-empty': [2, 'never'],
+    'type-enum': [
+      2,
+      'always',
+      [
+        'build',
+        'chore',
+        'ci',
+        'docs',
+        'feat',
+        'fix',
+        'perf',
+        'refactor',
+        'revert',
+        'style',
+        'test',
       ],
-      'subject-empty': [2, 'never'],
-      'subject-full-stop': [2, 'never', '.'],
-      'type-case': [2, 'always', 'lower-case'],
-      'type-empty': [2, 'never'],
-      'type-enum': [
-        2,
-        'always',
-        [
-          'build',
-          'chore',
-          'ci',
-          'docs',
-          'feat',
-          'fix',
-          'perf',
-          'refactor',
-          'revert',
-          'style',
-          'test',
-        ],
-      ],
-    },
-  };
+    ],
+  },
+};