# kolmafia-scripts

> `kolmafia-scripts` is designed to make building a KoLmafia script using JavaScript incredibly easy.

Latest version **0.0.4** (published 2021-11-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install kolmafia-scripts
pnpm add kolmafia-scripts
yarn add kolmafia-scripts
bun add kolmafia-scripts
```

Provides the command `kolmafia-scripts`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2021-11-16 |
| First published | 2021-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 15 |
| Unpacked size | 13 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | gausie |

## Links

- npm: https://www.npmjs.com/package/kolmafia-scripts
- npm.io page: https://npm.io/package/kolmafia-scripts

## Dependencies (15)

- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [webpack](https://npm.io/package/webpack.md) ^5.20.1
- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.14.8
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.15.0
- [cross-spawn](https://npm.io/package/cross-spawn.md) ^7.0.3
- [babel-loader](https://npm.io/package/babel-loader.md) ^8.2.2
- [pretty-bytes](https://npm.io/package/pretty-bytes.md) ^5.5.0
- [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.15.0
- [@babel/compat-data](https://npm.io/package/@babel/compat-data.md) ^7.15.0
- [@babel/preset-react](https://npm.io/package/@babel/preset-react.md) ^7.14.5
- [terser-webpack-plugin](https://npm.io/package/terser-webpack-plugin.md) ^5.1.1
- [@babel/preset-typescript](https://npm.io/package/@babel/preset-typescript.md) ^7.12.7
- [@babel/plugin-proposal-decorators](https://npm.io/package/@babel/plugin-proposal-decorators.md) ^7.14.5
- [@babel/plugin-proposal-class-properties](https://npm.io/package/@babel/plugin-proposal-class-properties.md) ^7.14.5
- [@babel/plugin-proposal-object-rest-spread](https://npm.io/package/@babel/plugin-proposal-object-rest-spread.md) ^7.14.7

## Recent versions

- 0.0.4 (latest) — 2021-11-16
- 0.0.3 — 2021-11-16
- 0.0.2 — 2021-07-07
- 0.0.1 — 2021-02-03

## README

# kolmafia-scripts

`kolmafia-scripts` is designed to make building a KoLmafia script using JavaScript incredibly easy.

## Getting started

Just run `yarn add --dev kolmafia-scripts` and then set up your `package.json` like this:

```json
{
    "name": "my-package-name",
    "main": "RELEASE/scripts/my-package-name/my-package-name.js",
    "mainSrc": "src/main.ts",
    "scripts": {
        "build": "kolmafia-scripts build",
        "watch": "kolmafia-scripts watch"
    },
    "devDependencies": {
        "kolmafia-scripts": "^0.0.3",
        "kolmafia": "^1.4.0"
    },
    "peerDependencies": {
        "kolmafia": "^1.4.0"
    }
}
```

|         |                                                               |
|---------|---------------------------------------------------------------|
| main    | should point to where you would like your compiled code to go |
| mainSrc | should point to the entrypoint to your uncompiled code        |

Note: Installing `kolmafia` here (as shown above) is optional but recommended, especially for `TypeScript`.

## Developing

To build your project run `yarn build`. You can also set it to automatically build as you make changes with `yarn watch`.

## TypeScript

If you want to use TypeScript, all you need to do is `yarn add --dev typescript` and then create a `tsconfig.json`. `kolmafia-scripts` ships with a base TypeScript configuration that you can use or extend by writing your `tsconfig.json` like this:

```json
{
    "extends": "kolmafia-scripts/tsconfig.json"
}
```

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