vite-plugin-kim

English | 简体中文

A Vite plugin that implements global text enlargement and bold styling at build time.

In some countries, all websites have a program that enlarges and bolds the names of their leaders to show respect for them. This plugin is inspired by that.

You can easily highlight specified text in your Vue and React projects by configuring this plugin.

Thanks

This plugin is inspired by Dear Comrade Kim Jong Un.

Features

• Precise Matching - Only processes text specified in configuration
• HMR Support - Automatic hot reload when configuration file changes
• Runtime API - Dynamic control interface
• Exclusion Mechanism - Support data-kim-ignore attribute to exclude specific elements
• Framework Agnostic - Supports Vue, React and other mainstream frameworks

Installation

Use npm or pnpm to install the plugin:

npm install vite-plugin-kim -D
# or
pnpm add vite-plugin-kim -D

Usage

1. Configure Vite

// vite.config.ts
import { defineConfig } from 'vite'
import kim from 'vite-plugin-kim'

export default defineConfig({
  plugins: [kim()],
})

2. Create Configuration File

Create kim.config.ts in your project root:

// kim.config.ts
import { defineKimConfig } from 'vite-plugin-kim'

export default defineKimConfig({
  // Text patterns to detect and enhance
  texts: [
    '金正恩',
    'Kim Jong Un',
    /urgent.*/i, // 'Regular expressions supported
  ],

  // Optional configuration
  scale: 1.2, // Scale factor, default 1.2
  fontWeight: 'bold', // Font weight, default bold
})

3. Exclude Specific Elements

Use data-kim-ignore attribute to exclude elements from processing:

<!-- Text in this element will not be processed -->
<span data-kim-ignore>Important</span>

<!-- All text in this container will be ignored -->
<div data-kim-ignore>
  <p>Warning: This text will not be enlarged or bolded</p>
</div>

Runtime API

import { kim } from 'vite-plugin-kim/client'

// Toggle control
kim.enable() // Enable effect
kim.disable() // Disable effect
kim.toggle() // Toggle state

// State check
kim.isEnabled() // Returns boolean

// Dynamic modification
kim.setScale(1.5) // Modify scale factor
kim.setFontWeight('bold') // Modify font weight

// Get current configuration
kim.getScale() // Get current scale factor
kim.getFontWeight() // Get current font weight
kim.getState() // Get complete state

// Event listening
const unsubscribe = kim.on('change', (state) => {
  console.log('State changed:', state)
})

// Unsubscribe
unsubscribe()

Configuration Options

kim.config.ts

Plugin Options

kim({
  configFile: 'kim.config', // Config file name (without extension)
})

How It Works

1. Configuration Loading - Load kim.config.ts from project root at Vite build start
2. AST Transformation - Parse Vue/React templates during Transform phase to identify matching text
3. Tag Wrapping - Wrap matched text as <span class="kim-text">text</span>
4. Style Injection - Inject global CSS styles to control enlargement and bold effects
5. Runtime Control - Enable dynamic control via CSS variables and data attributes

Examples

Vue Component

Before transformation:

<template>
  <div>
    <p>This is an Important notification</p>
    <p data-kim-ignore>This Important text will not be processed</p>
  </div>
</template>

After transformation:

<template>
  <div>
    <p>This is an <span class="kim-text">Important</span> notification</p>
    <p data-kim-ignore>This Important text will not be processed</p>
  </div>
</template>

React Component

Before transformation:

function App() {
  return (
    <div>
      <p>This is an Important notification</p>
      <p data-kim-ignore>This Important text will not be processed</p>
    </div>
  )
}

After transformation:

function App() {
  return (
    <div>
      <p>This is an <span className="kim-text">Important</span> notification</p>
      <p data-kim-ignore>This Important text will not be processed</p>
    </div>
  )
}

Development

Setup

# Install dependencies
pnpm install

# Build package
pnpm build

# Run tests
pnpm test

# Type check
pnpm typecheck

Publishing

This project uses GitHub Actions for automated publishing to npm. To publish a new version:

1. Update version in package.json
2. Commit and push changes
3. Create a new release on GitHub with a tag (e.g., v1.0.0)
4. The publish workflow will automatically run and publish to npm

Requirements:

• Add NPM_TOKEN to your GitHub repository secrets
• The token should have publish permissions for the package

Acknowledgments

This plugin was inspired by the need for accessible text enhancement in web applications. Special thanks to:

• The Vite team for the excellent plugin system and documentation
• The Vue and React communities for their comprehensive AST tooling
• magic-string for efficient source code manipulation
• All contributors and users who help improve this plugin

License

MIT