Security News
Highlights from the 2024 Rails Community Survey
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
extract-gfm
Advanced tools
Utilities for extracting and replacing GitHub Flavored Markdown code blocks. For example, you could easily find code blocks for a specific language and run the code through a linter.
Utilities for extracting and replacing GitHub Flavored Markdown code blocks. For example, you could easily find code blocks for a specific language and run the code through a linter.
See the example for ideas.
npm i extract-gfm --save-dev
npm test
var extract = require('extract-gfm');
extract.parseBlocks('abc\n```js\nvar foo = "bar";\n```\nxyz');
Returns:
{ text: 'abc\n__CODE_BLOCK0__\nxyz',
blocks:
[ { lang: 'js',
code: 'var foo = "bar";',
block: '```js\nvar foo = "bar";\n```' } ],
markers: [ '__CODE_BLOCK0__' ] }
str
{String}: Original string with gfm code blocks.returns
: {String}Strip code blocks from a string and replaced them with heuristic markers.
str
{String}: The string to parse.returns
: {Array}Return an array of all gfm code blocks found. See gfm-code-blocks for more detail.
Convenience method to make it easy to replace code blocks.
str
{String}: The string to parse.returns
: {Object}Returns an object with:
text
: the string stripped of code blocks, where each block
is replaced with a heuristic marker.blocks
: An array of code blocks, using the .extractBlocks() method.markers
: An array of heuristic markers to be used for adding code blocks back.Example
var code = require('extract-gfm');
var fs = require('fs');
var str = fs.readFileSync('README.md', 'utf8');
console.log(code.parseBlocks(str));
Used for adding code blocks back into the string after they have been modified somehow.
str
{String}: A string with heuristic markers to replace.object
{String}: Object created by .parseBlocks()returns
{String}: Updated string, with shiny new code blocks.To customize how this is done, just look at the injectBlocks
method and create your own based on this. .parseBlocks()
really does all of the hard work.
Jon Schlinkert
Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license
This file was generated by verb-cli on September 23, 2014.
FAQs
Utilities for extracting and replacing GitHub Flavored Markdown code blocks. For example, you could easily find code blocks for a specific language and run the code through a linter.
We found that extract-gfm demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.