roppa / wordify

Utility file to get meta data from authored content.

Wordify

A set of utilities for authors to get meta data from content and generally to play with words.

Usage

var wordify = require('wordify');

list

Get a unique list of words from content.

var list = wordify.list("List of words to make unique. Returns array with lots of words. Did I say lots of words?");

Result:

["array", "did", "i", "list", "lots", "make", "of", "returns", "say", "to", "unique", "with", "words" ]

stats

Returns an object with words and occurrances

var words = wordify.stats("the the the the man man man sat on the the the cat cat cat cat");

Returns:

{
	the: { count: 7 }, 
	man: { count: 3 }, 
	sat: { count: 1 }, 
	on: { count: 1 }, 
	cat: { count: 4 }
}

chunk

Break copy up based on the number of words you want in each chunk. Pass in the copy to be chunked, and the number of words in each chunk. Returns an array of strings.

wordify.chunk("this should be in first element, this should be in second element", 6)

Returns:

["this should be in first element,", "this should be in second element"]

wave

Break copy up in varying lengths forming a "wave". Lengths are characters to break into chunks at lengths specified. The length is used to find the closest space. Sizes go up, and then down, and repeated.

wordify.wave("the cat sat on the mat. The cat sat on the mat", [3, 5, 10])

Returns:

["the", "cat sat", "on the mat"]

count

Count the number of words in a string, removing any HTML and punctuation

var count = wordify.count("<p>List of words</p>");

Returns:

3

charCount

Returns the length of characters in a string. It strips out html and punctuation marks.

charCountPunctuated

Returns the length of characters in a string including punctuation marks.

wordify's Issues

Documentation confusingly mentions charCountWithCharacters function which doesn't exist

The charCountWithCharacters function does not exist but it is mentioned in the README