MisterCheezeCake / CTAutocomplete

Typescript Definitions for ChatTriggers mod.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

A module that provides IntelliSense for the ChatTriggers API.

Installation

Installation is split into two parts, ASM files, and non-ASM files. In order for the typescript definitions to work, you need an editor that supports typescript. As I personally only use Visual Studio Code I can only confirm that it works for this but it is likely that other editors also have support.

Non-ASM Files

alt

For normal JS files, to get CTAutcomplete is as simple as 2 lines at the top of the file.

/// <reference types="../CTAutocomplete" />
/// <reference lib="es2015" />

The 2 lines are just to load in the CTAutocomplete definitions and then the base js library.

ASM Files

alt

IF YOU DONT KNOW WHAT ASM IS, THEN YOU DONT NEED THIS.

The process for getting IntelliSense in an ASM file is slightly more involved but is still very simple.

/// <reference types="../CTAutocomplete/asm" />
/// <reference lib="es2015" />

/**@param {IASM} ASM */
export default ASM => {}

The first 2 lines should look familiar except the reference to CTAutocomplete/asm to get access to the ASM definitions. The JSDoc signature is required to give typings to the ASM argument.

Metadata.json

alt

CTAutocomplete also comes with a JSON schema for the metadata.json file. To use it, as can be seen in this module's metadata.json, all that is required is a $schema key in the metadata file. that points to the schema.json file. Once you have that in your file you will get autocompletion. alt

Issues

I can 100% personally guarantee there are issues with these typings, it is important to keep in mind this project is still very much a work in progress and there are many things I intend to keep working on. That being said, if you find any issues or have any suggestion I can be reached on discord at maxssho13#5487 or you can open an issue or a PR on the Github page.

About

Typescript Definitions for ChatTriggers mod.