Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 2.22 KB

README.md

File metadata and controls

68 lines (47 loc) · 2.22 KB
Raw

TypeScript Large Language Model Templates (TS-LLMT)

This repository holds experimental code aimed at providing native TypeScript support for Large Language Model Templates. The key idea being explored is that templates have a type that corresponds to the names of the variables within the template.

Environment

To set up your environment for development, first run npm clean-install to download dependencies.

Testing

To run unit tests:

  • npm run test:ci - Run tests once, with extra long timeout.
  • npm run test:dev - Run tests continuously, rerunning on code change.
  • npm run test:trace - Run tests once, with --trace-warnings and verbose.

Running npm test will invoke test:dev.

Linting

This project uses ESLint to enforce code style. To run:

npm run lint

If there are no lint errors, the command will produce no output.

NOTE: If you're using Visual Stuido Code with the official Microsoft ESLint extension, you'll have to switch to the Pre-Release version for it to be able to find and use the eslint.config.mjs file.

Checking Code Style

This project defines and checks code style with Prettier. Invoke Prettier from the command line via the following:

  • npm run prettier:check - Check _.js and _.ts files for style conformance.
  • npm run prettier:write - Overwrite files with Prettier applied style.

NOTE: If you're using Visual Studio Code, the Prettier extension will apply code style on save.

Checking Licenses

Source code for this library is released under the Apache 2.0 license. Each source code file MUST include an SPDX license header like this:

/**
 * @license SPDX-License-Identifier: Apache-2.0
 */

To check whether all source files have such a header, run npm run check-licenses. The output will tell you if there are any files missing the header.

The full text of the Apache-2.0 license is available in the accompanying LICENSE file.