`haetae`

haetae is a battery-included package for Haetae.
It's intended to be used alone. Every @haetae/* packages are already preinstalled in it.
This package is recommended for the majority of users.

💡

Are you developing a library (e.g. plugin) for Haetae?
You can use @haetae/core, @haetae/utils, @haetae/javascript, @haetae/git, @haetae/cli independently, if you depends on just partial features of some of them.

`dependencies`

Unlike other @haetae/* packages, haetae does not have peerDependencies.

Note: This might not be exhaustive and lists only Haetae's packages.

Installation

npm install --save-dev haetae

Usage

The package haetae exports other @haetae/* packages all at once.
It's source code is roughly like the snippet below.

export * as core from '@haetae/core'
export * as utils from '@haetae/utils'
export * as js from '@haetae/javascript'
export * as git from '@haetae/git'
export * as cli from '@haetae/cli'
export const pkg = { ... }

So you probably use haetae on the config file like this.

haetae.config.js

import { core, utils, js, git, cli, pkg } from 'haetae'
 
export default core.configure({
  // Other options are omitted for brevity.
  commands: {
    // ...
  },
})

CLI

haetae is CLI as well as API.
haetae provides exactly same CLI features as @haetae/cli.

For detailed usage and description as CLI, refer to CLI.

API

`pkg`

Refer to introduction#pkg.

`$Exec`

This is identical to utils.$Exec.

`$`

This is identical to utils.$.

`cli`

The exported cli is API of @haetae/cli.
You probably don't need it.
Because, in general, the CLI features are used as CLI, not as API.
If you really need the API, refer to @haetae/cli.

Introduction @haetae/core