-
Notifications
You must be signed in to change notification settings - Fork 83
Add CLAUDE.md with project overview and dev commands #97
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
f5137c2
71d3978
2b87ed7
078af38
c95034a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,21 @@ | ||||||||||
| name: CI | ||||||||||
|
|
||||||||||
| on: | ||||||||||
| push: | ||||||||||
| branches: [master] | ||||||||||
| pull_request: | ||||||||||
| branches: [master] | ||||||||||
|
|
||||||||||
| jobs: | ||||||||||
| test: | ||||||||||
| runs-on: ubuntu-latest | ||||||||||
|
||||||||||
| runs-on: ubuntu-latest | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read |
Copilot
AI
Feb 7, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Node.js version matrix starts at 8, but package.json declares engines.node ">=6.0.0" (and the existing .travis.yml tests 6/7). Either expand CI to cover the minimum supported versions or update the documented/declared engine range so support expectations match what CI actually validates.
| node-version: [8, 10, 12, 14, 16, 18, 20, 22] | |
| node-version: [6, 7, 8, 10, 12, 14, 16, 18, 20, 22] |
Copilot
AI
Feb 7, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The workflow runs npm install even though a package-lock.json is checked in. For CI reproducibility and to ensure lockfile fidelity, prefer npm ci (and optionally add npm caching via setup-node).
| - run: npm install | |
| cache: 'npm' | |
| - run: npm ci |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # CLAUDE.md | ||
|
|
||
| ## Project overview | ||
|
|
||
| recursive-readdir is a Node.js utility that recursively lists all files in a directory and its subdirectories. It supports filtering via glob patterns (minimatch) and custom functions, with both callback and Promise APIs. | ||
|
|
||
| - **Language:** JavaScript (CommonJS, Node.js >=6.0.0) | ||
| - **Single source file:** `index.js` | ||
| - **Production dependency:** `minimatch` | ||
|
|
||
| ## Commands | ||
|
|
||
| ```bash | ||
| # Install dependencies | ||
| npm install | ||
|
|
||
| # Run tests | ||
| npm test | ||
| ``` | ||
|
|
||
| There is no build step, linter, or formatter configured. | ||
|
|
||
| ## Architecture | ||
|
|
||
| - `index.js` — entire library source (~96 lines). Exports a single function `readdir(path, [ignores], [callback])`. | ||
| - `test/recursive-readdir-test.js` — Mocha test suite with fixtures in `test/testdir/`, `test/testdirBeta/`, and `test/testsymlinks/`. | ||
|
|
||
| ## Testing | ||
|
|
||
| Tests use Mocha with Node's built-in `assert` module. Test fixtures are checked-in directories under `test/`. Always run `npm test` to verify changes. |
Uh oh!
There was an error while loading. Please reload this page.