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

ls-fs

v1.2.1

Published

Some file utilities

Downloads

4

Readme

ls-fs Build Status Circle CI

File utils

Snuffles

Usage

var lsFs = require('ls-fs');

lsFs.readJson('settings.json').then(function(settings) {
    console.log(settings.prop1);
    console.log(settings.prop2);
});

API

readJson

lsFs.readJson(path, [opts]).then(function(parsedJsonObj) {
    console.log(parsedJsonObj);
});
Arguments
  1. path (String) The path to the JSON file to read

writeJson

lsFs.writeJson(path, obj, [opts]).then(function(pathToJson) {
    
});
Arguments
  1. path (String) The path to the JSON file to write
  2. obj (*) The thing to JSON.stringify

readIni

lsFs.readIni(path, [opts]).then(function(parsedIniObj) {
    console.log(parsedIniObj);
});
Arguments
  1. path (String) The path to the INI file to read
  2. [opts] (Object) Identical to q-io/fs.read options

writeIni

lsFs.writeIni(path, obj, [opts]).then(function(pathToIni) {
    console.log('wrote ' + pathToIni);
});
Arguments
  1. path (String) The path to the INI file to write
  2. obj (*) The thing to stringify into INI format
  3. opts (Object) Merge of options for ini and q-io/fs.write

tmpDir

lsFs.tmpDir([opts]).then(function(pathToTmpDir) {
    // do stuff with my temporary directory
});
Arguments
  1. [opts] (Object) Same as https://github.com/raszi/node-tmp#directory-creation

requireDir

Takes a path to a directory and returns an object containing all the required modules in that directory.

For example, if you have a directory with:

some-module.js
other-module.js
static-content.json

requireDir on that directory would return an object like:

{
  someModule: <module.exports of some-module.js>,
  ...
}
Usage
lsFs.requireDir(pathToDir).then(function(requiredDirObj) {
    // use required modules
});
Arguments
  1. pathToDir (String) Path to the directory you would like to recursively require