@knot/compiler

A command-line wrapper for the knot compiler. The version of this package aligns with the version of the compiler binary that is downloaded. Exports the path to the downloaded knotc binary. Currently the compiler only supports Windows and MacOS.

The Knot Language compiler can be run as both:

• a stand-alone static compiler that scans a project directory structure and outputs
• a server which can dynamically re-compile modules within a project, but depends on a client to control it

To get started using it in a project you will probably want to use one of the provided bundler plugins:

• @knot/webpack-plugin: The official knot plugin for webpack
• @knot/rollup-plugin: The official knot plugin for rollup
• @knot/browserify-plugin: The official knot plugin for browserify

Or you can use the knot CLI tool (@knot/cli) to generate a new project with the minimum required boilerplate.

The source code for the compiler that is wrapped by this package can be found here;

Table of Contents

• Install
• Usage
• Maintainers
• Contributing
• License

Install

npm install @knot/compiler
# or
yarn add @knot/compiler

Usage

Node.js Usage

path: string

The path to the installed binary.

import { path } from '@knot/compiler';

path; // path to the knotc binary

isKnot: (fileName: string) => boolean

Test whether a file has the file extension .kn or .knot.

import { isKnot } from '@knot/compiler';

isKnot('someFile.js'); // false
isKnot('knotFile.kn'); // true
isKnot('otherFile.knot'); // true

Compiler: class KnotCompiler

A client for connecting to and managing an instance of the knot compiler.

import Compiler from '@knot/compiler';

const compiler = new Compiler({});

// add a file to the compiler
await compiler.add('./someFile.kn');

// wait for the file to be compiled
await compiler.awaitModule('./someFile.kn');

// receive the comiled file contents
const compiled = await compiler.generate('./someFile.kn');

// kill the compiler server and end the connection
await compiler.close();

CLI Usage

If you install the package globally, you should be able to invoke the knotc binary installed by this package. If you install it locally, you can invoke it from a script in your package.json file, by running yarn exec <cmd> or in a variety of other ways.

knotc -help
# or
yarn exec knotc -- -help

CLI Arguments

• -server: run the compiler in server mode
• -config: specify a path to the directory containing the .knot.yml file to load
• -port: specify a port for the compiler to run on, by default it runs on :1338
• -debug: print verbose logs
• -help: print usage information

Maintainers

@effervescentia

Contributing

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © 2019 Ben Teichman