rhysd / monolith-of-web

A chrome extension to make a single static HTML file of the web page using a WebAssembly port of monolith CLI

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

'Monolith of Web': Chrome Extension Port of Monolith

'Monolith of Web' is a Chrome extension ported from CLI tool Monolith. Monolith is a CLI tool to download a web page as static single HTML file. 'Monolith of Web' provides the same functionality as a browser extension by compiling Monolith (written in Rust) into WebAssembly.

usage screenshot

Installation

Usage

popup screenshot

  1. Go to a web page you want to store
  2. Click 'Monolith of Web' icon in a browser bar (above popup window will open)
  3. Click 'Get Monolith' button
  4. Wait for the process completing
  5. The generated single static HTML file is stored in your downloads folder

By toggling icons at bottom of the popup window, you can determine to or not to include followings in the generated HTML file.

  • JavaScript
  • CSS
  • <iframe/>
  • Images

The button at right-bottom toggles if allow CORS request or not. Please read following 'Permissions' section and 'CORS Requests in Background Page' section for more details.

Permissions

  • Required permissions
    • activeTab: This extension gets an HTML text and a page title from the active tab to generate a monolith
    • storage: This extension remembers the last state of toggle buttons at bottom in the popup window.
  • Optional permissions
    • http://*/* and https://*/*: Allow any cross-origin requests in background page. This is runtime permission so this extension does not require by default. Only when you see a broken HTML file is generated due to CORS error in background page, please enable this option. The reason of these permissions are explained in next 'CORS Requests in Background Page' section.

CORS Requests in Background Page

This extension generates a single HTML file in background page of Chrome extension. Since CSP in a content script is not applied in a background page, some resources in content's HTML cannot be fetched in background page.

By default, this extension ignores CORS errors in background page. It is usually not a problem since resources protected by CSP are usually scripts which don't affect main content. But a broken single HTML page may be generated due to CORS errors.

When you see a broken page due to the CORS error in background page, please enable 'allow CORS requests' button at right-bottom in the popup window. Permission dialog will appear to require permissions for sending CORS requests in background page. After accepting it, CORS request error is disabled and all resources should be fetched with no error.

After generating a single HTML file with the runtime permissions, this extension will remove the permissions as soon as possible for security.

Development

WebAssembly port of Monolith is developed in the forked repository. Currently it has some differences and duplicates against the original repository. reqwest did not support Wasm before 0.10.0 so my Wasm port does not use it and uses fetch() directly via js_sys and web_sys crate.

This repository adds the forked Monolith repository as a Git submodule and uses it by bundling sources with Webpack.

Contributing

Creating an issue

Before reporting an issue, please try the same URL with CLI version. If it is reproducible with CLI version, please report it to the CLI repository at first.

If it is not reproducible with CLI version (it means the issue only occurs with this extension), please report it from issues page.

Improve Wasm part

This repository only includes TypeScript part of extension. Wasm part is developed in forked monolith repository. If your improvement can be applied to upstream, please make a pull request in the upstream at first. After the pull request is merged, please make an issue to request to merge upstream at this repository or the forked repository.

License

Distributed under the MIT license.

About

A chrome extension to make a single static HTML file of the web page using a WebAssembly port of monolith CLI

License:MIT License


Languages

Language:TypeScript 81.0%Language:HTML 16.2%Language:CSS 2.8%