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

naming-style

https://www.npmjs.com/package...npm

一個簡單的工具類庫,用於將文本轉化爲不一樣格式的命名風格(如:駝峯式、連字符式、常量式等)。工具

安裝

yarn add naming-style

orcode

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 個工具方法:underscore

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

2. 支持轉換的命名風格

  • 此類庫支持 7 種命名風格的轉換,分別爲:camel, pascal, hyphen, constant, snake, sentenceunderscore
  • 其中,前 6 種風格做爲 基礎風格,下劃線風格(underscore)由基礎風格派生而成

舉例:get

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 種 基礎風格 之一,則使用其對應的轉換方法能夠完成互逆的轉換

舉例:console

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'

舉例:class

import { style } from 'naming-style';

style('--naming-style -loves you');
// Output: 'other'
相關文章
相關標籤/搜索