npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

asciiparse

v0.1.1

Published

Parse ascii tables into rows and columns.

Downloads

58

Readme

ASCII Parse

ASCII table parser written for Node.js.

Install

Install using NPM

npm install asciiparse

Use

asciiparse has three visible methods, based on how you store the data


var asciiparse = require('asciiparse');

// Read and parse a file
asciiparse.parseFile(filename, [options], callback);

// Parse buffers or strings
asciiparse.parseBuffer(buffer, [options], callback);
asciiparse.parseString(string, [options], callback);

Options

The options field is optional and can be omitted in favor of the defaults. If options are provided, any missing values will default.

  • rowSeparator ('-'): Separator between rows
  • colSeparator ('|'): Separator between columns
  • junction ('+'): Where rowSeparator and colSeparator meet. Corners of cells and the table.
  • multiline (true): Whether body rows are separated by rowSeparator or newline
  • header (true): If false, a two-dimensional array is returned. If true, the first row is treated as column names and an array of objects keyed by column is returned
  • emptyCells (true): Whether to keep empty cells. If header is true, setting this to false may cause errors.
  • multilineSeparator ('\n'): The character or string to insert between lines of a multiline cell when collapsed.

Examples

Single Line, No Header Row

+-----------+--------------+
| Athens    | Tue 11:14 PM |
| Las Vegas | Tue  1:14 PM |
| London    | Tue  9:14 PM |
+-----------+--------------+

and

+-----------+--------------+
| Athens    | Tue 11:14 PM |
+-----------+--------------+
| Las Vegas | Tue  1:14 PM |
+-----------+--------------+
| London    | Tue  9:14 PM |
+-----------+--------------+

are equivalent in single line mode. When header mode is off, both evaluate to

[ ['Athens', 'Tue 11:14 PM'],
  ['Las Vegas', 'Tue 1:14 PM'],
  ['London', 'Tue 9:14 PM'] ]

Single Line, Header Row

Modifying the example above to include a header row...

+-----------+--------------+
| City      | Time         |
+-----------+--------------+
| Athens    | Tue 11:14 PM |
| Las Vegas | Tue  1:14 PM |
| London    | Tue  9:14 PM |
+-----------+--------------+

evaluates to

[
	{ City: 'Athens', Time: 'Tue 11:14 PM' },
	{ City: 'Las Vegas', Time: 'Tue 1:14 PM' },
	{ City: 'London', Time: 'Tue 9:14 PM' },
]

Multiple Line

In multiline mode, rows MUST be separated by junction and rowSeparator. Otherwise all rows would be combined.

+--------+--------------+
| City   | Time         |
+--------+--------------+
| Athens | Tue 11:14 PM |
+--------+--------------+
| Las    | Tue  1:14 PM |
| Vegas  |              |
+--------+--------------+
| London | Tue  9:14 PM |
+--------+--------------+

Custom separators

*====*============*====================*
; a  ; apple      ; Some longer string ;
; b  ; banana     ; hi                 ;
; c  ; carrot     ; meow               ;
; e  ; elephants  ;                    ;
*====*============*====================*

parses correctly, given the custom options:

{
	rowSeparator: '=',
	colSeparator: ';',
	junction: '*',
	
	multiline: false,
	header: false
}