node-stationery v0.1.6

Dear So & So

A tool for composing letters in the command line. Inspired by jrnl.

$ dear Beatrice, Then is courtesy a turncoat. But it is certain I am loved of all ladies,
only you excepted; and I would I could find in my heart that I had not a hard heart,
for truly I love none. --yours, Benedick

Results in:

beatrice-12-2-17.txt
> Dear Beatrice,
> 
> Then is courtesy a turncoat. But it is certain
> I am loved of all ladies, only you excepted; and
> I would I could find in my heart that I had not a
> hard heart, for truly I love none.
> 
> Yours,
> Benedick

Installation

npm install -g dear-sns

Documentation

Compositions

Compose letters with the dear command, following much in the way that you would write a normal letter.

After dear, if the next word contains a , at the end, that word will be your subject. For example, dear Beatrice, has the subject: Beatrice. If no subject is provided and you want to jump straight into the body of your letter, the default subject is "so and so". All text that follows will be the body of your letter. End your letter with --yours, author to provide the name of the author, or "truly" if none provided.

Dear So & So saves new letters at the path: %USERPROFILE%/dear-sns/compositions/. Letters are named with the format: <subject>-<timestamp>.txt.

Custom Templates

You can write your own letter templates and provide them to Dear So & So through the --tpl command. Templates follow the standard mustache handlebar syntax with the following keywords:

• subject - The subject of the letter
• body - The body text of the letter
• author - The author of the letter

Here's the default template for letters, basic-letter.mustache:

Dear {{ subject }},

{{ body }}

Yours,
{{ author }}

Create your own template in the ./templates/ directory and pass it in using --tpl:

dear Beatrice, Then is courtesy a turncoat. --tpl basic-letter

Roadmap

• Basic letter templates and save to file
• Custom signatures
• Template engine
• Editing utilities
• Searching utilities
• Notetaking
• Multiple output formats
• Copy to clipboard