Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/henrycunh/haxx
⚡️ Makes writing scripts absurdly easy
https://github.com/henrycunh/haxx
fetch io javascript json scripts typescript yaml zx
Last synced: about 2 months ago
JSON representation
⚡️ Makes writing scripts absurdly easy
- Host: GitHub
- URL: https://github.com/henrycunh/haxx
- Owner: henrycunh
- Created: 2022-02-22T15:32:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-22T04:13:39.000Z (over 1 year ago)
- Last Synced: 2024-10-07T10:28:26.381Z (3 months ago)
- Topics: fetch, io, javascript, json, scripts, typescript, yaml, zx
- Language: TypeScript
- Homepage:
- Size: 212 KB
- Stars: 15
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# haxx
easily create and run scripts using javascript
![]()
getting started • commands • api
![]()
## Features
- 🔀 **Process DX** - easily manage and run processes
- 📦 **Javascript ESM** - makes writing scripts easier, through javascript
- 🔌 **Great IO** - provides easy to use IO functions, for known formats
- 🧑💻 **Opinionated** - it's a great tool for writing tools, with tools inside
## Getting started
It's as simple as creating a script file with a `.mjs` extension
```js
#!/usr/bin/env haxx
const lastTag = await $`git tag | tail -n 1`
const tagMessage = String(await $`git tag -l -n9 ${lastTag}`)
.match(/\s{2,}(.+)/)[1]
console.log(`Last tag message: ${tagMessage}`)
```
And running it
```bash
haxx my-script.mjs
```
## Installation
You can either install it globally
```bash
npm i -g haxx
haxx my-script.mjs
```
Or run it through `npx` or any other package manager execute
```bash
npx -y haxx my-script.mjs
```
## API
### `$`
**Executes a given command and returns a promise of the output.**
Everything passed through `${...}` will be automatically escaped and quoted.
```js
const dirToRemove = 'my nice dir'
await $`rm -rf ${dirToRemove}` // rm -rf 'my nice dir'
```
You can pass arrays as arguments
```js
const dirs = ['dir1', 'dir2']
await $`ls ${dirs}` // ls dir1 dir2
```
You can catch process exit codes upon a failing
```js
try {
await $`exit 1`
} catch (process) {
console.log(`Exit code: ${process.exitCode}`)
console.log(`Error: ${process.stderr}`)
}
```
You can pipe directly from the promise to any other stream
```js
$`watch -n1 ls`.pipe(process.stdout)
```
### `read`
Lets you read files easily, and specify formats
```js
const content = await read`my-file.txt`
const package = await read.json`package.json`
console.log(package.version)
const deployment = await read.yaml`deployment.yaml`
console.log(deployment.metadata.name)
```
### `write`
Lets you write files easily, and specify formats
```js
await write('my-file', 'Hello world')
// Hello World
await write.json('object.json', { hello: 'world' })
// { "hello": "world" }
await write.yaml('object.yaml', { hello: 'world' })
// hello: world
```
### `io`
Gives you a nice interface for reading and saving files
```js
const { data: pkg, save } = await io.json`package.json`
pkg.version = '1.0.1'
await save()
const { data: deployment, save: saveDeployment } = await io.yaml`deployment.yaml`
deployment.spec.template.spec.containers[0].image = 'my-new-image'
await saveDeployment()
```
### `exists`
Checks if a file or directory exists
```js
if (!exists('key')) {
await write('key', Math.random().toString().slice(2))
}
```
### `remove`
Removes a file or directory
```js
remove('my-file')
```
### `cd`
Changes the directory
```js
await $`ls`
cd('another-directory')
await $`ls`
```
### `template`
Lets you replace variables in a template
```js
const phrase = template({ name: 'world'}, 'Hello {{ name }}')
const filled = template.file({ GITHUB_TOKEN: '...' }, 'my-template')
```
### Included batteries
- `kleur` - a nice color library
- `kleur-template` - easier coloring through templating
- `glob` - utility for globbing files
- `yaml` - a yaml parser
- `os` - the os package
- `path` - the path package
- `minimist` - your arguments parsed, availabe through the global constant `argv`
## Acknowledgements
This project is **heavily** inspired by [**zx**](https://github.com/google/zx) and [**fsxx**](https://github.com/antfu/fsxx), down to the code.
Check them out!