shelljs/shelljs

find() should work like find(1)

Open

#114 opened on Apr 4, 2014

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (14,062 stars) (777 forks)batch import
bash compatfixhelp wantedlow priority

Description

I expected the following to work... but took a look at the docs and require('shelljs').find quite a bit different than I expected.

Here is what I'm trying to do:

// find all directories in the cwd that have a package.json
var sh = require('shelljs');
var packages = sh.find('*/package.json').map((f) => {
 return path.dirname(f)
});

This is obviously not possible with sh.find. You have to do something like

sh.find('.').filter((p) => {
  return path.dirname(p) === cwd
      && path.filename(p) === 'package.json'
});

Would be nice if it supported the same functionality as find(1).

Contributor guide

Tech stack
javascriptnodejsshell
Domain
clideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Node.jsfamiliarity with shelljsunderstanding of file paths
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Look at the current implementation of find() in shelljs (likely in src/find.js). Currently, find() recursively lists all files and directories. To support pattern matching like find(1), you would need to accept a pattern string and filter results accordingly. Consider using the path module or a glob library like minimatch. Check how shelljs handles patterns in other commands like ls() or test() for consistency.