posthtml-minify-classnames
is a PostHTML plugin that rewrites classnames and ids inside of html and css files to reduce file size.
Minifying classnames allows you to write verbose classnames in your source code, and distribute a smaller package to your users or application.
Use cases include:
- Tiny code competitions e.g., https://a-k-apart.com/
- Embeded devices like router admin panels e.g., http://www.dd-wrt.com/
- Mobile and responsive sites to keep the latency low e.g., https://developers.google.com/web/showcase/2015/googleplus
posthtml-minify-classnames
supports svg href attributes.
Before:
<html>
<style>
#some-id {
text-transform: uppercase;
}
.header__intro {
color: blue;
}
.card--profile {
background: white;
}
.js-overlay {
display: none;
}
#js-button {
color: blue;
}
@media (min-width: 768px) {
.header__intro {
color: gray;
}
}
</style>
<body>
<svg style="display:none">
<symbol id="icon-location"><path d=""></path></symbol>
</svg>
<h1 id="some-id">Title</h1>
<p class="header__intro">OMG</p>
<div class="js-overlay"></div>
<div id="js-button"></div>
<div class="card--profile">
card content
</div>
<svg>
<use href="#icon-location"></use>
</svg>
<label for="username">Click me</label>
<input type="text" id="username">
</body>
</html>
After:
<html>
<style>
#a {
text-transform: uppercase;
}
.a {
color: blue;
}
.b {
background: white;
}
.js-overlay {
display: none;
}
#js-button {
color: blue;
}
@media (min-width: 768px) {
.a {
color: gray;
}
}
</style>
<body>
<svg style="display:none">
<symbol id="b"><path d=""></path></symbol>
</svg>
<h1 id="a">Title</h1>
<p class="a">OMG</p>
<div class="js-overlay"></div>
<div id="js-button"></div>
<div class="b">
card content
</div>
<svg>
<use href="#b"></use>
</svg>
<label for="c">Click me</label>
<input type="text" id="c">
</body>
</html>
npm i -D posthtml-minify-classnames
Note: To use with external sheets, other plugins must be used, like posthtml-inline-assets and posthtml-style-to-file, or other build task plugins.
var posthtml = require('posthtml');
var minifyClassnames = require('posthtml-minify-classnames');
posthtml()
.use(minifyClassnames({
filter: /^.js-/,
genNameClass: 'genNameEmoji',
genNameId: 'genNameEmoji',
}))
.process(`
<style>
#foo { color: red }
.bar { color: blue }
</style>
<div id="foo" class="bar">baz</div>
`)
.then(function(result) {
console.log(result.html); //=> '<style>#a { color: red } .bar { color: blue }</style><div id="a" class="bar">baz</div>'
});
Type: regex, Default: /^.js-/
Type: string, Default: 'genName'
Available options: 'genName'
, 'genNameEmoji'
, 'genNameEmojiString'
, false
'genName'
Generates the smallest possible names'genNameEmoji'
Generates small emoji based names'genNameEmojiString'
Generates random emoji with 3 emojis in eachfalse
Preserves names. Use this to ignore ids or classes
Example:
<html>
<style>
#๐ง๐ฅ๐ {
text-transform: uppercase;
}
.โ๐๐ {
color: blue;
}
.โฒ๐โ {
background: white;
}
.js-overlay {
display: none;
}
#js-button {
color: blue;
}
@media (min-width: 768px) {
.โ๐๐ {
color: gray;
}
}
</style>
<body>
<svg style="display:none">
<symbol id="๐๐จ๐น"><path d=""></path></symbol>
</svg>
<h1 id="๐ง๐ฅ๐">Title</h1>
<p class="โ๐๐">OMG</p>
<div class="js-overlay"></div>
<div id="js-button"></div>
<div class="โฒ๐โ">
card content
</div>
<svg>
<use href="#๐๐จ๐น"></use>
</svg>
<label for="๐ป๐๐">Click me</label>
<input type="text" id="๐ป๐๐">
</body>
</html>
Future: Option to define own generator function.
See PostHTML Guidelines and contribution guide.