MiniScript.TS

A MiniScript implementation written in TypeScript.

At the moment this project is not published in a CDN for browser consumption. In case you want to run it on the browser you will have to build it locally. See section below.

Features

* Runs both on the browser and Node.js
* Fully passes the "TestSuite.txt" from the official C# implementation
* Performance similar to Mini Micro on the desktop
* Extensible via custom intrinsic functions
* Easy integration with JavaScript, as it uses native JS data-types (except for "map")
* Usable in TypeScript projects (type definitions provided)

Install NPM package

To use in a Node.js project, you should install it as a dependency like this:

``npm add miniscript-ts`

Page for the NPM package is here: https://www.npmjs.com/package/miniscript-ts

`Building`

If you want to build locally you need to have Node.js installed in order to build the project. Version 19 or greater is recommended.

Start by installing all needed packages:

`npm install`

Then build with:

`npm run build`

This will create a dist folder with the following files:

* miniscript-ts.mjs: ECMAScript module for Node.js *miniscript-ts.js: IIFE file for the browser *miniscript-ts.d.ts: TypeScript types *miniscript-ts.cjs: CommonJS module, should you need it * Map-files for each module type

`Usage on the browser`

Consult the examples/browser folder.

Note that you will need to build locally for the examples to work.

You will also need a local file-server if you want to open the examples on the browser.

`Usage on Node.js`

Consult the examples/nodejs folder.

Note that you will need to build locally for the examples to work.

`Testing`

The test suites can be run from the command line with:

`npm run test`

Alternatively you can open a browser-based UI with:

`npm run test-ui``

Acknowledgements

Many thanks to the amazing MiniScript community at Discord, for their encouragement during the development of this project.

Special thanks go to Joe Strout, author and creator of the MiniScript language and the Mini Micro programming environment. Without his generous help this project would not have been possible.

Features

Building

If you want to build locally you need to have Node.js installed in order to build the project. Version 19 or greater is recommended.

Start by installing all needed packages:


npm install

Then build with:


npm run build

This will create a dist folder with the following files:

* miniscript-ts.mjs

: ECMAScript module for Node.js
*

miniscript-ts.js

: IIFE file for the browser
*

miniscript-ts.d.ts

: TypeScript types
*

miniscript-ts.cjs

: CommonJS module, should you need it
* Map-files for each module type

Acknowledgements

Many thanks to the amazing MiniScript community at Discord, for their encouragement during the development of this project.

Special thanks go to Joe Strout, author and creator of the MiniScript language and the Mini Micro programming environment. Without his generous help this project would not have been possible.