Rename options to match minify_html v0.15.0

monosans · monosans · commit 5a197314ddc6 · 2023-12-26T20:54:48.000+03:00
diff --git a/README.md b/README.md
@@ -21,41 +21,29 @@ plugins:
   - minify_html
 ```
 
-## Default options
+## Options
 
-The default options aim for the best possible minification while maintaining compliance with the specification.
+A description of all options is available in the [minify_html docs](https://docs.rs/minify-html/0.15.0/minify_html/struct.Cfg.html#fields).
+
+The default plugin options are aimed at the best possible minification while maintaining compliance with the specification:
 
 ```yaml
 plugins:
   - search
   - minify_html:
-      # Allow unquoted attribute values in the output to contain characters prohibited by the WHATWG specification (https://html.spec.whatwg.org/multipage/syntax.html#attributes-2). These will still be parsed correctly by almost all browsers.
-      allow_noncompliant_unquoted_attribute_values: false
-      # Allow removing_spaces between attributes when possible, which may not be spec compliant. These will still be parsed correctly by almost all browsers.
-      allow_removing_spaces_between_attributes: false
-      # Do not omit closing tags when possible.
+      do_not_minify_doctype: true
+      ensure_spec_compliant_unquoted_attribute_values: true
       keep_closing_tags: false
-      # Keep all comments.
-      keep_comments: false
-      # Do not omit `<html>` and `<head>` opening tags when they don't have attributes.
       keep_html_and_head_opening_tags: false
-      # Keep `type=text` attribute name and value on `<input>` elements.
+      keep_spaces_between_attributes: true
+      keep_comments: false
       keep_input_type_text_attr: true
-      # Keep SSI comments.
       keep_ssi_comments: false
-      # Minify CSS in `<style>` tags and `style` attributes using lightningcss (https://github.com/parcel-bundler/lightningcss).
-      minify_css: true
-      # Minify DOCTYPEs. Minified DOCTYPEs may not be spec compliant, but will still be parsed correctly by almost all browsers.
-      minify_doctype: false
-      # Minify JavaScript in `<script>` tags using minify-js (https://github.com/wilsonzlin/minify-js).
-      minify_js: true
-      # When `{{`, `{#`, or `{%` are seen in content, all source code until the subsequent matching closing `}}`, `#}`, or `%}` respectively gets piped through untouched.
       preserve_brace_template_syntax: false
-      # When `<%` is seen in content, all source code until the subsequent matching closing `%>` gets piped through untouched.
       preserve_chevron_percent_template_syntax: false
-      # Remove all bangs.
+      minify_css: true
+      minify_js: true
       remove_bangs: false
-      # Remove all processing instructions.
       remove_processing_instructions: false
 ```
 
diff --git a/python/mkdocs_minify_html_plugin/_minify_html.pyi b/python/mkdocs_minify_html_plugin/_minify_html.pyi
@@ -2,19 +2,18 @@ def minify(
     code: str,
     /,
     *,
-    allow_noncompliant_unquoted_attribute_values: bool,
-    # allow_optimal_entities: bool,
-    allow_removing_spaces_between_attributes: bool,
+    do_not_minify_doctype: bool,
+    ensure_spec_compliant_unquoted_attribute_values: bool,
     keep_closing_tags: bool,
-    keep_comments: bool,
     keep_html_and_head_opening_tags: bool,
+    keep_spaces_between_attributes: bool,
+    keep_comments: bool,
     keep_input_type_text_attr: bool,
     keep_ssi_comments: bool,
-    minify_css: bool,
-    minify_doctype: bool,
-    minify_js: bool,
     preserve_brace_template_syntax: bool,
     preserve_chevron_percent_template_syntax: bool,
+    minify_css: bool,
+    minify_js: bool,
     remove_bangs: bool,
     remove_processing_instructions: bool,
 ) -> str: ...
diff --git a/python/mkdocs_minify_html_plugin/plugin.py b/python/mkdocs_minify_html_plugin/plugin.py
@@ -14,19 +14,18 @@
 
 
 class MinifyHtmlConfig(Config):
-    allow_noncompliant_unquoted_attribute_values = c.Type(bool, default=False)
-    # allow_optimal_entities = c.Type(bool, default=False)
-    allow_removing_spaces_between_attributes = c.Type(bool, default=False)
+    do_not_minify_doctype = c.Type(bool, default=True)
+    ensure_spec_compliant_unquoted_attribute_values = c.Type(bool, default=True)
     keep_closing_tags = c.Type(bool, default=False)
-    keep_comments = c.Type(bool, default=False)
     keep_html_and_head_opening_tags = c.Type(bool, default=False)
+    keep_spaces_between_attributes = c.Type(bool, default=True)
+    keep_comments = c.Type(bool, default=False)
     keep_input_type_text_attr = c.Type(bool, default=True)
     keep_ssi_comments = c.Type(bool, default=False)
-    minify_css = c.Type(bool, default=True)
-    minify_doctype = c.Type(bool, default=False)
-    minify_js = c.Type(bool, default=True)
     preserve_brace_template_syntax = c.Type(bool, default=False)
     preserve_chevron_percent_template_syntax = c.Type(bool, default=False)
+    minify_css = c.Type(bool, default=True)
+    minify_js = c.Type(bool, default=True)
     remove_bangs = c.Type(bool, default=False)
     remove_processing_instructions = c.Type(bool, default=False)
 
diff --git a/src/lib.rs b/src/lib.rs
@@ -7,57 +7,53 @@ use pyo3::prelude::*;
     code,
     /,
     *,
-    allow_noncompliant_unquoted_attribute_values,
-    // allow_optimal_entities,
-    allow_removing_spaces_between_attributes,
+    do_not_minify_doctype,
+    ensure_spec_compliant_unquoted_attribute_values,
     keep_closing_tags,
-    keep_comments,
     keep_html_and_head_opening_tags,
+    keep_spaces_between_attributes,
+    keep_comments,
     keep_input_type_text_attr,
     keep_ssi_comments,
-    minify_css,
-    minify_doctype,
-    minify_js,
     preserve_brace_template_syntax,
     preserve_chevron_percent_template_syntax,
+    minify_css,
+    minify_js,
     remove_bangs,
-    remove_processing_instructions
+    remove_processing_instructions,
 ))]
 fn minify(
     py: Python,
     code: &str,
-    allow_noncompliant_unquoted_attribute_values: bool,
-    // allow_optimal_entities: bool,
-    allow_removing_spaces_between_attributes: bool,
+    do_not_minify_doctype: bool,
+    ensure_spec_compliant_unquoted_attribute_values: bool,
     keep_closing_tags: bool,
-    keep_comments: bool,
     keep_html_and_head_opening_tags: bool,
+    keep_spaces_between_attributes: bool,
+    keep_comments: bool,
     keep_input_type_text_attr: bool,
     keep_ssi_comments: bool,
-    minify_css: bool,
-    minify_doctype: bool,
-    minify_js: bool,
     preserve_brace_template_syntax: bool,
     preserve_chevron_percent_template_syntax: bool,
+    minify_css: bool,
+    minify_js: bool,
     remove_bangs: bool,
     remove_processing_instructions: bool,
 ) -> String {
     py.allow_threads(move || {
         let cfg = ::minify_html::Cfg {
-            do_not_minify_doctype: !minify_doctype,
-            ensure_spec_compliant_unquoted_attribute_values:
-                !allow_noncompliant_unquoted_attribute_values,
+            do_not_minify_doctype,
+            ensure_spec_compliant_unquoted_attribute_values,
             keep_closing_tags,
-            keep_comments,
             keep_html_and_head_opening_tags,
+            keep_spaces_between_attributes,
+            keep_comments,
             keep_input_type_text_attr,
-            keep_spaces_between_attributes:
-                !allow_removing_spaces_between_attributes,
             keep_ssi_comments,
-            minify_css,
-            minify_js,
             preserve_brace_template_syntax,
             preserve_chevron_percent_template_syntax,
+            minify_css,
+            minify_js,
             remove_bangs,
             remove_processing_instructions,
         };
