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

@cloudcannon/data-extractor

v0.0.1

Published

Parses content files to generate a dataset.

Downloads

107

Readme

Data Extractor

Parses content files to generate a dataset. The output is sent to stdout, ready to pipe into a file for another process to consume.



Installation

npm install --global @cloudcannon/data-extractor

This gives you access to the data-extractor binary.


Usage

data-extractor <path> [options]

To print usage details:

data-extractor --help

Parses content files to generate a dataset.

Usage
  $ data-extractor <path> [options]

Options
  --recursive, -r  Search folders recursively
  --no-recursive,  Prevents search folders recursively (default)
  --extension, -e  Allowed extension(s) to parse (default: 'md')
  --selector,  -s  JSON path to the data you want to parse (required)
  --verbose        Prints more debugging information
  --help           Prints this usage information
  --version        Prints the current version

Examples
  $ data-extractor content/posts -r -s '$.categories'
  $ data-extractor content -e md -e html -s 'seo.title'

Examples

Create a file at data/categories.json containing the combined, unique values of categories from the front matter of each file at content/posts/**/*:

data-extractor content/posts -r -s '$.categories' > data/categories.json

Create a file at data/page-titles.json containing the combined, unique values of seo.title from the front matter of each Markdown and HTML file at content/*:

data-extractor content -e md -e html -s 'seo.title' > data/page-titles.json

Development

Install dependencies:

npm i

Run tests:

npm test
npm run test:watch
npm run test:coverage

Lint code:

npm run lint

Link this package locally to test it on a site folder, then run it within your site folder:

npm link
cd ../my-ssg-site
data-extractor

License

ISC