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

@hoast/source-readfiles

v3.1.0

Published

Read files from the filesystem.

Downloads

7

Readme

@hoast/source-readfiles

Read files from the filesystem.

Install

npm install @hoast/source-readfiles

Options

  • {String} directory = 'src' Directory path, either absolute or relative to the working directory.

  • {Array} filterPatterns = null Glob patterns used to filter the file paths relative to the set directory with.

  • {Object} filterOptions Pattern matching options.

    • {Boolean} all = false Whether all patterns have to match, or any match is sufficient.
    • {Boolean} extended = false Enable all advanced features from extglob.
    • {String} flags = '' RegExp flags (e.g. 'i' ) to pass to the RegExp constructor.
    • {Boolean} globstar = false If false the pattern 'path/' will match any string beginning with 'path/', for example it will match 'path/file.txt' and 'path/to/file.txt'. If true the same 'path/' will match any string beginning with 'path/' that does not have a '/' to the right of it, for example it will match 'path/file.txt' but not 'path/to/file.txt'. If true the pattern 'path/**' will match any string beginning with 'path/', which is equal to the 'path/*' with globstar set to false.
    • {Boolean} strict = false Be forgiving about multiple slashes, such as /// and make everything after the first / optional. Like how bash glob works.
  • {Object} readOptions = { encoding: 'utf8' } fs.readfile options. Set to false to disable retrieving the file contents.

  • {Object} statOptions = {} fs.stat options Set to false to disable retrieving the file metadata.

  • {Number} logLevel = 2 Log level given to the logger.