Git Product home page Git Product logo

vite-plugin-literals-collector's Introduction

vite-plugin-literals-collector

A plugin for Vite to collect all wanted matching characters.

You can use this plugin to collect all wanted matching characters in your project, and then use them to generate a subset font file or something else.

Usage

Install

$ yarn add -D vite-plugin-literals-collector
# or npm i -D vite-plugin-literals-collector

Add it to vite.config.js

// vite.config.js
import { CJK, literalsCollector } from 'vite-plugin-literals-collector'

const onResult = (result) => {
  console.log(result)
}

export default {
  plugins: [
    literalsCollector({
      target: CJK,
      onResult
    })
  ],
}

Options

interface Options {
  /**
   * included filed or folder, defaults to [/\.tsx?$/, /\.jsx?$/]
   */
  include?: FilterPattern
  /**
   * excluded files or folder, defaults to undefined
   */
  exclude?: FilterPattern
  /**
   * wanted matching characters
   */
  target?: FilterPattern
  /**
   * onResult logger, defaults to (final: string[]) =>
   *  console.log(`* LiteralsCollector: collected ${final.length} characters`)
   */
  formatter?: (result: string[]) => void
  /**
   * result callback, defaults to undefined
   */
  onResult?: (result: string[]) => void
}

Thanks

LICENSE

MIT

vite-plugin-literals-collector's People

Contributors

comfyfluffy avatar kusstar avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

comfyfluffy

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.