Skip to content

Latest commit

 

History

History
204 lines (157 loc) · 6.65 KB

README.md

File metadata and controls

204 lines (157 loc) · 6.65 KB
Raw

ucd-theme-tasks

CLI tool for base automation when compiling a UCD frontend.

This package contains all the CLI tasks needed by UCD frontend projects and themes. It is heavily dependent on Vite.

Extra Documentation

https://github.com/ucdavis/ucd-theme-tasks/tree/master/docs

Installation

  1. Require the ucd-theme-tasks package with node.js.
$ npm install ucd-theme-tasks --save-dev
  1. Setup configuration files using the init command.
$ npx ucd-theme-tasks init

Upgrading from v3

https://github.com/ucdavis/ucd-theme-tasks/blob/master/docs/upgrade.md

Assumed File Structure

The default file structure assumes that this will be used in a tradition server rendered website such as a CMS like Drupal or Wordpress.

|-- dist/ (js and sass compiles here)
|-- js/
|   |-- main.js
|-- sass/
|   |-- style.scss
|-- package.json
|-- vite.config.mjs

If doing a Single Page App (SPA) with a Javascript framework like Vue.js or React then the vite.config.js can have its root changed to whatever suits it best. For reference in configuring a SPA see one of Vite's online demos https://vitejs.dev/guide/#trying-vite-online.

CLI Commands

It is recommended to use the locally installed CLI via npx.

View a list of all CLI commands and options with:

npx ucd-theme-tasks help

API & Usage

General usage

Usage: ucd-theme-tasks <command> [options]

Options:
  -V, --version         output the version number
  -h, --help            display help for command

Commands:
  init [options]        Copy starter files to a theme or custom site.
  build [options]       Build all assets using Vite.
  dev [options]         Development mode to build and watch all assets using Vite.
  lint [options]        Validate CSS and JS by linting.
  patternlab [options]  Compile Pattern Lab.
  sync [options]        Sync asset files like js, css, fonts, and images to a site.
  newsite [options]     Wire up a new site to allow syncing files from an existing project using its starterkit. This assumes the command
                        is being run within a project that has a "starterkit" directory.
  help [command]        display help for command.

Run "ucd-theme-tasks <command> --help" for detailed usage of given command.

Initialize a project and copy starter files.

Usage: init [options]

Copy starter files to a theme or custom site.

Options:
  -d, --dest <path>  Path to the theme directory or new site to export files into.
  -p, --patternlab   Use this inside Pattern Lab.
  -t, --themesync    Allow syncing with Pattern Lab.
  -f, --force        Force overwrite of existing files in theme.
  -h, --help         display help for command

Build production assets and files with Vite.

Usage: build [options]

Build all assets using Vite.

Options:
  -a, --prefix-files <glob>  CSS glob pattern [file|dir|glob]* to autoprefix css files.
  -p, --patternlab           Run the pattern lab build step before this build.
  -h, --help                 display help for command

Development mode to serve and watch files with Vite.

Usage: dev [options]

Development mode to build and watch all assets using Vite.

Options:
  -p, --patternlab  Run the pattern lab build step before this build.
  -S, --no-serve    Do not serve the files at a localhost domain. This is useful for when compiling inside a traditional CMS or site
                    already using Docker to serve files.
  -h, --help        display help for command

Validate CSS and JS by linting.

Usage: lint [options]

Validate CSS and JS by linting.

Options:
  -f, --fix               Fix lint errors.
  -c, --css               Only lint SASS files.
  -C, --css-files <glob>  SASS glob pattern [file|dir|glob]* to search for files.
  -j, --js                Only lint Javascript files.
  -J, --js-files <glob>   Javascript glob pattern [file|dir|glob]* to search for files.
  -h, --help              display help for command

Pattern Lab integration.

Usage: patternlab [options]

Compile Pattern Lab.

Options:
  -w, --watch  Watch for changes and rebuild.
  -p, --prod   Create a production build.
  -h, --help   display help for command

Sync assets/files between sites.

Usage: sync [options]

Sync asset files like js, css, fonts, and images to a site.

Options:
  -d, --dest <path>  Path to the theme directory or new site to export files into.
  -s, --src <path>   Path to the source from which files will be imported.
  -h, --help         display help for command

Create a new site from an existing site's "starterkit".

Notice: This is only useful in an existing project that has already set up a starterkit directory.

Usage: newsite [options]

Wire up a new site to allow syncing files from an existing project using its
starterkit. This assumes the command is being run within a project that has a
"starterkit" directory.

Options:
  -d, --dest <path>  Path to the theme directory or new site to export files into.
  -f, --force        Force overwrite of existing files in theme.
  -h, --help         display help for command

Validation and Linting

Lint all scss/js files using npx ucd-theme-tasks lint. Optionally pass the --fix flag to attempt to automatically fix as many errors a possible.

JavaScript Linting

Linting of JavaScript is done via EsLint.

A .eslintrc.yml configuration file will be copied to the root of your project automatically when running the ucd-theme-tasks init command.

Sass/Scss Linting

Linting of Sass/Scss files is done via StyleLint.

A .stylelintrc.yml configuration file will be copied to the root of your project automatically when running the ucd-theme-tasks init command.

Configuration

Vite

Vite is used to compile all code and can be configured with the vite.config.mjs file. https://vitejs.dev/config/

Default Tasks

tasks-config.default.js contains all of the default configuration for controlling the tasks. This file can be referenced for all possible config options. Docs can be found at https://github.com/ucdavis/ucd-theme-tasks/blob/master/docs/config.md

Version 4 removed many of the old configuration options since Vite handles them. Most of the configuration is now about path locations for syncing files across projects.

Pattern Lab

If you are using this package within Pattern Lab then it can build and watch patterns using ucd-theme-tasks patternLab.