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

reamde

v1.1.0

Published

Strips javascript code blocks out of README (or any other markdown) files and converts them into function objects.

Downloads

325

Readme

Reamde Build Status Dependency Status

Strips javascript code blocks out of README (or any other markdown) files and converts them into function objects.

Examples

Basic

var fs       = require('fs')
  , reamde   = require('reamde')
  , examples = reamde(fs.readFileSync('./README.md', 'utf-8'))
  ;

console.log(examples);
// -> outputs list of function objects

File README.md contains following:

### Basic:

```javascript
var fs       = require('fs')
  , reamde   = require('reamde')
  , examples = reamde(fs.readFileSync('./README.md', 'utf-8'))
  ;

console.log(examples);
// -> outputs list of function objects

```

Non-Runnable Example

$ echo "This code block won't be converted into a function"
This code block won't be converted into a function
$

File README.md contains following:

### Not runnable example:

```
$ echo "This code block won't be converted into a function"
This code block won't be converted into a function
$
```

Replacements

Reamde accepts list of pattern-replacement pairs that will be converted into global RegExps and run against function body. Replacement could be string or object, in the latter case randomly generated id will be used as replacement within function body and the object will be passed as function call argument.

var fs      = require('fs')
  , reamde  = require('reamde')
  , content = fs.readFileSync('./README.md', 'utf-8')
  , examples
  ;

examples = reamde(content, {replace:
{
  'require(\'reamde\')' : reamde,
  'console.log('        : 'callback('
}});

console.log(examples);
// -> outputs list of function objects

Runtime Arguments

Also Reamde accepts array of runtime-populated arguments, which will be listed after replacement referenced arguments.

var fs      = require('fs')
  , reamde  = require('reamde')
  , content = fs.readFileSync('./README.md', 'utf-8')
  , examples
  ;

function customLog(data)
{
  console.log({'data': data});
}

examples = reamde(content, {runtime: ['console'], replace: {'\'reamde\'': '\'./\''}});

// run first example with custom object,
// to get assert call instead of console.log
examples[0]({log: customLog});

Require Mapping

Allows to substitute required modules from example with custom functions. Each mapping member should be a function that returns required module or its substitute. Optionally accepts require function as first argument, in case you have provided custom require for the examples.

var fs      = require('fs')
  , reamde  = require('reamde')
  , content = fs.readFileSync('./README.md', 'utf-8')
  , examples
  , options
  ;

// prepare option
options =
{
  mapping: {'reamde': function(require) { return require('./'); }}
};

examples = reamde(content, options);

console.log(examples);

TODO

  • Don't strip 4+ spaces indentation with runnable examples.

License

Licensed under the MIT license.