Nifty Procrastination Machine

    tablemark-cli

    3.0.0 • Public • Published

    tablemark-cli · Version License Travis CI JavaScript Standard Style

    Generate markdown tables from JSON data at the command line.

    Render JSON input data as a markdown table from the command line, powered by the tablemark module.

    features

    This utility supports:

    installation

    yarn global add tablemark-cli
    
    # or
    
    npm install --global tablemark-cli

    usage

    tablemark 3.0.0
    > Generate markdown tables from JSON data at the command line.
    
    ARGUMENTS:
      <input-file> - Path to input file containing JSON data (use - for stdin)
    
    OPTIONS:
      --column <str>, -c=<str>    - Custom column name, can be used multiple times (default: infer from object keys)
      --align <value>, -a=<value> - Custom alignments, can be used multiple times, applied in order to columns (default: left)
      --line-ending, -e <str>     - End-of-line string (default: \n) [optional]
      --wrap-width, -w <number>   - Width at which to hard wrap cell content [default: Infinity]
    
    FLAGS:
      --no-case-headers, -N   - Disable automatic sentence casing of inferred column names [default: false]
      --wrap-with-gutters, -G - Add '|' characters to wrapped rows [default: false]
      --help, -h              - show help
      --version, -v           - print the version

    To apply the align and column options to multiple columns, supply the flag multiple times, like this:

    tablemark input.json > output.md -a left -a center -a right

    ... which will align the first three columns left, center, and right respectively.

    stdin

    In bash-like shells:

    # stdin -> stdout
    echo '{ "one": 1 }' | tablemark -
    
    # redirect input file content into stdin, then to a file
    tablemark - < input.json > output.md

    In PowerShell:

    # stdin -> stdout
    '{ "one": 1 }' | tablemark -
    
    # redirect input file content into stdin, then to a file
    cat input.json | tablemark - > output.md

    ndjson

    NDJSON is a form of JSON that delimits multiple JSON objects by newlines:

    {"name":"trilogy","repo":"[haltcase/trilogy](https://github.com/haltcase/trilogy)","desc":"No-hassle SQLite with type-casting schema models and support for native & pure JS backends."}
    {"name":"strat","repo":"[haltcase/strat](https://github.com/haltcase/strat)","desc":"Functional-ish JavaScript string formatting, with inspirations from Python."}
    {"name":"tablemark-cli","repo":"[haltcase/tablemark-cli](https://github.com/haltcase/tablemark-cli)","desc":"Generate markdown tables from JSON data at the command line."}

    This input from a file or stdin is supported just as if it were a JSON compatible array:

    tablemark input.ndjson > output.md

    see also

    • tablemark – the module used by this utility

    contributing

    Search the issues if you come across any trouble, open a new one if it hasn't been posted, or, if you're able, open a pull request. Contributions of any kind are welcome in this project.

    The following people have already contributed their time and effort:

    Thank you!

    license

    MIT © Bo Lingen / haltcase

    Install

    npm i tablemark-cli

    DownloadsWeekly Downloads

    2,012

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    11.9 kB

    Total Files

    7

    Last publish

    Collaborators

    • citycide
    • haltcase