@silexlabs/eleventy-plugin-concat

v1.2.3

Published

3 months ago

Eleventy plugin to bundle your scripts and styles

0High
0Medium
0Low

jbips

lexoyo

silex eleventy plugin elventy-plugin optimization

eleventy-plugin-concat

Eleventy plugin to bundle your scripts and styles

This plugin is contributed by Internet 2000 web studio, it is used to create green websites with Silex website builder

Overview

Add the plugin to your .eleventy.js config
Add data-concat attribute to <script>, <script src=, <style> and <link rel="stylesheet" href= which are in the page <head>
After the site has been built by eleventy, the plugin will write new script.js and style.css files with the content of all the scripts and styles with data-concat
The plugin will also change you HTML to load the new script and style in place of the old ones

Tip: this plugin works great with eleventy-plugin-helmet which makes it easy to group scripts of templates in HEAD

Features

This is the roadmap and feature list:

[x] Transform all generated pages after the build
[x] Concat inline scripts
[x] Concat loaded scripts from base url and get their content from file system
[x] Concat loaded third-party scripts and fetch their content
[x] Concat inline styles
[x] Concat loaded stylesheets from base url and get their content from file system
[x] Concat loaded third-party stylesheets and fetch their content

Example

page.njk (also works with liquid or other template language):

<!doctype html>
<html>
  <head>
    <script src="/site.js" data-concat></script>
    <script src="/page.js" data-concat></script>
    <script data-concat>
        console.log('concat')
    </script>
    <link rel="stylesheet" href="/site.css" data-concat />
    <link rel="stylesheet" href="/page.css" data-concat />
    <style data-concat>
        body { background: blue; }
    </style>
  </head>
</html>

Generated _site/page.html:

<!doctype html>
<html>
  <head>
    <script src="/script.js"></script>
    <link rel="stylesheet" href="/style.css" />
  </head>
</html>

Generated _site/script.js:

// ... content of site.js
// ... content of page.js
console.log('concat')

Generated _site/style.css:

/* ... content of site.css */
/* ... content of page.css */
body { background: blue; }

Usage

As Eleventy Plugin

Install the plugin using npm:

npm install @silexlabs/eleventy-plugin-concat

Add the plugin to your .eleventy.js config:

const pluginConcat = require("@silexlabs/eleventy-plugin-concat")

module.exports = (eleventyConfig) => {
  eleventyConfig.addPlugin(pluginConcat, {
    baseUrl: 'http://localhost:8080',
  })
}

Use the global data-concat attribute in your templates

As CLI Tool

You can also use this plugin as a standalone CLI tool, perfect for npm scripts:

Install the plugin:

npm install @silexlabs/eleventy-plugin-concat

Use in npm scripts:

{
  "scripts": {
    "build:concat": "eleventy-plugin-concat 'dist/**/*.html'",
    "optimize": "eleventy-plugin-concat '_site/**/*.html' --base-url 'https://example.com'"
  }
}

Or run directly:

# Process all HTML files in dist folder
npx eleventy-plugin-concat "dist/**/*.html"
   
# Process with custom base URL
npx eleventy-plugin-concat "_site/**/*.html" --base-url "https://example.com"
   
# Custom output patterns
npx eleventy-plugin-concat "dist/**/*.html" \
  --js-path "assets/js/{name}.bundle.js" \
  --css-path "assets/css/{name}.bundle.css"

CLI Options:

--base-url <url>: Base URL for your site (default: http://localhost:8080)
--js-path <pattern>: JS output path pattern (default: js/{name}-concat.js)
--css-path <pattern>: CSS output path pattern (default: css/{name}-concat.css)
--js-url <pattern>: JS URL pattern in HTML (default: /js/{name}-concat.js)
--css-url <pattern>: CSS URL pattern in HTML (default: /css/{name}-concat.css)

The {name} placeholder will be replaced with the HTML file name (without extension).

Options

The default options are stored in src/defaults.js

| Name | Description | Default | | -- | -- | -- | | jsUrl | Function which takes the current page and returns the URL of the generated script (what you want the plugin to insert in your HTML) | page => \/js/${ basename(page.outputPath, '.html') }-concat.js`| | jsPath | Function which takes [the current page](https://www.11ty.dev/docs/data-eleventy-supplied/#page-variable) and returns the path of the generated script relative the output dir |page => `js/${ basename(page.outputPath, '.html') }-concat.js`| | jsSelector | Selector used to find the scripts to be concatenated in the HTML page | 'head script[data-concat]' | | jsAttributes | Attributes you want the plugin to add to the JS tag in your HTML, e.g.async| '' | | cssUrl | Function which takes [the current page](https://www.11ty.dev/docs/data-eleventy-supplied/#page-variable) and returns the URL of the generated stylesheet (what you want the plugin to insert in your HTML) |page => `/css/${ basename(page.outputPath, '.html') }-concat.css`| | cssPath | Function which takes [the current page](https://www.11ty.dev/docs/data-eleventy-supplied/#page-variable) and returns the path of the generated stylesheet relative to the output dir |page => `css/${ basename(page.outputPath, '.html') }-concat.css`| | cssSelector | Selector used to find the styles to be concatenated in the HTML page | 'head link[data-concat], head style[data-concat]' | | cssAttributes | Attributes you want the plugin to add to the CSS tag in your HTML, e.g.data-custom="abcd"| '' | | baseUrl | The URL where your site will be available, e.g.https://www.silex.me=>https://www.silex.me/js/test.jswill be read from file system in./js` | 'http://localhost:8080' |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme