@pfx/sample is a sample plugin for pf, the fast and extensible command-line data (e.g. JSON) processor and transformer.

See the pf github repository for more details!

Installation

@pfx/sample is installed in ~/.pfrc/ as follows:

npm install @pfx/sample

The plugin is included in ~/.pfrc/index.js as follows:

const sample = require('@pfx/sample')

module.exports = {
  plugins:  [sample],
  context:  {},
  defaults: {}
}

For a much more detailed description, see the .pfrc module documentation.

Extensions

This plugin comes with the following pf extensions:

| | Description | |---------------------|---------------------------------------------------------------------------------| | sample lexer | A sample lexer showcasing the structure and contents of a pf lexer. | | sample parser | A sample parser showcasing the structure and contents of a pf parser. | | sample applicator | A sample applicator showcasing the structure and contents of a pf applicator. | | sample marshaller | A sample marshaller showcasing the structure and contents of a pf marshaller. |

Reporting Issues

Please report issues in the tracker!

License

@pfx/sample is MIT licensed.