githubDocs

CLI

Once the SPB cli is installed you can use the cli.

Usage:

spb [options] [command]

Options:

Commands:

Dev Server

The dev server starts a server and loads all compiled files temporarily instead of building and saving them.

When opening a html file the devserver adds a script to it to automatically reload the page when changes occure to the code.

Config file

You can use a configuration file with the flag -c or --config. All options declared in the config file will be overwritten by options from the cli:

You can also use this projects JSON schema to ensure integrity but it is not necessary.

For example when the configuration file (for example named config.spb.json) is in the root directory and spb is installed locally:

{
  "$schema": "node_modules/@puresamari/spb/lib/config.schema.json",
  "files": [
    "./src/example.pug",
    "./views/*.pug",
    "./src/index.twig",
    "./src/images/*",
    "./src/license.pdf",
    "./src/main.ts",
    "./src/styles.css"
  ],
  "output": "dist/",
}

PostCSS plugins

If it is necessary to add options to the builders / compilers (for example postcss plugins), you can add it to the compilers part of the config file. Like in this example:

 {
  "$schema": "node_modules/@puresamari/spb/lib/config.schema.json",
  
  ...
  
  "compilers": {
    "postcss": {
      "plugins": [
        ...
        "precss", // or other
        ...
      ]
    }
  }
}

Post build script

It is possible to run a script after a build was completed. NOTE this script will not be executed when running a dev-server.

 {
  "$schema": "node_modules/@puresamari/spb/lib/config.schema.json",
  
  ...
  
  "postBuild": "npm run deploy" // For example
}

Using this config file you can then build your project like this: $ spb -c config.spb.json

Created by Simon Rothert