New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details →
Socket
Book a DemoSign in
Socket

reagan

Package Overview
Dependencies
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

reagan

compare code blocks in markdown documents to source files hosted on GitHub

latest
Source
npmnpm
Version
0.0.8
Version published
Maintainers
1
Created
Source

Reagan

Ronald Reagan in The Bad Man (1941)

Reagan is a tool for verifying that code samples embedded in a markdown document are in sync with the GitHub-hosted source files.

npm i -g reagan

Reagan will scan markdown file for code blocks preceded by a special HTML comments:

    <!-- source: http://github.com/your/repo/file.code#L10-L20 -->

    ```language
        some cool snippet
    ```

Reagan will compare the code block to the lines identified in the comment. By default, Reagan will scan the current directory for files with an md extension.

  Usage: reagan [options]

  Options:

    -h, --help             output usage information
    -V, --version          output the version number
    -f, --folder [folder]  the folder to search
    -i, --include [glob]   the pattern to match (defaults to **/*.md)
    -u, --update           attempt to update local files
    --strict               enforce exact matches

Keywords

markdown

FAQs

Package last updated on 05 Sep 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts