vite-plugin-font-carrier

A vite plugin to compress fonts on demand using font-carrier. It will only retain the characters you set to achieve minimize.

Install

npm install -D vite-plugin-font-carrier

Usage

vite.config.ts

import { defineConfig } from "vite";
import FontCarrier from "vite-plugin-font-carrier";

export default defineConfig({
  plugins: [FontCarrier({
    /** Fonts to be compressed */
    fonts: [
      {
        path: "./path/to/your/font/my-font.woff",
        /** Characters to be retained */
        input: "Cole52619"
      },
      {
        path: "/font-under-public-dir.ttf",
        input: "乱数假文Ipsum"
      }
    ],
    /** Output type */
    type: "woff2"
  })]
});

Character Preset

You can use character preset as your input.

import { allChars, lowercaseChars, numberChars, uppercaseChars } from "vite-plugin-font-carrier";

console.log(lowercaseChars); // abcdefghijklmnopqrstuvwxyz
console.log(uppercaseChars); // ABCDEFGHIJKLMNOPQRSTUVWXYZ
console.log(numberChars); // 0123456789
console.log(allChars); // abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789

Preview

Options

import type { Buffer } from "node:buffer";
import type { Font as FCFont } from "font-carrier";
import type { LogLevel } from "vite";

export interface FontCarrierOptions {
  /** Fonts to be compressed */
  fonts: Font[];

  /**
   * Specify root directory
   * Defaults to `root` in Vite config
   */
  root?: string;

  /**
   * Output font type
   * Defaults to 'woff2'
   */
  type?: FCFont.FontType;

  /**
   * Logging level
   * Defaults to `logLevel` in Vite config
   * @see https://vitejs.dev/config/shared-options.html#loglevel
   */
  logLevel?: LogLevel;

  /**
   * Defaults to `clearScreen` in Vite config
   * @see https://vitejs.dev/config/shared-options.html#clearscreen
   */
  clearScreen?: boolean;

  /** Whether to enable sourcemaps. Defaults to `css.devSourcemap` in Vite config */
  sourceMap?: boolean;

  /** Custom compress function */
  compressFn?: (source: Buffer, font: Required<Font>) => CompressFnReturn["source"] | CompressFnReturn;
}

export interface CompressFnReturn {
  source: Buffer;

  /** Extension name, eg."woff" */
  ext?: string;
}

export interface Font {
  /** path to your font file */
  path: string;

  /** Specify the characters you want to retain */
  input: string;

  /** Output font type, will cover the output type in `FontCarrierOptions` */
  type?: FCFont.FontType;
}

License

MIT License © 科科Cole