Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fliptopbox/cliches
Identify and list commonly used clichés used within a body of text
https://github.com/fliptopbox/cliches
Last synced: 4 days ago
JSON representation
Identify and list commonly used clichés used within a body of text
- Host: GitHub
- URL: https://github.com/fliptopbox/cliches
- Owner: fliptopbox
- License: mit
- Created: 2021-01-14T19:07:53.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-02-21T18:29:45.000Z (almost 4 years ago)
- Last Synced: 2024-12-09T23:20:48.035Z (26 days ago)
- Language: JavaScript
- Size: 109 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# clichés
A writting utility that uses a regular expression glossary to dynamically identify and list commonly used clichés
Install:
```bash
npm install -S cliches
```
Usage:
```javascript
const cliches = require(`cliches`);
const text = `
as "ugly as sin itself" oh ...
and yet he was totally under her thumb`;
const result = cliches.test(text);
console.log(result.length); // 2
console.log(result); // [ 'ugly as sin', 'under (his|her) thumb']
```
The [glossary of known phrases](./glossary.txt) is curated to use _Regular Expressions_ for dynamic group matching, where other similar utilities don't. This means a single phrase can encompass multiple gender and/or possension alternatives.
**Example phrases that use RegExp groups:**
- `all (\\w+) eggs in one basket`
- all **YOUR** eggs, or
- all **HIS** eggs .... or
- all **THEIR** eggs ...
- `burst (your|my) bubble`
- matches either **your** bubble or **my** bubble
- `ace up (his|her) sleeve`
- matches either **his** or **her** sleeve
---
#### General purpose word groups:
If you find a missing phrase, and want to contribute to the [glossary](./glossary.txt), here are some commonly used regular expressions, for your convienience.
- replace gender specific nouns with `(his|her)` - restricted to specific genders
- replace posession with `(your|my)`- restricted to specific ownership
- catch a broader subject with `(\\w+)` unrestricted, matches any word object
To add or edit this list please clone the repo and submit a pull-request.
---
#### Methods and properties
- **keys** - Array - a list of first word keys
- **phrases** - Array - a list of all the [known phrases](./glossary.txt)
- **test** - Function - analyze the input String and return an Array of matched phrases
- **clean** - Function - strips non-alpha characters and returns String
---
#### Example uses:
- *Twitter cliché re-tweeter* - coming soon
- *Eleventy Cliché Counter plugin* - coming soon
- [Cliché catcher](https://codepen.io/fliptopbox/pen/VwKVEVZ) on Codepen
- [RunKit](https://runkit.com/fliptopbox/cliches) - Node with REST endpoint