pangu/README.md

Paranoid text spacing for good readability, to automatically insert whitespace between CJK (Chinese, Japanese, Korean) and half-width characters (alphabetical letters, numerical digits and symbols).

# 為什麼你們就是不能加個空格呢？

[![npm Version](https://img.shields.io/npm/v/pangu?style=for-the-badge)](https://www.npmjs.com/package/pangu)
[![Chrome Web Store Version](https://img.shields.io/chrome-web-store/v/paphcfdffjnbcgkokihcdjliihicmbpd?style=for-the-badge)](https://chrome.google.com/webstore/detail/paphcfdffjnbcgkokihcdjliihicmbpd)
[![jsDelivr Hits](https://img.shields.io/jsdelivr/npm/hm/pangu?style=for-the-badge)](https://www.jsdelivr.com/package/npm/pangu)
[![npm Downloads](https://img.shields.io/npm/dm/pangu?style=for-the-badge&label=npm)](https://www.npmjs.com/package/pangu)

如果你跟我一樣，每次看到網頁上的中文字和英文、數字、符號擠在一塊，就會坐立難安，忍不住想在它們之間加個空格。這個 Google Chrome 外掛正是你在網路世界走跳所需要的東西，它會自動替你在網頁中所有的中文字和半形的英文、數字、符號之間插入空白。

漢學家稱這個空白字元為「盤古之白」，因為它劈開了全形字和半形字之間的混沌。另有研究顯示，打字的時候不喜歡在中文和英文之間加空格的人，感情路都走得很辛苦，有七成的比例會在 34 歲的時候跟自己不愛的人結婚，而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。

與大家共勉之。

[![](browser-extensions/chrome/images/chrome_web_store_badge.png)](https://chrome.google.com/webstore/detail/paphcfdffjnbcgkokihcdjliihicmbpd)

## Installation

### For Users

- Official support:
  - [Google Chrome Extension](https://chrome.google.com/webstore/detail/paphcfdffjnbcgkokihcdjliihicmbpd)
- Community support:
  - [Paranoid Text Spacing](https://tools.1chooo.com/paranoid-text-spacing)
  - [盤古之白 - 文案排版轉換](https://pangu.serko.dev/)

### For Developers

- Official support:
  - [pangu.js](https://github.com/vinta/pangu.js)
  - [pangu.py](https://github.com/vinta/pangu.py)
  - [pangu.go](https://github.com/vinta/pangu)
  - [pangu.java](https://github.com/vinta/pangu.java)
  - [pangu.space](https://github.com/vinta/pangu.space)
- Community support:
  - [pangu.clj](https://github.com/coldnew/pangu.clj)
  - [pangu.dart](https://github.com/SemonCat/pangu.dart)
  - [pangu.ex](https://github.com/cataska/pangu.ex)
  - [pangu.objective-c](https://github.com/Cee/pangu.objective-c)
  - [pangu.php](https://github.com/Kunr/pangu.php)
  - [pangu.rb](https://github.com/dlackty/pangu.rb)
  - [pangu.rs](https://github.com/airt/pangu.rs)
  - [pangu.swift](https://github.com/X140Yu/pangu.Swift)
  - [pangu.skill](https://github.com/shihyuho/pangu.skill)

## Usage

```bash
npm install pangu --save-exact
```

Learn more on [npm](https://www.npmjs.com/package/pangu).

### Browser

**Make sure to import from `pangu/browser`** in ESM, which is the DOM-aware build (`spacingNode()`, `autoSpacingPage()`) with matching TypeScript types and resolves correctly across all bundlers.

```js
import pangu from 'pangu/browser';
// or
// <script src="https://cdn.jsdelivr.net/npm/pangu@latest/dist/browser/pangu.umd.js"></script>

const text = pangu.spacingText('當你凝視著bug，bug也凝視著你');
// text = '當你凝視著 bug，bug 也凝視著你'

pangu.spacingNode(document.getElementById('main'));
document.querySelectorAll('.comment').forEach((el) => pangu.spacingNode(el));
document.querySelectorAll('p').forEach((el) => pangu.spacingNode(el));

// Listen to any DOM change and automatically perform spacing via MutationObserver()
document.addEventListener('DOMContentLoaded', () => pangu.autoSpacingPage());
```

Also on:

- [jsDelivr](https://www.jsdelivr.com/package/npm/pangu)
  - `https://cdn.jsdelivr.net/npm/pangu@x.y.z/dist/browser/pangu.umd.js`
- [unpkg](https://app.unpkg.com/pangu)
  - `https://unpkg.com/pangu@x.y.z/dist/browser/pangu.umd.js`

Replace `x.y.z` with the version you want to use.

### Node.js

```js
import pangu from 'pangu';
// or
// const pangu = require('pangu');

const text = pangu.spacingText('與PM戰鬥的人，應當小心自己不要成為PM');
// text = '與 PM 戰鬥的人，應當小心自己不要成為 PM'

const content = await pangu.spacingFile('/path/to/text.txt');
```

You **SHOULD NOT** use `pangu.js` to spacing Markdown documents, this library is specially designed for HTML webpages and plain texts without any markup language. See [issue #127](https://github.com/vinta/pangu.js/issues/127).

### CLI

```bash
$ pangu "不能信任那些Terminal或Editor用白底的人"
不能信任那些 Terminal 或 Editor 用白底的人

$ pangu -t "你在每個commit裡修改的程式碼越多，你在code review時被發現的錯誤就會越少"
你在每個 commit 裡修改的程式碼越多，你在 code review 時被發現的錯誤就會越少

$ pangu -f path/to/file.txt
新來的 Designer 趁特價的時候幫自己買了一本 GoF Design Patterns

$ pangu -c "盤古新聞網：工程師會議中默不作聲，PM恐成最大贏家"; echo $?
Corrected: 盤古新聞網：工程師會議中默不作聲，PM 恐成最大贏家
1

$ echo "他們在release的前一天爆炸" | pangu
他們在 release 的前一天爆炸
```

## License

Released under the [MIT License](https://opensource.org/licenses/MIT).

## Author

- GitHub: [@vinta](https://github.com/vinta)
- Twitter: [@vinta](https://twitter.com/vinta)
- Website: [vinta.ws](https://vinta.ws/code/)