Skitscript Parser (NodeJS)     

A Skitscript document parser targeting NodeJS.

Installation

$3

This is a NPM package. It targets NodeJS 20.14.0 or newer on the following
operating systems:

- Ubuntu 22.04
- Ubuntu 20.04
- macOS 13 (Ventura)
- macOS 12 (Monterey)
- macOS 11 (Big Sur)
- Windows Server 2022
- Windows Server 2019

It is likely also possible to use this package as part of a web browser
application through tools such as webpack. This has
not been tested, however.

$3

If your application uses this as a runtime dependency, install it like any other
NPM package:

``bash
npm install --save @skitscript/parser-nodejs
`

$3

If this is used when building your application and not at runtime, install it as
a development dependency:

`bash
npm install --save-dev @skitscript/parser-nodejs
`

Usage

$3

Import the identifierIsValid function, and provide it with a string containing
a possible identifier:

`typescript
import { identifierIsValid } from "@skitscript/parser-nodejs";

console.log(identifierIsValid(Example Identifier));
console.log(identifierIsValid(???));
`

`
true
false
`

$3

Import the parse function, and provide it with a string containing your
document's content:

`typescript
import { parse } from "@skitscript/parser-nodejs";

const parsed = parse(documentContentString);

console.log(parsed);
`

`json
{
"type": "valid",
"instructions": [
...
],
"warnings": [
...
],
"identifierInstances": [
...
]
}
`

`json
{
"type": "invalid",
"errors": [
...
],
"warnings": [
...
],
"identifierInstances": [
...
]
}
`

$3

A comprehensive library of types representing the results of attempting to parse
documents can be imported:

`typescript
import { Document } from "@skitscript/parser-nodejs";
``

#### Documents

- Document
- InvalidDocument
- ValidDocument

#### Instructions

- ClearInstruction
- EmoteInstruction
- EntryAnimationInstruction
- ExitAnimationInstruction
- Instruction
- JumpInstruction
- LabelInstruction
- LineInstruction
- LocationInstruction
- MenuOptionInstruction
- SetInstruction
- SpeakerInstruction

##### Formatting

- Formatted
- Run

##### Conditions

- Condition
- EveryFlagClearCondition
- EveryFlagSetCondition
- FlagClearCondition
- FlagSetCondition
- SomeFlagsClearCondition
- SomeFlagsSetCondition

#### Identifiers

- Identifier
- IdentifierContext
- IdentifierInstance
- IdentifierReference
- IdentifierType

#### Warnings

- DuplicateIdentifierInListWarning
- EmptyLabelWarning
- FlagNeverReferencedWarning
- FlagNeverSetWarning
- InconsistentIdentifierWarning
- UnreachableWarning
- UnreferencedLabelWarning
- Warning

#### Errors

- DuplicateLabelError
- Error
- IncompleteEscapeSequenceError
- InvalidEscapeSequenceError
- UndefinedLabelError
- UnparsableError
- UnterminatedBoldError
- UnterminatedCodeError
- UnterminatedItalicError