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

boco-markdown-driven

v0.3.6

Published

Markdown Driven Development

Downloads

10

Readme

boco-markdown-driven

npm version npm license dependencies join chat

Convert markdown documents into runnable specs/tests for your project.

Table of Contents

Installation

Install via npm:

$ npm install boco-markdown-driven

Overview

This library provides the following main components:

  • Parser - parses markdown tokens into a ParseTree representing a specification
  • Compiler - compiles markdown source to a specification format
  • Converter - reads markdown files, compiles, and writes specification files
  • CLI - command line interface

This library does not include a Generator. You should install one of the available generators, or write a generator for your language and test framework.

Generators

Generators consume a ParseTree and generate specification code for a given language and framework (ie: jasmine/coffee).

Available Generators

generator | framework | language | Notes :---------------------------|:-------------|:-----------|:------ boco-mdd-jasmine-coffee | jasmine | coffee | boco-mdd-jasmine-js | jasmine | js | coming soon boco-mdd-mocha-coffee | mocha | coffee | coming soon boco-mdd-mocha-js | mocha | js | coming soon

Write a Generator

Your generator class should have a single generate method that consumes a ParseTree and outputs specification code.

Take a look at the source for one of the available generators for more information.

If you have written a generator, please contact us to add it to the list.

Usage

MarkdownDriven = require "boco-markdown-driven"
MDDJasmineCoffee = require "boco-mdd-jasmine-coffee"

Using the API

Create a parser and a generator, then use them to construct a compiler:

parser = new MarkdownDriven.Parser nativeLanguages: ["coffee"]
generator = new MDDJasmineCoffee.Generator

compiler = new MarkdownDriven.Compiler
  parser: parser
  generator: generator

Compile markdown into testable source code:

compiler.compile "# Mather..." # => "describe 'Mather' -> ..."

Using the CLI

Create a configuration file and pass it to the CLI:

# compile all .md files in {readDir}
$ markdown-driven -c ./markdown-driven.json "**/*.md"

# get help
$ markdown-driven --help

# local installation
$ ./node_modules/.bin/markdown-driven --help
// file: "markdown-driven.json"
{
  // require this generator
  "generator": "boco-mdd-jasmine-coffee",

  // marked lexer constructor options
  // see: https://github.com/chjj/marked
  "lexerOptions": {
    "gfm": true
  },

  // parser constructor options
  "parserOptions": {
    "nativeLanguages": ["coffee"]
  },

  // generator constructor options
  "generatorOptions": null,

  // converter options
  "converterOptions": {
    "readDir": "docs",
    "writeDir": "spec",
    "writeExt": ".spec.coffee"
  }
}

The MIT License (MIT)

Copyright (c) 2015 Christian Bradley, Boco Digital Media, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.