# makefile-help

> An easy way to add a `make help` target to your Makefiles.

Latest version **0.0.2** (published 2017-04-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install makefile-help
pnpm add makefile-help
yarn add makefile-help
bun add makefile-help
```

## 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 | 2017-04-12 |
| First published | 2017-04-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 25 |
| Maintainers | ianstormtaylor |
| Keywords | cli, help, make, makefile, scripts |

## Links

- npm: https://www.npmjs.com/package/makefile-help
- Repository: https://github.com/ianstormtaylor/makefile-help
- Homepage: https://github.com/ianstormtaylor/makefile-help#readme
- Issues: https://github.com/ianstormtaylor/makefile-help/issues
- npm.io page: https://npm.io/package/makefile-help

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2017-04-12
- 0.0.1 — 2017-04-12

## README

# makefile-help

An easy way to add an auto-generated `make help` target to your Node.js project's `Makefile`.

This makes `make` command discovery nicer, while still using the same `make` tool that's available in pretty much every dev environment. If you're looking for something a bit more powerful, but at the expense of installing something new, check out [`tj/mmake`](https://github.com/tj/mmake)!

---

### Example

For a makefile like...

```make
ifneq ($(wildcard ./node_modules),)
  include ./node_modules/makefile-help/Makefile
endif

# Run commands with the node debugger. (default: false)
DEBUG ?= false

ifeq ($(DEBUG),false)
  node = node
else
  node = node debug
endif

# Remove all of the derived files.
clean: 
  @ rm -rf ./node_modules ./lib

# Compile the source with babel.
lib: 
  @ ./node_modules/.bin/babel-cli --out-dir ./lib ./src

# Start the development server.
start:
  @ $(node) ./server/index.js
```

Running `make help` will print out...

```bash
$ make help

  Usage:

    make <target> [flags...]

  Targets:

    clean   Remove all of the derived files.
    help    Show this help prompt.
    lib     Compile the source with babel.
    start   Start the development server.

  Flags:

    DEBUG    Run commands with the node debugger. (default: false)

```

---

### Installation

```bash
yarn add makefile-help
```

```bash
npm install --save makefile-help
```

---

### Usage

To use it, `include` this module's `Makefile` in your own...

```make
ifneq ($(wildcard ./node_modules),)
  include ./node_modules/makefile-help/Makefile
endif
```

And then run...

```bash
$ make help
```

The help command will auto-populate from targets that look like:

```make
# This comment will show up for the target in the help.
target:
```

And also for flag definitions like:

```make
# This comment will show up for the flag in the help.
FLAG ?=
```

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