# list-projects

> Given a root path, recursively searches subdirectories and lists basic information about node projects

Latest version **1.0.1** (published 2019-11-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install list-projects
pnpm add list-projects
yarn add list-projects
bun add list-projects
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-11-03 |
| First published | 2019-11-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | TalinMatteson |
| Maintainers | talmat |

## Links

- npm: https://www.npmjs.com/package/list-projects
- Repository: https://github.com/TalMat/list-projects
- Homepage: https://github.com/TalMat/list-projects#readme
- Issues: https://github.com/TalMat/list-projects/issues
- npm.io page: https://npm.io/package/list-projects

## Dependencies (1)

- [slash](https://npm.io/package/slash.md) ^3.0.0

## Recent versions

- 1.0.1 (latest) — 2019-11-03
- 1.0.0 — 2019-11-03

## README

# list-projects

**Given a root path, recursively searches subdirectories and lists basic information about node projects**

```
npm install list-projects
```

The only function is `listProjects` which returns an array of `Project` objects. 
```ts
interface {
    path: string;
    packageName: string;
    dirName: string;
    gitDirName?: string;
}
```
If the project is contained in a folder containing a `.git` directory (a git repo) then the name of the repo directory will be included.

TypeScript:
```ts
import { listProjects, Project } from 'list-projects';

const projects: Project[] = listProjects('(some directory to recursively search for node projects)');
```

JavaScript:
```js
const { listProjects } = require('list-projects');
const projects = listProjects('(some directory to recursively search for node projects)');
```

I'm open to extending this to return other information about the directory, adding flags/options, etc.

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