JoeKarlsson / punc

Ever wonder what your favorite books look like without words?

Punc

Read a file, remove the words, see all the punctuations.

Installation

npm install punc

Example Usage #1

'use strict'

const Punc = require('./index')

Punc('alice.txt', 'utf8')
  .then(dataFromPunc => console.log(dataFromPunc))
  .catch(error => handleError(error))

Output found: here

Documentation

Please see the wiki.

Features

1. Read a file, remove words and numbers, do something with the data:
   • data.count: keeps count of every punctuation seen
   • data.body: complete text with letters and numbers replaced with a space-character
   • data.wordCount: calculates the words per sentence average
2. Generate a PDF file. See how it would look like on e-paper

Notes

• Punctuations to keep when removing words:

  ; : ' " , ! ? . ( ) -

• Punctuations to use when counting occurances:

  ; : ' " , ! ? .

Inspiration

this article on medium which was in-turn inspired by this person's work.

License

MIT

Technical dependencies

• Node platform version: >5.0.0
• Promises with Bluebird: bluebird ^3.3.1
• Stream helper with Through2: through2 ^2.0.1