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

fs-explorer

v1.4.2

Published

Explore file system

Downloads

21

Readme

fs-explorer

Explore a file or a directory

/**
 * Explore a file or a directory. i.e. stats
 * Usage
 *     explore(String start, Function callfile)
 *     explore(String start, Function callfile, Function done)
 *     explore(String start, Function callfile, Object options)
 *     explore(String start, Function callfile, Function calldir, Function done)
 *     explore(String start, Function callfile, Function calldir, Object options)
 *     explore(String start, Function callfile, Object options, Function done)
 *     explore(String start, Function callfile, Function calldir, Object options, Function done)
 *
 * Calling next with err cancels the reading
 * Not calling next will make the process hang forever
 * If you want fast reading, call next before processing the file or folder
 * If you want listing control, call next after you processed the file or folder
 * @param  {String}     start    File or folder to read
 * @param  {Function}   callfile called every time a file is encountered with (path, stats, next)
 * @param  {Function}   calldir  called every time a folder is encountered with (path, stats, files, 'begin|end', next). To skip folder, call next(null, true) on begin
 * @param  {Object}     options
 *                         resolve[=true]           returns information about the path symbolic links resolves to.
 *                         followSymlink[=false]    explore the symlink if it resolves to a directory. implies resolve
 *                         limit[=1]                explore multiple paths at time, thus reducing exploration time
 *                         fs[=require("fs")]       filesystem to explore
 *                         path[=require("path")]   filesystem path. Usually one of {posix, win32} = require("path")
 * @param  {Function}   done     called when there are no more file nor folders to read
 */
const {explore} = require('fs-explorer');
explore('/path/to/dir', (path, stats, next) => {
    console.log('file', path);
    next();
}, (path, stats, files, state, next) => {
    if (state === 'end') {
        console.log('directory', path);
    }
    next();
}, {followSymlink: true}, (err) => {
    console.log('done', err);
});

Example of remote exploration using ssh

const {posix: remoteSysPath} = require("path");
const {Client} = require("ssh2");

const client = new Client();

client.on("ready", () => {
    console.log("Client :: ready");

    client.sftp((err, sftp) => {
        if (err) {
            throw err;
        }

        const remoteDir = ".";
        const remoteBaseIndex = remoteDir === "." ? 0 : remoteDir.length + 1;

        explore(remoteDir, (path, stats, next) => {
            console.log("file     ", path);
            next();
        }, (path, stats, files, state, next) => {
            if (state === "end") {
                console.log("directory", path);
            } else {
                const baseDir = path.slice(remoteBaseIndex);

                // do not explore hidden directories
                if (baseDir[0] === "." && baseDir !== ".") {
                    next(null, true);
                    return;
                }

                // limit max exploring depth
                const depth = baseDir.length === 0 ? 0 : baseDir.split(remoteSysPath.sep).length;
                if (depth >= 2) {
                    next(null, true);
                    return;
                }

                // sftp.readdir return a list of objects instead of a list of string as expected by fs-explorer
                // transform the list of object files into a list of string
                files.forEach((file, i) => {
                    if (file !== null && typeof file === "object" && typeof file.filename === "string") {
                        files[i] = file.filename;
                    }
                });
            }
            next();
        }, {
            fs: sftp,
            path: remoteSysPath,
            limit: 32
        }, err => {
            if (err) {
                throw err;
            }
            client.end();
            console.log("done");
        });
    });
});

client.connect({
    host: process.env.SSH_HOST || "127.0.0.1",
    port: process.env.SSH_PORT ? parseInt(process.env.SSH_PORT, 10) : 22,
    username: process.env.SSH_USERNAME || "anonymous",
    agent: process.env.SSH_AUTH_SOCK || (process.platform === "win32" ? "pageant" : undefined),
});

License

The MIT License (MIT)

Copyright (c) 2014-2017 Stéphane MBAPE (http://smbape.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.