Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.35 KB

making-of.adoc

File metadata and controls

35 lines (26 loc) · 1.35 KB

The Making-of this project

Library selection

Node.js CLI Apps Best Practices has great guidelines, and some of them, point to some specific library.

  • Command line parsing: Yargs is pirate-themed and recommended by the above guidelines. However, TiddlyServer uses Commander.js so that is a sensible choice.

  • Prompts: Prompts, with its select (for TiddlyWiki editions) and maybe multi-select (for plugins?). Enquirer also looks good, but it has less stars and weekly downloads.

  • Colors: KLEUR, since it is already used by Prompts.

Coding standards

Went for StandardJS, although I am aware that it clashes with [TiddlyWiki Coding Style Guidelines]https://tiddlywiki.com/dev/#TiddlyWiki%20Coding%20Style%20Guidelines, that demand double quotes and 4 spaces for indentation

Local testing

When a package does not have a bin entry in its package.json, running npx folderForThisProject works. However, now that we have a bin entry, we need to run npx --package folderForThisProject create-tiddlywiki.