Skip to content

Yord/klp-core

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TODO: klp-core teaser

🐴klp-core is a plugin with basic operations for klp (Kelpie), the small, fast, and magical command-line data processor.

See the klp github repository for more details!

node version npm version license PRs Welcome linux unit tests status macos unit tests status windows unit tests status

Installation

👌 klp-core comes preinstalled in klp. No installation necessary. If you still want to install it, proceed as described below.

klp-core is installed in ~/.klp/ as follows:

npm install klp-core

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

const core = require('klp-core')

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

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

Extensions

This plugin comes with the following klp extensions:

Description
line chunker Divides data on line breaks. A lot of data formats like CSV, TSV, and JSON line build on this separation.
map applier Applies klp's functions to each individual line. Always returns a single result, unless an error is thrown during function application.
flatMap applier Applies klp's functions to each individual line. May return any number of results, including none, thus being able to change the length of a file.
filter applier Treats klp's functions as a conjunction of predicates and applies it to each individual line. If any predicate is false, the line is dropped, if all predicates return true, the line is kept.
string serializer Serializes each transformed JSON into a string separated by newlines.

Reporting Issues

Please report issues in the tracker!

License

klp-core is MIT licensed.

About

A plugin with basic operations for klp (Kelpie), the small, fast, and magical command-line data processor.

Topics

Resources

License

Stars

Watchers

Forks