chore: Various updates

Author: Stranger6667

.github/workflows/build.yml

@@ -22,11 +22,11 @@ jobs:
     name: Generic pre-commit checks
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 1
 
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v4
         with:
           python-version: 3.9
 
@@ -37,11 +37,11 @@ jobs:
     name: Test (stable)
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: true
 
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v4
         with:
           python-version: 3.7
 
@@ -62,7 +62,7 @@ jobs:
     name: Rustfmt
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
@@ -76,7 +76,7 @@ jobs:
     name: Clippy
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
@@ -90,7 +90,7 @@ jobs:
     name: MSRV
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
@@ -109,10 +109,10 @@ jobs:
     name: Python ${{ matrix.python-version }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: true
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
           architecture: x64
@@ -133,7 +133,7 @@ jobs:
     name: Tests for WASM crate
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: true
       - uses: actions-rs/toolchain@v1
@@ -154,7 +154,7 @@ jobs:
     name: TypeScript tests for WASM crate
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: true
       - uses: actions-rs/toolchain@v1
@@ -181,7 +181,7 @@ jobs:
     name: Check features
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: true
       - uses: actions-rs/toolchain@v1
@@ -197,19 +197,16 @@ jobs:
     name: Code coverage
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: true
 
-      - name: Toolchain setup
-        uses: actions-rs/toolchain@v1
+      - uses: actions-rs/toolchain@v1
         with:
-          toolchain: nightly
+          profile: minimal
+          toolchain: stable
           override: true
 
-      - name: Install `cargo-tarpaulin`
-        run: cargo install cargo-tarpaulin
-
       - name: Cache cargo
         uses: actions/cache@v3
         with:
@@ -219,7 +216,10 @@ jobs:
             target
           key: coverage-cargo-cache
 
-      - uses: actions/setup-python@v2
+      - name: Install cargo-llvm-cov
+        uses: taiki-e/install-action@cargo-llvm-cov
+
+      - uses: actions/setup-python@v4
         with:
           python-version: 3.7
 
@@ -229,15 +229,18 @@ jobs:
           # Starts the server in background
           python ./css-inline/tests/server.py &
 
-      - name: Run tests
-        run: cargo tarpaulin --verbose --all-features --out Xml
+      - name: Generate code coverage
+        run: cargo llvm-cov --all-features --lcov --output-path lcov.info
         working-directory: ./css-inline
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
         if: ${{ env.GITHUB_REPOSITORY }} == 'Stranger6667/css-inline'
         with:
+          token: ${{ secrets.CODECOV_TOKEN }}
           name: coverage
+          files: lcov.info
+          fail_ci_if_error: true
 
   fuzz:
     name: Fuzz

.github/workflows/rust-release.yml

@@ -9,7 +9,7 @@ jobs:
   rust-release:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal

.github/workflows/wasm-release.yml

@@ -9,7 +9,7 @@ jobs:
   wasm-release:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
-        exclude: ^.*\.(md|rst)$
+        exclude: test_inlining.rs
       - id: mixed-line-ending
         args: [--fix=lf]
       - id: check-merge-conflict

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## [Unreleased]
 
+### Changed
+
+- Replace `remove_style_tags` with `keep_style_tags`.
+
+### Removed
+
+- The `inline_style_tags` configuration option.
+
 ## [0.9.0] - 2023-06-10
 
 ### Fixed

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # css-inline contribution guidelines
 
-Thank you for your interest in making `css-inline` better! 
+Thank you for your interest in making `css-inline` better!
 We'd love to have your contribution. We expect all contributors to
 abide by the [Contributor Covenant Code of Conduct], which you can find in the
 [`CODE_OF_CONDUCT.md`] file in this repository.
@@ -9,7 +9,7 @@ abide by the [Contributor Covenant Code of Conduct], which you can find in the
 
 ## License
 
-The code in this project is licensed under MIT license. 
+The code in this project is licensed under MIT license.
 By contributing to `css-inline`, you agree that your contributions will be licensed under its MIT license.
 
 ## Pull Requests

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2021 Dmitry Dygalo
+Copyright (c) 2020-2023 Dmitry Dygalo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,14 +1,16 @@
 # css-inline
 
-[![ci](https://github.com/Stranger6667/css-inline/workflows/ci/badge.svg)](https://github.com/Stranger6667/css-inline/actions)
-[![codecov](https://codecov.io/gh/Stranger6667/css-inline/branch/master/graph/badge.svg)](https://codecov.io/gh/Stranger6667/css-inline)
-[![Crates.io](https://img.shields.io/crates/v/css-inline.svg)](https://crates.io/crates/css-inline)
-[![docs.rs](https://docs.rs/css-inline/badge.svg)](https://docs.rs/css-inline/)
-[![gitter](https://img.shields.io/gitter/room/Stranger6667/css-inline.svg)](https://gitter.im/Stranger6667/css-inline)
+[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/Stranger6667/css-inline/build.yml?style=flat-square&labelColor=555555&logo=github" height="20">](https://github.com/Stranger6667/css-inline)
+[<img alt="crates.io" src="https://img.shields.io/crates/v/css-inline.svg?style=flat-square&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/css-inline)
+[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-css_inline-66c2a5?style=flat-square&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/css-inline)
+[<img alt="codecov.io" src="https://img.shields.io/codecov/c/gh/Stranger6667/css-inline?logo=codecov&style=flat-square&token=tOzvV4kDY0" height="20">](https://app.codecov.io/github/Stranger6667/css-inline)
+[<img alt="gitter" src="https://img.shields.io/gitter/room/Stranger6667/css-inline?style=flat-square" height="20">](https://gitter.im/Stranger6667/css-inline)
 
-A crate for inlining CSS into HTML documents. It is built with Mozilla's Servo project components. 
+`css-inline` is a crate that inlines CSS into HTML documents, built using components from Mozilla's Servo project.
 
-When you send HTML emails, you need to use "style" attributes instead of "style" tags. For example, this HTML:
+This process is essential for sending HTML emails as you need to use "style" attributes instead of "style" tags.
+
+For instance, the crate transforms HTML like this:
 
 ```html
 <html>
@@ -22,7 +24,7 @@ When you send HTML emails, you need to use "style" attributes instead of "style"
 </html>
 ```
 
-Will be turned into this:
+into:
 
 ```html
 <html>
@@ -35,13 +37,16 @@ Will be turned into this:
 </html>
 ```
 
-To use it in your project add the following line to your `dependencies` section in the project's `Cargo.toml` file:
+## Installation
+
+To include it in your project, add the following line to the dependencies section in your project's `Cargo.toml` file:
 
 ```toml
+[dependencies]
 css-inline = "0.9"
 ```
 
-Minimum Supported Rust Version is 1.60.
+The Minimum Supported Rust Version is 1.60.
 
 ## Usage
 
@@ -80,13 +85,13 @@ fn main() -> Result<(), css_inline::InlineError> {
 }
 ```
 
-- `inline_style_tags`. Whether to inline CSS from "style" tags. Default: `true`
-- `remove_style_tags`. Remove "style" tags after inlining. Default: `false`
-- `base_url`. Base URL to resolve relative URLs. If you'd like to load stylesheets from your filesystem, use the `file://` scheme. Default: `None`
-- `load_remote_stylesheets`. Whether remote stylesheets should be loaded or not. Default: `true`
-- `extra_css`. Additional CSS to inline. Default: `None`
+- `keep_style_tags`. Specifies whether to keep "style" tags after inlining. Default: `false`
+- `base_url`. The base URL used to resolve relative URLs. If you'd like to load stylesheets from your filesystem, use the `file://` scheme. Default: `None`
+- `load_remote_stylesheets`. Specifies whether remote stylesheets should be loaded. Default: `true`
+- `extra_css`. Extra CSS to be inlined. Default: `None`
+- `preallocate_node_capacity`. **Advanced**. Preallocates capacity for HTML nodes during parsing. This can improve performance when you have an estimate of the number of nodes in your HTML document. Default: `8`
 
-If you'd like to skip CSS inlining for an HTML tag, add `data-css-inline="ignore"` attribute to it:
+You can also skip CSS inlining for an HTML tag by adding the `data-css-inline="ignore"` attribute to it:
 
 ```html
 <head>
@@ -100,7 +105,7 @@ If you'd like to skip CSS inlining for an HTML tag, add `data-css-inline="ignore
 </html>
 ```
 
-This attribute also allows you to skip `link` and `style` tags:
+The `data-css-inline="ignore"` attribute also allows you to skip `link` and `style` tags:
 
 ```html
 <head>
@@ -114,18 +119,33 @@ This attribute also allows you to skip `link` and `style` tags:
 </html>
 ```
 
+If you'd like to load stylesheets from your filesystem, use the `file://` scheme:
+
+```rust
+const HTML: &str = "...";
+
+fn main() -> Result<(), css_inline::InlineError> {
+    let base_url = css_inline::Url::parse("file://styles/email/").expect("Invalid URL");
+    let inliner = css_inline::CSSInliner::options()
+        .base_url(Some(base_url))
+        .build();
+    let inlined = inliner.inline(HTML);
+    // Do something with inlined HTML, e.g. send an email
+    Ok(())
+}
+```
+
 ## Standards support & restrictions
 
-`css-inline` is built on top of [cssparser](https://crates.io/crates/cssparser) and relies on its behavior for CSS parsing.
-Notably:
+`css-inline` is built on top of [html5ever](https://crates.io/crates/html5ever) and [cssparser](https://crates.io/crates/cssparser) and relies on their behavior for HTML & CSS parsing.
 
-- Only HTML 5, XHTML is not supported;
-- Only CSS 3;
-- Only UTF-8 for string representation. Other document encodings are not yet supported.
+- Only HTML 5 is supported, not XHTML.
+- Only CSS 3 is supported.
+- Only UTF-8 encoding for string representation. Other document encodings are not yet supported.
 
 ## Bindings
 
-There are bindings for Python and WebAssembly in the `bindings` directory.
+We provide bindings for Python and WebAssembly. Check the `bindings` directory for more information.
 
 ## Command Line Interface
 
@@ -148,23 +168,23 @@ ARGS:
         HTML tags, according to the corresponding CSS selectors.
         When multiple documents are specified, they will be
         processed in parallel, and each inlined file will be saved
-        with "inlined." prefix. E.g., for "example.html", there
-        will be "inlined.example.html".
+        with an "inlined." prefix. For example, for "example.html",
+        there will be "inlined.example.html".
 
 OPTIONS:
     --inline-style-tags
-        Whether to inline CSS from "style" tags. The default
-        value is `true`. To disable inlining from "style" tags
-        use `--inline-style-tags=false`.
+        Specifies whether to inline CSS from "style" tags.
+        To disable inlining from "style" tags use
+        `--inline-style-tags=false`.
 
-    --remove-style-tags
-        Remove "style" tags after inlining.
+    --keep-style-tags
+        Keep "style" tags after inlining.
 
     --base-url
-        Used for loading external stylesheets via relative URLs.
+        The base URL used to resolve relative URLs.
 
     --load-remote-stylesheets
-        Whether remote stylesheets should be loaded or not.
+        Specifies if remote stylesheets should be loaded or not.
 
     --extra-css
         Additional CSS to inline.
@@ -175,11 +195,15 @@ OPTIONS:
 
 ## Extra materials
 
-If you want to know how this library was created & how it works internally, you could take a look at these articles:
+If you're interested in learning how this library was created and how it works internally, check out these articles:
 
 - [Rust crate](https://dygalo.dev/blog/rust-for-a-pythonista-2/)
 - [Python bindings](https://dygalo.dev/blog/rust-for-a-pythonista-3/)
 
 ## Support
 
-If you have anything to discuss regarding this library, please, join our [gitter](https://gitter.im/Stranger6667/css-inline)!
+If you have any questions or discussions related to this library, please join our [gitter](https://gitter.im/Stranger6667/css-inline)!
+
+## License
+
+This project is licensed under the terms of the <a href="LICENSE">MIT license</a>.