real-world-css-libraries 1.0.1 → 1.0.3

package/README.md

@@ -1,9 +1,13 @@
 # real-world-css-libraries
 
-Repository of unminified, real-world, CSS files from open source projects.
+Corpus of unminified, real-world, CSS files from open source projects.
 
 For use in minification tests and tooling benchmarks.
 
+To see how various CSS Minification Tools perform when minifying these files:
+
+* https://www.keithcirkel.co.uk/css-minify-tests/#real-world
+
 
 ## Usage
 
@@ -25,18 +29,22 @@ console.log(libraries);
 /*
  * [
  *   {
+ *     fileName: '960.gs-v0.0.0.css',
  *     name: '960.gs',
- *     version: 'v1.0.0',
+ *     version: 'v0.0.0',
  *     license: 'GPL-3.0 or MIT',
  *     source: '/*\n  960 Grid System ~ Core CSS.\n  Learn more ~ http://9...',
- *     size: 9989
+ *     size: 9989,
+ *     url: 'https://github.com/nathansmith/960-Grid-System/blob/master/code/css/960.css'
  *   },
  *   {
+ *     fileName: 'animate-v4.1.1.css',
  *     name: 'Animate',
  *     version: 'v4.1.1',
  *     license: 'Hippocratic-2.1',
  *     source: '@charset "UTF-8";\n/*!\n * animate.css - https://animate.s...',
- *     size: 95377
+ *     size: 95377,
+ *     url: 'https://github.com/animate-css/animate.css/blob/main/animate.css'
  *   },
  *   ...
  * ]
@@ -54,6 +62,23 @@ console.log(namesOfLibrariesCompatibleWithMITLicense);
 // ['960.gs', '98', 'AdminLTE', ...]
 ```
 
+**Note:** The `size` is from the original file size on disk. This will be different from `source.length`. If you are comparing the output of a minifier, for example, by using `output.length` of it as a string, then to get a more accurate comparison for percentage of size reduction, you should use `output.length / source.length` instead of `output.length / size`. Counting the number of characters is different than the actual filesize, because not all characters are 1 byte.
+
+
+## Non-npm usage
+
+If you are using a different programming language/package management system and can't `npm i` this library, you have some other options:
+
+1. Download via `git`
+   * `git clone https://github.com/TheJaredWilcurt/real-world-css-libraries.git`
+   * `git clone git@github.com:TheJaredWilcurt/real-world-css-libraries.git`
+1. HTTPS download via UNPKG:
+   * https://app.unpkg.com/real-world-css-libraries
+1. Manually download repo as a ZIP file:
+   * https://github.com/TheJaredWilcurt/real-world-css-libraries/archive/refs/heads/main.zip
+
+Then you can loop over the files in the `libs` folder yourself for your usage.
+
 
 ## Adding a library
 
@@ -69,6 +94,11 @@ console.log(namesOfLibrariesCompatibleWithMITLicense);
    * If the new library's name needs correcting (like `Mycssrepo` should be `My CSS Repo`), update `nameMap` in `index.js` and run `npm t` again.
 
 
+## License
+
+This repo and all original work within is licensed under MIT. However, the files in the `libs` folder have their own licenses, which can be seen below. I've modified each file to include a single line comment at the top with a link to the original source file, and where needed, ensured there is a single empty return at the end of each file. For simplicity, each of these changes is re-licensed using the exact same original license that was associated with that library. So the (slightly) modified copy of FF-Ultima in `/libs/ff-ultima-v4.3.0.css`, for example, retains it's original `MPL-2.0` license. Effectively all the files in the `/lib` folder have a "pass-through" license back to their original in the sense that my modifications are intentionally minor and inconsequential and therefor should not require a re-licensing of them, but if in a legal sense these minor changes require re-licensing, they are intentionally re-licensed with a matching license of the original. No other changes were made to these files, as I want to keep them representative to what exists in the real world, bugs and all.
+
+
 ## Skipped Libraries
 
 These libraries were explicitly not included because they lack a compatible license. Issues have been created for them to add a license, if they do in the future, they can be included in this repo.
@@ -82,7 +112,7 @@ These libraries were explicitly not included because they lack a compatible lice
 
 ## Libraries included:
 
-There are **150** files totaling **33.31MB** of unminified CSS.
+There are **166** files totaling **33.75MB** of unminified CSS.
 
 Library | License
 :--     | :--
@@ -101,8 +131,8 @@ Library | License
 [Blue-Topaz Obsidian](https://raw.githubusercontent.com/PKM-er/Blue-Topaz_Obsidian-css/refs/heads/master/obsidian.css) | MIT
 [Boilerform](https://github.com/Andy-set-studio/boilerform/blob/master/dist/css/boilerform.css) | MIT
 [Bojler](https://unpkg.com/@slicejack/bojler@3.2.1/dist/inline.css) | MIT
-[Bootstrap](https://github.com/twbs/bootstrap/releases/tag/v4.6.2) | MIT
-[Bootstrap](https://github.com/twbs/bootstrap/releases/tag/v5.3.8) | MIT
+[Bootstrap 4](https://github.com/twbs/bootstrap/releases/tag/v4.6.2) | MIT
+[Bootstrap 5](https://github.com/twbs/bootstrap/releases/tag/v5.3.8) | MIT
 [Bttn](https://github.com/ganapativs/bttn.css/blob/master/dist/bttn.css) | MIT
 [Bulma](https://github.com/jgthms/bulma/blob/main/css/bulma.css) | MIT
 [Carbon](https://unpkg.com/@carbon/styles@1.107.0/css/styles.css) | Apache-2.0
@@ -110,13 +140,15 @@ Library | License
 [Chota](https://github.com/jenil/chota/blob/main/dist/chota.css) | MIT
 [Cirrus](https://github.com/Spiderpig86/Cirrus/blob/master/dist/cirrus.css) | MIT
 [Classless](https://github.com/DigitallyTailored/Classless.css/blob/main/classless.css) | MIT
+[CleanSlate](https://github.com/premasagar/cleanslate/blob/master/cleanslate.css) | MIT
 [CodeFrame](https://github.com/codyhouse/codyframe/blob/main/main/css/style.css) | MIT
+[Colofilter](https://github.com/LukyVj/colofilter.css/blob/master/styles/colofilter.css) | MIT
 [Concise](https://unpkg.com/concise.css@4.1.2/dist/concise.css) | MIT
 [CrookedStyleSheets](https://github.com/jbtronics/CrookedStyleSheets/blob/master/screen.css) | MIT
 [cs16.css](https://github.com/ekmas/cs16.css/blob/main/css/cs16.css) | MIT
 [CSS Diner](https://github.com/flukeout/css-diner/blob/develop/css/style.css) | MPL-2.0
 [CSS Plot](https://github.com/asciimoo/cssplot/blob/master/build/cssplot.full.css) | MIT
-[Css Social Buttons](https://github.com/smcllns/css-social-buttons/blob/master/css/zocial.css) | MIT
+[CSS Social Buttons](https://github.com/smcllns/css-social-buttons/blob/master/css/zocial.css) | MIT
 [CSS Spinners](https://github.com/jlong/css-spinners/blob/master/css/spinners.css) | MIT
 [CSS Zen Garden #215](https://github.com/mezzoblue/csszengarden.com/blob/master/215/215.css) | CC-BY-NC-SA-1.0
 [css-extras](https://github.com/sindresorhus/css-extras/blob/main/index.css) | CC0-1.0 or MIT
@@ -132,6 +164,7 @@ Library | License
 [ElegantFin](https://github.com/lscambo13/ElegantFin/blob/main/Theme/ElegantFin-theme-v25.12.31.css) | MIT
 [Evil](https://github.com/tlrobinson/evil.css/blob/master/evil.css) | Public Domain
 [FF-Ultima](https://github.com/soulhotel/FF-ULTIMA/blob/main/theme/ffu-internal-appearance.css) | MPL-2.0
+[Fileicon](https://github.com/picturepan2/fileicon.css/blob/master/fileicon.css) | MIT
 [Flakes](https://github.com/kumailht/flakes/blob/master/css/all.css) | MIT
 [Flex Layout Attribute](https://github.com/StefanKovac/flex-layout-attribute/blob/master/css/flex-layout-attribute.css) | MIT
 [Fomantic UI](https://github.com/fomantic/Fomantic-UI/blob/develop/dist/semantic.css) | MIT
@@ -143,22 +176,26 @@ Library | License
 [GitHub-Markdown](https://github.com/sindresorhus/github-markdown-css/blob/main/github-markdown.css) | MIT
 [GitHub-Windows](https://github.com/Athari/CssGitHubWindows/blob/master/GitHubWindows.user.css) | MIT
 [google-type](https://github.com/femmebot/google-type/blob/master/css/google-type.css) | MIT
+[Gridism](https://github.com/cobyism/gridism/blob/master/gridism.css) | MIT
 [Gridlex](https://github.com/devlint/gridlex/blob/master/dist/gridlex.css) | MIT
 [Gumby](https://github.com/GumbyFramework/Gumby/blob/master/css/gumby.css) | MIT
 [Gutenberg](https://github.com/BafS/Gutenberg/blob/master/dist/gutenberg.css) | MIT
 [Halfmoon](https://github.com/halfmoonui/halfmoon/blob/master/css/halfmoon.css) | MIT
 [HalfStyle](https://github.com/arbelh/HalfStyle/blob/master/css/halfstyle.css) | MIT
 [Hint](https://github.com/chinchang/hint.css/blob/master/hint.css) | MIT
+[Holmes](https://github.com/redroot/holmes/blob/master/holmes.css) | GPL-3.0
 [HTML Sheets of Paper](https://github.com/delight-im/HTML-Sheets-of-Paper/blob/gh-pages/css/sheets-of-paper.css) | MIT
 [Hugo Universal Theme](https://github.com/devcows/hugo-universal-theme/blob/master/static/css/style.default.css) | MIT
 [Icon Hover Effects](https://github.com/codrops/IconHoverEffects/blob/master/css/component.css) | MIT
 [Instagram.css](https://github.com/picturepan2/instagram.css/blob/master/dist/instagram.css) | MIT
 [Jupyter Themes](https://github.com/dunovank/jupyter-themes/blob/master/jupyterthemes/styles/compiled/gruvboxd.css) | MIT
+[Less Framework](https://github.com/jonikorpi/Less-Framework/blob/master/main-17px.css) | MIT
 [Load Awesome](https://labs.danielcardoso.net/load-awesome/assets/loaders.css) | MIT
 [Loaders](https://github.com/ConnorAtherton/loaders.css/blob/master/loaders.css) | MIT
 [Luxbar](https://github.com/balzss/luxbar/blob/master/build/luxbar.css) | MIT
 [markdown-css](https://github.com/mrcoles/markdown-css/blob/master/markdown.css) | MIT
 [Material for Bootstrap](https://github.com/Daemonite/material/blob/master/css/material.css) | MIT
+[medium.css](https://github.com/lucagez/medium.css/blob/master/demo/src/medium_extended.css) | MIT
 [Meyer](https://meyerweb.com/eric/tools/css/reset/reset.css) | Public Domain
 [Microsoft Metro Buttons](https://github.com/ace-subido/css3-microsoft-metro-buttons#license) | CC-BY-3.0
 [Microtip](https://github.com/ghosh/microtip/blob/master/microtip.css) | MIT
@@ -175,6 +212,7 @@ Library | License
 [object-fit Polyfill](https://github.com/anselmh/object-fit/blob/master/dist/polyfill.object-fit.css) | MIT
 [Obsidian Colored Sidebar](https://github.com/CyanVoxel/Obsidian-Colored-Sidebar/blob/main/Colored%20Sidebar%20Items.css) | MIT
 [Obsidian Modular CSS Layout](https://github.com/efemkay/obsidian-modular-css-layout/blob/main/MCL%20Multi%20Column.css) | GPL-3.0
+[OffCanvasMenuEffects](https://github.com/codrops/OffCanvasMenuEffects/blob/master/css/menu_cornermorph.css) | MIT
 [Orbit](https://unpkg.com/@zumer/orbit@1.4.11/dist/orbit.css) | MIT
 [Paper](https://github.com/cognitom/paper-css/blob/master/paper.css) | MIT
 [PatternFly](https://unpkg.com/@patternfly/patternfly@6.5.2/patternfly.css) | MIT
@@ -199,6 +237,7 @@ Library | License
 [Ripple UI](https://unpkg.com/rippleui@1.12.1/dist/css/styles.css) | MIT
 [Sakura](https://github.com/oxalorg/sakura/blob/master/css/sakura.css) | MIT
 [Sanitize](https://github.com/csstools/sanitize.css/blob/main/sanitize.css) | CC0-1.0
+[Select2 Bootstrap](https://github.com/t0m/select2-bootstrap-css/blob/master/select2-bootstrap.css) | MIT
 [Select](https://github.com/filamentgroup/select-css/blob/master/src/select-css.css) | MIT
 [Semantic UI](https://github.com/Semantic-Org/Semantic-UI/blob/master/dist/semantic.css) | MIT
 [Shards](https://github.com/DesignRevision/shards-ui/blob/master/dist/css/shards.css) | MIT
@@ -206,14 +245,19 @@ Library | License
 [Simple Grid](https://github.com/zachacole/Simple-Grid/blob/master/simple-grid.css) | MIT
 [Simple Line Icons](https://github.com/thesabbir/simple-line-icons/blob/master/dist/styles/simple-line-icons.css) | MIT
 [Simple](https://codeberg.org/kevquirk/simple.css/src/branch/main/simple.css) | MIT
+[SimpTip](https://github.com/arashmanteghi/simptip/blob/master/simptip.css) | MIT
 [Skeleton](https://github.com/dhg/Skeleton/blob/master/css/skeleton.css) | MIT
 [SPCSS](https://github.com/susam/spcss/blob/main/sp.css) | MIT
 [Spectre](https://github.com/picturepan2/spectre/blob/master/dist/spectre.css) | MIT
+[Spicetify Bloom](https://github.com/nimsandu/spicetify-bloom/blob/main/src/user.css) | MIT
 [Spicetify Dribbblish](https://github.com/spicetify/spicetify-themes/blob/master/Dribbblish/user.css) | MIT
 [Spicetify Text](https://github.com/spicetify/spicetify-themes/blob/master/text/user.css) | MIT
 [Spinkit](https://github.com/tobiasahlin/SpinKit/blob/master/spinkit.css) | MIT
 [Stackicons](https://github.com/parkerbennett/stackicons/blob/master/css/stackicons-social.css) | MIT
+[StackOverflow-Dark](https://github.com/StylishThemes/StackOverflow-Dark/blob/v5.1.2/stackoverflow-dark.user.css) | CC-BY-SA-4.0
 [Stacks](https://unpkg.com/@stackoverflow/stacks@2.8.6/dist/css/stacks.css) | MIT
+[Swagger UI Themes 2](https://github.com/ostranme/swagger-ui-themes/blob/develop/themes/2.x/theme-monokai.css) | MIT
+[Swagger UI Themes 3](https://github.com/ostranme/swagger-ui-themes/blob/develop/themes/3.x/theme-monokai.css) | MIT
 [System](https://github.com/sakofchit/system.css/blob/main/style.css) | MIT
 [Tablecloth](https://github.com/bwsewell/tablecloth/blob/master/assets/css/tablecloth.css) | MIT
 [Tachyons](https://github.com/tachyons-css/tachyons/blob/main/css/tachyons.css) | MIT
@@ -233,6 +277,8 @@ Library | License
 [Water](https://cdn.jsdelivr.net/npm/water.css@2.1.1/out/water.css) | MIT
 [Weather Icons](https://github.com/erikflowers/weather-icons/tree/master/css) | MIT
 [Webgradients](https://github.com/itmeo/webgradients/blob/master/webgradients.css) | MIT
+[Wenk](https://github.com/tiaanduplessis/wenk/blob/master/dist/wenk.cssnext.css) | MIT
 [Windows 98](https://github.com/yocontra/windows_98.css/blob/master/dist/win98.css) | MIT
 [Wing](https://github.com/kbrsh/wing/blob/master/dist/wing.css) | MIT
 [WTF Forms](https://github.com/mdo/wtf-forms/blob/master/wtf-forms.css) | MIT
+[Zotero Dark Theme](https://github.com/Rosmaninho/Zotero-Dark-Theme/blob/main/userChrome.css) | GPL-3.0

package/index.js

@@ -12,12 +12,14 @@ const nameMap = {
   'admin-lte': 'AdminLTE',
   beercss: 'Beer CSS',
   'blue-topaz-obsidian': 'Blue-Topaz Obsidian',
+  cleanslate: 'CleanSlate',
   codyframe: 'CodeFrame',
   crookedstylesheets: 'CrookedStyleSheets',
   'cs16': 'cs16.css',
   'css3-buttons': 'CSS3 Buttons',
   'css-diner': 'CSS Diner',
   'css-extras': 'css-extras',
+  'css-social-buttons': 'CSS Social Buttons',
   'css-spinners': 'CSS Spinners',
   cssco: 'CSSCO',
   cssicon: 'cssicon',
@@ -35,6 +37,7 @@ const nameMap = {
   instagram: 'Instagram.css',
   'material-for-bootstrap': 'Material for Bootstrap',
   'markdown-css': 'markdown-css',
+  'medium.css': 'medium.css',
   'microsoft-metro-buttons': 'Microsoft Metro Buttons',
   minireset: 'Mini Reset',
   'modern-css-resets': 'Modern CSS Resets',
@@ -42,10 +45,15 @@ const nameMap = {
   nes: 'NES.css',
   'object-fit-polyfill': 'object-fit Polyfill',
   'obsidian-modular-css-layout': 'Obsidian Modular CSS Layout',
+  'off-canvas-menu-effects': 'OffCanvasMenuEffects',
   patternfly: 'PatternFly',
   rippleui: 'Ripple UI',
   semantic: 'Semantic UI',
+  simptip: 'SimpTip',
   spcss: 'SPCSS',
+  'stackoverflow-dark': 'StackOverflow-Dark',
+  'swagger-ui-themes-2': 'Swagger UI Themes 2',
+  'swagger-ui-themes-3': 'Swagger UI Themes 3',
   'the-new-css-reset': 'The New CSS Reset',
   'tw-animate-css': 'tw-animate-css',
   uikit: 'UIkit',
@@ -68,7 +76,9 @@ const nameLicenseMap = {
   cutestrap2: 'GPL-3.0',
   evil: 'Public Domain',
   'ff-ultima': 'MPL-2.0',
+  'stackoverflow-dark': 'CC-BY-SA-4.0',
   'github-dark': 'BSD-2-Clause',
+  holmes: 'GPL-3.0',
   meyer: 'Public Domain',
   'microsoft-metro-buttons': 'CC-BY-3.0',
   missing: 'BSD-2-Clause',
@@ -141,6 +151,7 @@ export default function (includeUrl) {
     const filePath = join(libsPath, fileName);
     const sourceWithUrl = getSource(filePath);
     const library = {
+      fileName,
       name: getFullName(fileName),
       version: getVersion(fileName),
       license: getLicences(fileName),