# pylp

> A streamlined task runner designed for simplicity

Latest version **1.0.2** (published 2023-10-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install pylp
pnpm add pylp
yarn add pylp
bun add pylp
```

Provides the command `pylp`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2023-10-04 |
| First published | 2023-10-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Petko Petkov |
| Maintainers | ppetkov |
| Keywords | task-runner, pylp, build, workflow |

## Links

- npm: https://www.npmjs.com/package/pylp
- Repository: https://github.com/ppetkov89/pylp
- Homepage: https://github.com/ppetkov89/pylp#readme
- Issues: https://github.com/ppetkov89/pylp/issues
- npm.io page: https://npm.io/package/pylp

## Dependencies (4)

- [yargs](https://npm.io/package/yargs.md) ^17.7.2
- [winston](https://npm.io/package/winston.md) ^3.10.0
- [vinyl-fs](https://npm.io/package/vinyl-fs.md) ^4.0.0
- [undertaker](https://npm.io/package/undertaker.md) ^1.3.0

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2023-10-04
- 1.0.1 — 2023-10-04
- 1.0.0 — 2023-10-04

## README

# Pylp

A streamlined task runner designed for simplicity.

Compatible with all gulp plugins.

## Installation

```
npm install pylp
```

## Usage

Create a `pylp.js` in the root of your project:

```javascript
const { task, src, dest } = require('pylp');

task('copy-html', function () {
  return src('./src/*.html').pipe(dest('./dist'));
});
```
Run your task using:
```
pylp copy-html
```

For custom configurations, use the --config or -c flag:
```
pylp copy-html --config path/to/customConfig.js
```

## Features

- Flexible task definitions
- Stream-based builds with Vinyl-FS
- Enhanced logging with Winston

## API

`task([taskName,] fn)`

Both a getter and setter for tasks. Read more [here](https://github.com/gulpjs/undertaker#tasktaskname-fn)

`series(taskName || fn...)`

Takes a variable amount of strings (taskName) and/or functions (fn) and returns a function of the composed tasks or functions. Read more [here](https://github.com/gulpjs/undertaker#seriestaskname--fn)

`parallel(taskName || fn...)`

Takes a variable amount of strings (taskName) and/or functions (fn) and returns a function of the composed tasks or functions. Read more [here](https://github.com/gulpjs/undertaker#paralleltaskname--fn)

`src(globs[, options])`

Takes a glob string or an array of glob strings as the first argument and an options object as the second. Returns a stream of vinyl File objects. Read more [here](https://github.com/gulpjs/vinyl-fs#srcglobs-options).

`dest(folder[, options])`

Takes a folder path string or a function as the first argument and an options object as the second. Read more [here](https://github.com/gulpjs/vinyl-fs).

## License
MIT

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