# @pmnps/tools

> These are tools for developing pmnps and its plugins

Latest version **4.5.1** (published 2026-04-22) · 0 weekly downloads

## Install

```sh
npm install @pmnps/tools
pnpm add @pmnps/tools
yarn add @pmnps/tools
bun add @pmnps/tools
```

## Health

**Score 50/100 (C)** — status: active.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 4.5.1 |
| Published | 2026-04-22 |
| First published | 2022-08-23 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jimmy.Harding |
| Maintainers | sibar-root |
| Keywords | js, monorepo, npm workspaces, pmnps dependency |

## Links

- npm: https://www.npmjs.com/package/@pmnps/tools
- Repository: https://github.com/filefoxper/pmnps-workspace.git#master
- Homepage: https://github.com/filefoxper/pmnps-workspace/tree/master/packages/%40pmnps/tools
- Issues: https://github.com/filefoxper/pmnps-workspace/issues
- npm.io page: https://npm.io/package/@pmnps/tools

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 4.5.1 (latest) — 2026-04-22
- 4.5.0 — 2024-11-26
- 4.4.2 — 2024-09-19
- 4.4.1 — 2024-09-10
- 4.4.0 — 2024-08-18
- 4.3.2 — 2024-08-09
- 4.3.1 — 2024-08-06
- 4.3.0 — 2024-08-05
- 4.2.1 — 2024-07-27
- 4.2.0 — 2024-07-25
- 4.1.1 — 2024-07-13
- 4.1.0 — 2024-07-09
- 4.0.5 — 2024-06-18
- 4.0.3 — 2024-06-14
- 4.0.2 — 2024-06-13
- … 18 more at https://npm.io/package/@pmnps/tools/versions

## README

# @pmnps/tools

This package provides some tools for writing plugins for [pmnps](https://www.npmjs.com/package/pmnps).

## API

### message

You can use this api to log what happens in your plugin.

```typescript
declare type Message = {
  error(message: string): void;
  info(message: string): void;
  log(message: string): void;
  success(message: string): void;
  desc(message: string): void;
  warn(message: string): void;
};

export declare const message: Message;
```

### execution

This API helps to manage the executions.

```typescript
import type execa from 'execa';

export declare const execution: {
  exec(
    file: string,
    params?: string[] | execa.Options,
    options?: execa.Options
  ): execa.ExecaChildProcess;
  command(params: string, options?: execa.Options): execa.ExecaChildProcess;
  execute: typeof execa;
  killChildProcess([pid, process]: [number, execa.ExecaChildProcess]): void;
};
```

### createPluginCommand

This API helps to create a plugin command.

```typescript
declare type PluginSlot = {
  name: string;
  option(
    optionName: string,
    shortcut: string,
    optional?: { description?: string; inputType?: 'string' | 'boolean' }
  ): PluginSlot;
  describe(description: string): PluginSlot;
  require(requireFn: RequireFn): PluginSlot;
  action(action: Action): Command;
};

export declare function createPluginCommand(name: string): PluginSlot;
```

### inquirer

This API helps to create a prompt for the user.

```typescript
import type { Answers, QuestionCollection, ui, Separator } from 'inquirer';

declare function prompt<T extends Answers = Answers>(
  questions: QuestionCollection<T>,
  initialAnswers?: Partial<T>
): Promise<T> & { ui: ui.Prompt<T> };

export declare const inquirer: {
  prompt: typeof prompt;
  Separator: typeof Separator;
};
```

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