documentation.md

• jshint This takes the input and runs it through JSHint. The command is of the form js stuff | jshint options, globals, shortname, print clean.

  • The options is an object that corresponds to the options that JShint accepts; you can use a subcommand to create the options object if you like. Default is unused:true, else is their defaults.
  • Globals is an array of global names; if they can be written over, pass in name:true instead of name.
  • Shortname is the shortname to present in understanding what is being jshinted. Otherwise, it does its best to give you a cryptic but informative name.
  • If the fourth argument is a boolean, t() or f() will do it, then that toggles whether to print the message that it all went smoothly or not, respectively. The default is to not print it.
  • You can override the defaults repeatedly by modifying the Folder.plugins.jshint object with the names: options, globals, and clean.

• md This takes the input as markdown and puts out html. The first argument is an optional string naming the renderer to use. The other arguments should be booleans, namely, f(), if one does not want preprocessing/post to occur. The default preprocessors, in order, are literate programming subs and math subs rendering to katex.

  To create a renderer, you can use Folder.plugins.md.req as the markdoan object and then render it per the instructions (an options object req(options).use(...). This is all best done in the lprc.js file. Store the rendered under the preferred name in plugins.md.

  See the logs test directory and its lprc.js.

• cheerio This gives access to the cheerio module, a lightweight node version of jQuery-esque without the overhead of jsdom. It can't do everything, but it does most things: cheeriojs. To use, the incoming text is the html doc to modify, the first argument is the selector, the second the method, and then the arguments to the method, e.g., somehtml | cheerio h2.title, .text, Hello there!

• ch-replace This is a convenience method for cheerio. This will use the first argument as a selector and the second argument as a html replacement.

• postcss This takes incoming text and runs it through postcss. To do something useful, you need to have the arguments be the commands to use. At the moment, the only one shipping with this is autoprefixer, but others are likely to be added (minimizers and fixers, in particular). You can add them yourself by, in lprcs.js, saying (installing cssnano as example) Folder.plugins.postcss[cssnano] = require('cssnano'); and ensuring that the cssnano module is installed in npm.

• tidy This uses js-beautify The first argument is the type: js, css, or html. The second argument are options that get merged with the defaults. The js has a default of indent_size of 4 and jslint_happy true. An unrecognized first argument (or none) will default to js.

• minify The first argument says the type of minifier: js, css, and html. js is the default if the first argument is not realized. The second argument is an object of options that get passed in. This uses uglify-js, clean-css, and html-minifier, respectively. For css, the second argument can be a boolean indicating whether to pass on the results object (if true, t() ) or just the css output text (default).

• date ... |date method||date, arg1, arg2, ... This uses the date-fns library. Any valid function in that should work fine. There are a few scenarios for getting a date going:

  • date object | date method, arg1, ... will apply the method of datefns to the date as the leading argument and use the rest of the arguments to fill it in. Alias: date object | -method arg1, ..
  • date string | date method, arg1, ... will apply the method to the date parsed by datefns.parse Alias: date string | -method arg1, ..
  • | date method, arg1, ... will apply the method to today's date. Alias | -method arg1, ...
  • | date Just returns today's date. No alias
  • | date string date, method, args1, ... will parse the string date and apply the method. No alias.
  • Note that there is also a subcommand date that will generate today's date or a date object based on the input.

  Recommended form: | date string | -method arg1, ...| ...

• csv-parse/transform/stringify This is an interface into the node-csv library. It does the three named methods. The first argument can be an object of options except for transform in which the options are second and the first argument is a function to execute on each row. See node-csv for more details.

  If you need to use the streaming power, you should access the full power of it using Folder.requres.csv and take a look at, for example, so

• lodash The incoming data is the first argument into the function while the first argument is the method name. The other arguments are what they are.

  Example: abc | - pad 8, 0

• html-encode/decode/qescape This is an interface to the he library. It encodes and decodes all named html entities. There is also a simple escape function, that includes quotes which the lit-native html-escape does not.