Skip to content

Latest commit

 

History

History
144 lines (119 loc) · 3.4 KB

usage.md

File metadata and controls

144 lines (119 loc) · 3.4 KB

Usage

With Hamber Config

Some tools of the Hamber ecosystem, such as hamber-vscode and hamber-kit, need access to your hamber configuration so they know how to properly handle your Hamber files. This can be achieved by creating a hamber.config.js file at the root of your project which exports a hamber options object (similar to hamber-loader and rollup-plugin-hamber).

Example:

Write the config in ESM style when you have "type": "module" in your package.json. This is the case for Wite starters and HamberKit projects.

// hamber.config.js
import preprocess from 'hamber-preprocess';

/** 
 * This will add autocompletion if you're working with HamberKit
 * 
 * @type {import('@hamberjs/kit').Config} 
 */
const config = {
  preprocess: preprocess({
    // ...hamber-preprocess options
  }),
  // ...other hamber options
};

export default config;

Write the config in CommonJS style when you don't have "type": "module" in your package.json. This is the case for the Hamber starter template.

// hamber.config.js
const hamberPreprocess = require('hamber-preprocess');
module.exports = {
  preprocess: hamberPreprocess({
    // ...hamber-preprocess options
  }),
  // ...other hamber options
};

Tip: this file can be imported in your bundle config instead of having multiple hamber configurations lying around.

With rollup-plugin-hamber

// rollup.config.js
import hamber from 'rollup-plugin-hamber';
import hamberPreprocess from 'hamber-preprocess'
import { scss, coffeescript, pug } from 'hamber-preprocess'

export default {
  ...,
  plugins: [
    hamber({
      /**
       * Auto preprocess supported languages with
       * '<template>'/'external src files' support
       **/
      preprocess: hamberPreprocess({ /* options */ })
      /**
       * It is also possible to manually enqueue
       * stand-alone processors
       * */
      preprocess: [
        pug({ /* pug options */ }),
        scss({ /* scss options */ }),
        coffeescript({ /* coffeescript options */ })
      ]
    })
  ]
}

With hamber-loader

  ...
  module: {
    rules: [
      ...
      {
        test: /\.(html|hamber)$/,
        exclude: [],
        use: {
          loader: 'hamber-loader',
          options: {
            preprocess: require('hamber-preprocess')({
              /* options */
          })
          },
        },
      },
      ...
    ]
  }
  ...

With Ramber

Ramber has two build configurations, one for the client bundle and one for the server. To use hamber-preprocess with Ramber, you need to define it on both configurations.

// ...
import hamberPreprocess from 'hamber-preprocess';

const preprocess = hamberPreprocess({
  postcss: true,
  // ...
});

export default {
  client: {
    plugins: [
      hamber({
        preprocess,
        // ...
      }),
  },
  server: {
    plugins: [
      hamber({
        preprocess,
        // ...
      }),
    ],
  },
};