pinyin-slug

一个轻量且灵活的 URL slug 生成工具，可将中文文本转换为拼音 slug。由 pinyin-pro 提供底层支持。

特性

• 🚀 高效: 在 pinyin-pro 基础上仅进行最轻量的处理。
• 🛠 可配置: 完全控制拼音转换和 Slug 格式化逻辑。
• 🔠 混合内容: 优雅处理中英文/非中文混合文本。
• 🛡 TypeScript: 完整的类型定义，提供极佳的开发体验。
• 📦 精简依赖: 除了 pinyin-pro，不依赖任何第三方 slug 库。

安装

npm install pinyin-slug
# 或
yarn add pinyin-slug
# 或
pnpm add pinyin-slug

快速上手

基本用法

import { pinyinSlug } from 'pinyin-slug';

console.log(pinyinSlug('你好世界')); 
// 输出: ni-hao-shi-jie

console.log(pinyinSlug('Hello 你好')); 
// 输出: hello-ni-hao

自定义配置

你可以分别配置拼音转换选项和 slug 格式化选项：

import { pinyinSlug } from 'pinyin-slug';

const slug = pinyinSlug('你好，世界！', {
  pinyin: {
    toneType: 'num', // 拼音带声调数字
  },
  slug: {
    replacement: '_', // 使用下划线作为分隔符
    lower: false,     // 不强制转小写
  }
});

console.log(slug); 
// 输出: ni3_hao3_shi4_jie4

API

pinyinSlug(text, options?)

参数

• text (string): 输入的包含中文的字符串。
• options (object): 可选配置。
  • pinyin (object): 直接传递给 pinyin-pro 的配置项。参考 pinyin-pro 文档。
  • slug (object): Slug 格式化配置。
    • replacement (string): 用于替换空格的分隔符。默认: '-'。
    • remove (RegExp): 用于移除非法字符的正则表达式。默认: /[^\w\s-]/g。
    • lower (boolean): 是否转换为小写。默认: true。
    • trim (boolean): 是否去除首尾空格。默认: true。

开源协议

MIT