@levimc-lse/scaffold/README.md

A utility for assisting in the development of Legacy Script Engine plugins.

# Legacy Script Engine Scaffold

A utility for assisting in the development of Legacy Script Engine plugins, supporting a native development experience on the Node.js platform.

> Only TypeScript projects are supported at the moment.

## 📦 Prepare

It is a non-intrusive tool, meaning it does not require any mandatory files to be kept in your project. However, it is recommended to add it as a development dependency to your environment for convenient usage:

```bash
npm install @levimc-lse/scaffold --save-dev
```

## 🚀 Usage

Generate manifest.json for the Legacy Script Engine plugin:

```bash
npx lses manifest
```

Package the Legacy Script Engine plugin:

```bash
npx lses pack
```

Deploy the Legacy Script Engine plugin package to the local LeviLamina server:

```bash
npx lses deploy <path>
```

| Argument | Description                                   | Type   |
| -------- | --------------------------------------------- | ------ |
| `<path>` | Specific LeviLamina server working directory. | String |

## ❗ Important

The `main` configuration entry file in package.json should be relative to the project's working directory, <font color="red">not the directory of the Legacy Script Engine plugin package.</font>

For example, in a TypeScript project where index.ts is defined as the entry point in source code and the TypeScript compiler is configured via tsconfig.json to emit to the build directory named dist, you should set the `main` field in package.json to `dist/index.js`. 

This ensures that the `entry` field in the manifest.json generated by `npx lses manifest` can be correctly identified and located by LeviLamina.