# sol-digger

> Recursively traverse a directory to extract all Solidity files

Latest version **0.0.2** (published 2016-08-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install sol-digger
pnpm add sol-digger
yarn add sol-digger
bun add sol-digger
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2016-08-10 |
| First published | 2016-08-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Raghav Dua |
| Maintainers | the-mad-king |
| Keywords | Traversal, Solidity |

## Links

- npm: https://www.npmjs.com/package/sol-digger
- Repository: https://github.com/duaraghav8/sol-digger
- Homepage: https://github.com/duaraghav8/sol-digger#readme
- Issues: https://github.com/duaraghav8/sol-digger/issues
- npm.io page: https://npm.io/package/sol-digger

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2016-08-10
- 0.0.1 — 2016-08-08
- 0.0.0 — 2016-08-08

## README

# sol-digger
Recursively traverse a directory to extract all Solidity files

#Install
```
npm install sol-digger
```

#API
```js
let digger = require ('sol-digger');
```
```digger``` is a function that takes 2 arguments: First is ```directory``` - the starting point for recursive search of solidity files and second is ```ignores``` - an array of names to ignore while treversing. These names could be either file names or sub-directory names.

If you wish to pass only a single file or directory to ignore, you can simply pass in a string instead of array to ```digger ()```.


#Usage
```js
'use strict';

let digger = require ('sol-digger');

digger ('/relative/or/absolute/path', ['node_modules', 'contracts'])
	.forEach ( (filename) => {
		console.log (filename);
	});

digger ('./foo', 'bar').forEach ( (filename) => {
	console.log (filename);
});
```

---
_Source: https://npm.io/package/sol-digger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
