[npm資源] naming-style，快速轉換各種命名風格

parksben發表於2019-02-28
NPM

naming-style

www.npmjs.com/package/nam…

一個簡單的工具類庫，用於將文字轉化為不同格式的命名風格（如：駝峰式、連字元式、常量式等）。

安裝

yarn add naming-style
複製程式碼

or

npm i naming-style
複製程式碼

使用

import {
  style,
  camel,
  pascal,
  hyphen,
  constant,
  snake,
  underscore,
  setence,
} from `naming-style`;

style(`iAm24YearsOld`); // 檢測文字 `iAm24YearsOld` 的命名風格
// Output: `camel`

style(`--naming-style -loves you`); // 檢測文字 `--naming-style -loves you` 的命名風格
// Output: `other`

camel(`--naming-style -loves you`); // 轉換為駝峰式命名
// Output: `namingStyleLovesYou`

pascal(`--naming-style -loves you`); // 轉換為大寫駝峰式命名
// Output: `NamingStyleLovesYou`

hyphen(`--naming-style -loves you`); // 轉換為連字元式命名
// Output: `naming-style-loves-you`

constant(`--naming-style -loves you`); // 轉換為常量式命名
// Output: `NAMING_STYLE_LOVES_YOU`

snake(`--naming-style -loves you`); // 轉換為“蛇”式命名
// Output: `naming_style_loves_you`

sentence(`--naming-style -loves you`); // 轉換為單個句子
// Output: `Naming-style loves you`

underscore(`--naming-style -loves you`); // 轉換為下劃線形式
// Output: `__naming_style__loves_you`
複製程式碼

特性

1. 工具方法

  • 此類庫提供了 8 個工具方法：

    • style() 用於檢測文字的命名風格
    • 其他 7 個方法分別用於將文字轉換為對應的命名風格

2. 支援轉換的命名風格

  • 此類庫支援 7 種命名風格的轉換，分別為：camel, pascal, hyphen, constant, snake, sentence 和 underscore

  • 其中，前 6 種風格作為 基礎風格，下劃線風格（underscore）由基礎風格派生而成

舉例：

camel       -->  `iAm24YearsOld`
pascal      -->  `IAm24YearsOld`
hyphen      -->  `i-am-24-years-old`
constant    -->  `I_AM_24_YEARS_OLD`
snake       -->  `i_am_24_years_old`
sentence    -->  `I am 24 years old`
underscore  -->  `i_am_24_years_old`
複製程式碼

3. 基礎風格對應的方法是相互可逆的

  • 如果要轉換的文字屬於前面說的 6 種 基礎風格 之一，則使用其對應的轉換方法可以完成互逆的轉換

舉例：

import { style, camel, snake } from `naming-style`;

const origin = `i_am_24_years_old`;

const namingStyle = style(origin);
console.log(namingStyle);
// `snake`

const camelCase = camel(origin);
const snake_case = snake(camelCase);
const newCamelCase = camel(snake_case);

console.log(camelCase === newCamelCase);
// true
複製程式碼

4. 轉換無匹配風格的文字

  • 如果要轉換的文字不屬於類庫提供的 7 種風格，則 style 方法的返回為 `other`

舉例：

import { style } from `naming-style`;

style(`--naming-style -loves you`);
// Output: `other`
複製程式碼

相關文章