Package 'alesia' reference manual

Title:	'HTML' Minifier Middleware for 'Ambiorix'
Description:	'HTML' minifier middleware for 'Ambiorix'.
Authors:	John Coene [aut, cre], Opifex [fnd, cph]
Maintainer:	John Coene <[email protected]>
License:	GPL (>= 2)
Version:	0.0.1.9000
Built:	2025-03-12 23:12:37 UTC
Source:	https://github.com/ambiorix-web/alesia

Alesia

Description

Alesia

Usage

alesia(
  caseSensitive = FALSE,
  collapseBooleanAttributes = TRUE,
  collapseInlineTagWhitespace = TRUE,
  collapseWhitespace = TRUE,
  conservativeCollapse = TRUE,
  continueOnParseError = TRUE,
  customAttrAssign = list(),
  customAttrSurround = list(),
  decodeEntities = FALSE,
  html5 = TRUE,
  includeAutoGeneratedTags = TRUE,
  keepClosingSlash = FALSE,
  minifyCSS = TRUE,
  minifyJS = TRUE,
  minifyURLs = TRUE,
  preserveLineBreaks = FALSE,
  preventAttributesEscaping = FALSE,
  processConditionalComments = FALSE,
  quoteCharacter = "'",
  removeAttributeQuotes = TRUE,
  removeComments = TRUE,
  removeEmptyAttributes = TRUE,
  removeEmptyElements = FALSE,
  removeOptionalTags = FALSE,
  removeRedundantAttributes = FALSE,
  removeScriptTypeAttributes = FALSE,
  removeStyleLinkTypeAttributes = FALSE,
  sortAttributes = FALSE,
  sortClassName = FALSE,
  trimCustomFragments = FALSE,
  useShortDoctype = FALSE
)
alesia(
  caseSensitive = FALSE,
  collapseBooleanAttributes = TRUE,
  collapseInlineTagWhitespace = TRUE,
  collapseWhitespace = TRUE,
  conservativeCollapse = TRUE,
  continueOnParseError = TRUE,
  customAttrAssign = list(),
  customAttrSurround = list(),
  decodeEntities = FALSE,
  html5 = TRUE,
  includeAutoGeneratedTags = TRUE,
  keepClosingSlash = FALSE,
  minifyCSS = TRUE,
  minifyJS = TRUE,
  minifyURLs = TRUE,
  preserveLineBreaks = FALSE,
  preventAttributesEscaping = FALSE,
  processConditionalComments = FALSE,
  quoteCharacter = "'",
  removeAttributeQuotes = TRUE,
  removeComments = TRUE,
  removeEmptyAttributes = TRUE,
  removeEmptyElements = FALSE,
  removeOptionalTags = FALSE,
  removeRedundantAttributes = FALSE,
  removeScriptTypeAttributes = FALSE,
  removeStyleLinkTypeAttributes = FALSE,
  sortAttributes = FALSE,
  sortClassName = FALSE,
  trimCustomFragments = FALSE,
  useShortDoctype = FALSE
)

Arguments

`caseSensitive`	Treat attributes in case sensitive manner (useful for custom HTML tags) \| false \|
`collapseBooleanAttributes`	Omit attribute values from boolean attributes \| false \|
`collapseInlineTagWhitespace`	Don't leave any spaces between display:inline; elements when collapsing. Must be used in conjunction with collapseWhitespace=true \| false \|
`collapseWhitespace`	Collapse white space that contributes to text nodes in a document tree \| false \|
`conservativeCollapse`	Always collapse to 1 space (never remove it entirely). Must be used in conjunction with collapseWhitespace=true \| false \|
`continueOnParseError`	Handle parse errors instead of aborting. \| false \|
`customAttrAssign`	Arrays of regex'es that allow to support custom attribute assign expressions (e.g. `⁠<div flex?="{{mode != cover}}"></div>⁠`) \| [ ] \| [ ]: R:%20
`customAttrSurround`	Arrays of regex'es that allow to support custom attribute surround expressions (e.g. `⁠<input {{#if value}}checked="checked"{{/if}}>⁠`) \| [ ] \| [ ]: R:%20
`decodeEntities`	Use direct Unicode characters whenever possible \| false \|
`html5`	Parse input according to HTML5 specifications \| true \|
`includeAutoGeneratedTags`	Insert tags generated by HTML parser \| true \|
`keepClosingSlash`	Keep the trailing slash on singleton elements \| false \|
`minifyCSS`	Minify CSS in style elements and style attributes (uses clean-css) \| false (could be true, Object, Function(text, type)) \|
`minifyJS`	Minify JavaScript in script elements and event attributes (uses UglifyJS) \| false (could be true, Object, Function(text, inline)) \|
`minifyURLs`	Minify URLs in various attributes (uses relateurl) \| false (could be String, Object, Function(text)) \|
`preserveLineBreaks`	Always collapse to 1 line break (never remove it entirely) when whitespace between tags include a line break. Must be used in conjunction with collapseWhitespace=true \| false \|
`preventAttributesEscaping`	Prevents the escaping of the values of attributes \| false \|
`processConditionalComments`	Process contents of conditional comments through minifier \| false \|
`quoteCharacter`	Type of quote to use for attribute values (' or ") \| \|
`removeAttributeQuotes`	Remove quotes around attributes when possible \| false \|
`removeComments`	Strip HTML comments \| false \|
`removeEmptyAttributes`	Remove all attributes with whitespace-only values \| false (could be true, Function(attrName, tag)) \|
`removeEmptyElements`	Remove all elements with empty contents \| false \|
`removeOptionalTags`	Remove optional tags \| false \|
`removeRedundantAttributes`	Remove attributes when value matches default. \| false \|
`removeScriptTypeAttributes`	Remove type="text/javascript" from script tags. Other type attribute values are left intact \| false \|
`removeStyleLinkTypeAttributes`	Remove type="text/css" from style and link tags. Other type attribute values are left intact \| false \|
`sortAttributes`	Sort attributes by frequency \| false \|
`sortClassName`	Sort style classes by frequency \| false \|
`trimCustomFragments`	Trim white space around ignoreCustomFragments. \| false \|
`useShortDoctype`	Replaces the doctype with the short (HTML5) doctype \| false \|

Minify

Description

Minify HTML.

Usage

minify(
  html,
  caseSensitive = FALSE,
  collapseBooleanAttributes = TRUE,
  collapseInlineTagWhitespace = TRUE,
  collapseWhitespace = TRUE,
  conservativeCollapse = TRUE,
  continueOnParseError = TRUE,
  customAttrAssign = list(),
  customAttrSurround = list(),
  decodeEntities = FALSE,
  html5 = TRUE,
  includeAutoGeneratedTags = TRUE,
  keepClosingSlash = FALSE,
  minifyCSS = TRUE,
  minifyJS = TRUE,
  minifyURLs = TRUE,
  preserveLineBreaks = FALSE,
  preventAttributesEscaping = FALSE,
  processConditionalComments = FALSE,
  quoteCharacter = "'",
  removeAttributeQuotes = TRUE,
  removeComments = TRUE,
  removeEmptyAttributes = TRUE,
  removeEmptyElements = FALSE,
  removeOptionalTags = FALSE,
  removeRedundantAttributes = FALSE,
  removeScriptTypeAttributes = FALSE,
  removeStyleLinkTypeAttributes = FALSE,
  sortAttributes = FALSE,
  sortClassName = FALSE,
  trimCustomFragments = FALSE,
  useShortDoctype = FALSE
)
minify(
  html,
  caseSensitive = FALSE,
  collapseBooleanAttributes = TRUE,
  collapseInlineTagWhitespace = TRUE,
  collapseWhitespace = TRUE,
  conservativeCollapse = TRUE,
  continueOnParseError = TRUE,
  customAttrAssign = list(),
  customAttrSurround = list(),
  decodeEntities = FALSE,
  html5 = TRUE,
  includeAutoGeneratedTags = TRUE,
  keepClosingSlash = FALSE,
  minifyCSS = TRUE,
  minifyJS = TRUE,
  minifyURLs = TRUE,
  preserveLineBreaks = FALSE,
  preventAttributesEscaping = FALSE,
  processConditionalComments = FALSE,
  quoteCharacter = "'",
  removeAttributeQuotes = TRUE,
  removeComments = TRUE,
  removeEmptyAttributes = TRUE,
  removeEmptyElements = FALSE,
  removeOptionalTags = FALSE,
  removeRedundantAttributes = FALSE,
  removeScriptTypeAttributes = FALSE,
  removeStyleLinkTypeAttributes = FALSE,
  sortAttributes = FALSE,
  sortClassName = FALSE,
  trimCustomFragments = FALSE,
  useShortDoctype = FALSE
)

Arguments

`html`	HTML string to minify.
`caseSensitive`	Treat attributes in case sensitive manner (useful for custom HTML tags) \| false \|
`collapseBooleanAttributes`	Omit attribute values from boolean attributes \| false \|
`collapseInlineTagWhitespace`	Don't leave any spaces between display:inline; elements when collapsing. Must be used in conjunction with collapseWhitespace=true \| false \|
`collapseWhitespace`	Collapse white space that contributes to text nodes in a document tree \| false \|
`conservativeCollapse`	Always collapse to 1 space (never remove it entirely). Must be used in conjunction with collapseWhitespace=true \| false \|
`continueOnParseError`	Handle parse errors instead of aborting. \| false \|
`customAttrAssign`	Arrays of regex'es that allow to support custom attribute assign expressions (e.g. `⁠<div flex?="{{mode != cover}}"></div>⁠`) \| [ ] \| [ ]: R:%20
`customAttrSurround`	Arrays of regex'es that allow to support custom attribute surround expressions (e.g. `⁠<input {{#if value}}checked="checked"{{/if}}>⁠`) \| [ ] \| [ ]: R:%20
`decodeEntities`	Use direct Unicode characters whenever possible \| false \|
`html5`	Parse input according to HTML5 specifications \| true \|
`includeAutoGeneratedTags`	Insert tags generated by HTML parser \| true \|
`keepClosingSlash`	Keep the trailing slash on singleton elements \| false \|
`minifyCSS`	Minify CSS in style elements and style attributes (uses clean-css) \| false (could be true, Object, Function(text, type)) \|
`minifyJS`	Minify JavaScript in script elements and event attributes (uses UglifyJS) \| false (could be true, Object, Function(text, inline)) \|
`minifyURLs`	Minify URLs in various attributes (uses relateurl) \| false (could be String, Object, Function(text)) \|
`preserveLineBreaks`	Always collapse to 1 line break (never remove it entirely) when whitespace between tags include a line break. Must be used in conjunction with collapseWhitespace=true \| false \|
`preventAttributesEscaping`	Prevents the escaping of the values of attributes \| false \|
`processConditionalComments`	Process contents of conditional comments through minifier \| false \|
`quoteCharacter`	Type of quote to use for attribute values (' or ") \| \|
`removeAttributeQuotes`	Remove quotes around attributes when possible \| false \|
`removeComments`	Strip HTML comments \| false \|
`removeEmptyAttributes`	Remove all attributes with whitespace-only values \| false (could be true, Function(attrName, tag)) \|
`removeEmptyElements`	Remove all elements with empty contents \| false \|
`removeOptionalTags`	Remove optional tags \| false \|
`removeRedundantAttributes`	Remove attributes when value matches default. \| false \|
`removeScriptTypeAttributes`	Remove type="text/javascript" from script tags. Other type attribute values are left intact \| false \|
`removeStyleLinkTypeAttributes`	Remove type="text/css" from style and link tags. Other type attribute values are left intact \| false \|
`sortAttributes`	Sort attributes by frequency \| false \|
`sortClassName`	Sort style classes by frequency \| false \|
`trimCustomFragments`	Trim white space around ignoreCustomFragments. \| false \|
`useShortDoctype`	Replaces the doctype with the short (HTML5) doctype \| false \|

Package 'alesia'

Help Index

Alesia

Description

Usage

Arguments

Minify

Description

Usage

Arguments