@pigeon-posse/pkg-extended-scripts
Version:
Separate scripts from package.json
136 lines (90 loc) • 9.08 kB
Markdown
<!--
██████╗ ██╗ ██████╗ ███████╗ ██████╗ ███╗ ██╗
██╔══██╗██║██╔════╝ ██╔════╝██╔═══██╗████╗ ██║
██████╔╝██║██║ ███╗█████╗ ██║ ██║██╔██╗ ██║
██╔═══╝ ██║██║ ██║██╔══╝ ██║ ██║██║╚██╗██║
██║ ██║╚██████╔╝███████╗╚██████╔╝██║ ╚████║
╚═╝ ╚═╝ ╚═════╝ ╚══════╝ ╚═════╝ ╚═╝ ╚═══╝
██████╗ ██████╗ ███████╗███████╗███████╗
██╔══██╗██╔═══██╗██╔════╝██╔════╝██╔════╝
██████╔╝██║ ██║███████╗███████╗█████╗
██╔═══╝ ██║ ██║╚════██║╚════██║██╔══╝
██║ ╚██████╔╝███████║███████║███████╗
╚═╝ ╚═════╝ ╚══════╝╚══════╝╚══════╝
█████╗█████╗█████╗█████╗█████╗█████╗█████╗█████╗
╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝
██████╗ ██╗ ██╗ ██████╗
██╔══██╗██║ ██╔╝██╔════╝
██████╔╝█████╔╝ ██║ ███╗
██╔═══╝ ██╔═██╗ ██║ ██║
██║ ██║ ██╗╚██████╔╝
╚═╝ ╚═╝ ╚═╝ ╚═════╝
███████╗██╗ ██╗████████╗███████╗███╗ ██╗██████╗ ███████╗██████╗
██╔════╝╚██╗██╔╝╚══██╔══╝██╔════╝████╗ ██║██╔══██╗██╔════╝██╔══██╗
█████╗ ╚███╔╝ ██║ █████╗ ██╔██╗ ██║██║ ██║█████╗ ██║ ██║
██╔══╝ ██╔██╗ ██║ ██╔══╝ ██║╚██╗██║██║ ██║██╔══╝ ██║ ██║
███████╗██╔╝ ██╗ ██║ ███████╗██║ ╚████║██████╔╝███████╗██████╔╝
╚══════╝╚═╝ ╚═╝ ╚═╝ ╚══════╝╚═╝ ╚═══╝╚═════╝ ╚══════╝╚═════╝
███████╗ ██████╗██████╗ ██╗██████╗ ████████╗███████╗
██╔════╝██╔════╝██╔══██╗██║██╔══██╗╚══██╔══╝██╔════╝
███████╗██║ ██████╔╝██║██████╔╝ ██║ ███████╗
╚════██║██║ ██╔══██╗██║██╔═══╝ ██║ ╚════██║
███████║╚██████╗██║ ██║██║██║ ██║ ███████║
╚══════╝ ╚═════╝╚═╝ ╚═╝╚═╝╚═╝ ╚═╝ ╚══════╝
CREATED BY ANGELO
FOR PIGEONPOSSE.COM
-->
# PKG-EXTENDED-SCRIPTS by PIGEONPOSSE™
[](https://npmjs.com/package/@pigeon-posse/pkg-extended-scripts)
[](https://npmjs.com/package/@pigeon-posse/pkg-extended-scripts)
[](https://pigeonposse.com/)
[](https://pigeonposse.com/?popup=about)
[](https://pigeonposse.com/?popup=donate)
## 🗒 Description
**List all your scripts in a separate file to the _package.json_**
Separate the package.json scripts to another file and run them with the ```pes``` or ```pkg-extended-scripts``` **command**
## 🔑 Installation
### Using NPM
```bash
npm install @pigeon-posse/pkg-extended-scripts
```
## ⚙️ Usage
1. create a file named ```pes.config.{js,cjs,mjs,cjs,ts,mts,cts}```.
2. Write your scripts to the file. for example:
```js
/** @type {import('@pigeon-posse/pkg-extended-scripts').Config} */
export default {
"hello" : () => console.log( 'Hello Pigeon 🕊️🌈' ),
}
```
3. Run these scripts using the ```pes``` or ```pkg-extended-scripts``` **commands**
That's it, now you can list all your scripts in a separate file to the package.json
### Optional
If you use the package it may be good practice to leave a scripts in the package.json that indicates that the scripts are in a separate file. For example:
- In ```package.json```
```json
{
"scripts" : {
"ext-scripts": "npx @pigeon-posse/pkg-extended-scripts"
}
}
```
## 👨💻 Development
You can contribute via **_Github_**
[](https://github.com/pigeon-posse/pkg-extended-scripts/issues)
[](https://github.com/pigeon-posse/pkg-extended-scripts/pulls)
## ☕ Donate
Help us to develop more interesting things.
[](https://pigeonposse.com/?popup=donate)
## 📜 License
This software is licensed with MIT License
[](https://github.com/pigeon-posse/pkg-extended-scripts/blob/main/LICENSE)
## 🐦 About us
_PigeonPosse_ is a ✨ **code development collective** ✨ focused on creating practical and interesting tools that help developers and users enjoy a more agile and comfortable experience. Our projects cover various programming sectors and we do not have a thematic limitation in terms of projects.
[](https://github.com/PigeonPosse/PigeonPosse)
### Collaborators
| | Name | Role | GitHub |
| ---------------------------------------------------------------------------------- | ----------- | ------------ | ---------------------------------------------- |
| <img src="https://github.com/AngelEspejo.png?size=72" style="border-radius:100%"/> | AngelEspejo | Author | [@AngelEspejo](https://github.com/AngelEspejo) |
| <img src="https://github.com/PigeonPosse.png?size=72" style="border-radius:100%"/> | PigeonPosse | Collective | [@PigeonPosse](https://github.com/PigeonPosse) |
<br>