carbon/pipeline

Carbon.Pipeline is a delicious blend of esbuild and PostCSS to form a full-featured, ultra-fast modern Javascript and CSS bundler for Flow Framework and Neos CMS.

Getting started

First, thank you that you want to give this build stack a try! If you miss a ✨ feature or found a 🐛 bug, feel free to open an issue.

Install via composer

Run composer require carbon/pipeline --dev. Some files (if not already existing) will be copied to your root folder during the installation. After installing the package, run the command yarn install to install the required packages, defined in package.json. Feel free to modify and change dependencies before installing 👍

Manual install

If you want to make some significant adjustments to the build stack, you can also download the code as zip file and put it in the folder Build/Carbon.Pipeline. Go to Carbon.Pipeline/Installer/Distribution/Defaults and copy the files to your root folder (Don't forget the hidden files, starting with a dot). After this is done, run the command yarn install to install the required packages, defined in package.json. Feel free to modify and change dependencies before installing 👍

Add files to the build stack

The whole configuration, including which files to build, is configured in pipeline.yaml. The default values are set in defaults.yaml and merged with your configuration. Under the key packages, you can either add an array with package settings or, if you have just one entry, you can directly add the configuration:

packages:
  - package: Vendor.Bar
    files:
      - Main.pcss
      - Main.js

# This is the same as
packages:
  package: Vendor.Bar
  files:
    - Main.pcss
    - Main.js

If you have just one file, you can pass this directly without creating an array:

packages:
  package: Vendor.Bar
  files: Main.js

If you don't set files, all parsable files from the input folder get rendered. Files that start with an underscore (_) will be ignored.

packages:
  package: Vendor.Bar

To change the input and/or the output folder, you can do this with the folder option:

packages:
  package: Vendor.Bar
  folder:
    input: Assets
    output:
      inline: Private/Templates
      style: Public
      script: Public
      module: Public
      commonJS: Public

Further, you can write the files to another package:

packages:
  package: Vendor.Bar
  folder:
    output:
      package: Vendor.Theme

If you want to go crazy with multi-sites in Neos, you can also write the files to multiple packages:

packages:
  package: Vendor.Bar
  folder:
    output:
      package:
        - Vendor.Theme
        - Vendor.Bar

A package entry has the following options:

These are the default values for the folders:

folder:
  input: Fusion
  output:
    inline: Private/Templates/InlineAssets
    style: Public/Styles
    script: Public/Scripts
    module: Public/Modules
    commonJS: Public/CommonJS

and these for the build options:

external: null
inline: false
sourcemap: true
format: iife

The target folders can be adjusted under the key folder.output. If you want to change the defaults for all your packages, you can also set this globally in your pipeline.yaml:

folder:
  input: Assets
  output:
    inline: Private/Templates
    style: Public
    script: Public
    module: Public
    commonJS: Public

buildDefaults:
  sourcemap: false
  format: esm

Please look at the defaults.yaml file for all the options.

If you set an entry file with the javascript module suffix (.mjs, .mjsx, .mts or .mtsx) the format of this file will be enforced to esm. The same with commonJS: If you set an entry file with the javascript commonJS suffix (.cjs, .cjsx, .cts or .ctsx) the format of this file will be enforced to cjs. E.g., if you have the following array ["Main.js", "Module.mjs", "CommonJS.cjs"], and have no specific setting for the format, Main.js will have the format iife, Module.mjs will have the format esm and CommonJS.cjs will have the format cjs.

Yarn tasks

There are five predefined main tasks:

The tasks are split up, so they can run in parallel mode. But you can also run them separately:

Extendibility

Of course, you can also add your own tasks in the scripts section of your package.json file. For example, if you have a Neos UI custom editor and want to start all your tasks in one place, you can add them like this:

"build:editor": "yarn --cwd DistributionPackages/Foo.Editor/Resources/Private/Editor/ build",
"watch:editor": "yarn --cwd DistributionPackages/Foo.Editor/Resources/Private/Editor/ watch",
"pipeline:editor": "yarn --cwd DistributionPackages/Foo.Editor/Resources/Private/Editor/ install --silent --non-interactive",

Because the tasks start with build:, respectively with watch: or pipeline:, the tasks will be included in the corresponding root command. In this example, yarn build, yarn watch or yarn pipeline.

Compression of files

In production mode (yarn build), the files also get compressed with gzip and brotli. You can edit the compression level under the key buildDefaults.compression. Per default, the highest compression level is set. To disable compression at all, you can set it to false:

buildDefaults:
  compression: false

Or, if you want to disable just one of them, you can set the entry to false:

buildDefaults:
  compression:
    gzip: false

Import files from DistributionPackages and other Packages

By default, two aliases are predefined: DistributionPackages and Packages. Like that you can import (CSS and JS) files from other packages like that:

import "DistributionPackages/Vendor.Foo/Resources/Private/Fusion/Main";
import "Packages/Plugins/Jonnitto.PhotoSwipe/Resources/Private/Assets/PhotoSwipe";

@import "DistributionPackages/Vendor.Foo/Resources/Private/Fusion/Main.pcss";
@import "Packages/Carbon/Carbon.Image/Resources/Private/Assets/Tailwind.pcss";

Thanks to a custom made resolve function, you can also use globbing in CSS imports: @import "Presentation/**/*.pcss";

CSS

Sass

If you want to use Sass (.scssor .sass files) you have to install sass:

yarn add --dev sass

PostCSS

This template comes with a variety of PostCSS Plugins. Feel free to remove some or add your own favorites packages. The configuration is located in .postcssrc.js. The suffix of these files should be .pcss.

PostCSS Plugins

Tailwind CSS

This setup comes with Tailwind CSS, a highly customizable, low-level CSS framework. An example configuration is provided in tailwind.config.js. The setup for purge the CSS files is also configured. Read more about controlling the file size here. Because the CSS bundling is done with the Javascript API from PostCSS, the Just-in-Time Mode from Tailwind CSS works perfectly.

By the way: Alpine.js is excellent in combination with Tailwind CSS.

Javascript

yarn add --dev typescript @typescript-eslint/eslint-plugin

{
  "include": ["DistributionPackages/**/Private/*"],
  "exclude": [
    "node_modules/*",
    "DistributionPackages/**/Public/*",
    "DistributionPackages/**/Private/Templates/InlineAssets*",
    "Packages"
  ],
  "compilerOptions": {
    "baseUrl": "./",
    "paths": {
      "Packages/*": ["Packages/*"],
      "DistributionPackages/*": ["DistributionPackages/*"]
    }
  }
}

{
  "parser": "@typescript-eslint/parser",
  "extends": [
    "plugin:@typescript-eslint/recommended",
    "eslint:recommended",
    "plugin:prettier/recommended",
    "prettier/@typescript-eslint"
  ],
  "env": {
    "es6": true,
    "node": true
  }
}

import * as React from "react";
render(<div />);

{
  "compilerOptions": {
    "jsxFactory": "h",
    "jsxFragmentFactory": "Fragment"
  }
}

yarn add --dev svelte svelte-preprocess esbuild-svelte @tsconfig/svelte

esbuild:
  plugins:
    svelte:
      enable: true
      # Add here your options
      options:
        compileOptions:
          css: true

{
  "extends": "@tsconfig/svelte/tsconfig.json",
  "include": ["DistributionPackages/**/Private/*"],
  "exclude": [
    "node_modules/*",
    "__sapper__/*",
    "DistributionPackages/**/Public/*",
    "DistributionPackages/**/Private/Templates/InlineAssets*",
    "Packages"
  ],
  "compilerOptions": {
    "baseUrl": "./",
    "paths": {
      "Packages/*": ["Packages/*"],
      "DistributionPackages/*": ["DistributionPackages/*"]
    }
  }
}

yarn add --dev vue vue-template-compiler esbuild-vue

esbuild:
  plugins:
    vue:
      enable: true
      # You can pass your needed options here
      # options:

yarn add --dev @babel/core esbuild-plugin-babel

yarn add --dev @babel/preset-env @babel/plugin-proposal-class-properties @babel/plugin-proposal-object-rest-spread

{
  "presets": [
    [
      "@babel/preset-env",
      {
        "modules": false
      }
    ]
  ],
  "plugins": ["@babel/proposal-class-properties", "@babel/proposal-object-rest-spread"]
}

esbuild:
  plugins:
    babel:
      enable: true
      # You can pass your needed options here
      # options:

defaults
ie 11
not dead