TypeScript-TmLanguage/README.md

TypeScript-TmLanguage

This repository contains TmLanguage files that are consumed by TypeScript editors and plugins such as Visual Studio Code, The TypeScript Sublime Plugin, Atom TypeScript, and possibly others.

Latest version of the grammar can be also found as a VSCode extension.

Contributing

The XML files are generated from the YAML files, so contributors should hand-modify the YAML files, and XML files should only be generated by running build script.

Build

Update the XML files from within the build folder

cd build
npm install         # Installs dependencies required for building
npm start           # Compiles & builds the XML files

Tests

Test are run from within the tests folder and depend on build to make sure XML files are upto date

cd build
npm install         # Installs dependencies required for building

cd ../tests
npm install         # Installs dependencies required for testing
npm test            # Compiles & runs tests

npm run diff        # Diffs the test baselines with generated one using tool set in environment variable DIFF
npm run accept      # Accepts the test baselines