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

mkcat

v1.1.5

Published

Concatenate source files to an abstract syntax tree

Downloads

58

Readme

Cat

Build Status npm version Coverage Status

Load source files

Concatenate stdin and documents passed as files, buffer into a single markdown document, parse using commonmark, convert the parsed AST to newline-delimited JSON.

Install

npm i mkcat --save

For the command line interface install mkdoc globally (npm i -g mkdoc).

Usage

Create the stream and write a commonmark document:

var cat = require('mkcat')
  , ast = require('mkast');
cat({files: ['README.md']})
  .pipe(ast.stringify({indent: 2}))
  .pipe(process.stdout);

Example

Source files:

mkcat API.md README.md | mkout

Help

mkcat [options] [files...]

Concatenate source files to an abstract syntax tree.

  --no-ast    Disable AST output, prints input
  -h, --help  Display this help and exit
  --version   Print the version and exit

Report bugs to https://github.com/mkdoc/mkcat/issues

API

cat

cat(opts[, cb])

Concatenate stdin with files.

Callback takes the form function(err, result) where the type of result will change depending upon the options given.

When none of the buffer, stringify and ast options are given the the callback is invoked with no result when the serialize stream finishes.

Returns a buffered reader stream.

  • opts Object processing options.
  • cb Function callback function.

Options

  • files Array list of files to concatenate.
  • input Readable input stream to read before files.
  • output Writable output stream.
  • encoding String=utf8 character encoding.
  • buffer Boolean=false callback with Buffer.
  • stringify Boolean=false callback with a string.
  • ast Boolean=false callback with the parsed AST.
  • serialize Boolean=false pipe to a serialize stream.

License

MIT


Created by mkdoc.