@cloak-app/boilerplate

1.4.2 • Public • Published

@cloak-app/boilerplate

Modules that setup standard Cloak conventions.

Install

  1. Install with yarn add @cloak-app/boilerplate
  2. Add to nuxt.config with buildModules: ['@cloak-app/boilerplate']

Module Options

Set these properties within cloak: { boilerplate: { ... } } in the nuxt.config.js:

  • helpers - An array of filenames to include from the helpers directory. By default, all helpers are included. Filename extensions are optional.
  • excludedHelpers - An array of filenames to exclude from the helpers directory. By default, this is empty. Filename extensions are optional.
  • modules - An array of filenames to include from the modules directory. By default, all modules are included. Filename extensions are optional.
  • excludedModules - An array of filenames to exclude from the modules directory. By default, this is empty. Filename extensions are optional.
  • polyfills - Array of polyfill.io keywords. For example, ["default", "URL", "IntersectionObserver"]. If objectFit is included, will add the objectFitPolyfill for VueVisual on IE11.
  • siteName - The name of the site, used to generate <title>, OG, and PWA tags.

Breaking Changes

Changes from @bkwld/cloak

  • No polyfills are added by default
  • Dropping support for Craft SSG generation with payloads

Contributing

Run yarn dev to open a Nuxt dev build of the demo directory.

/@cloak-app/boilerplate/

    Package Sidebar

    Install

    npm i @cloak-app/boilerplate

    Weekly Downloads

    19

    Version

    1.4.2

    License

    MIT

    Unpacked Size

    37.9 kB

    Total Files

    43

    Last publish

    Collaborators

    • isaazgarcia
    • lemoswilson
    • mattaebersold
    • brokenhd
    • sjstark
    • weotch