Dreck TypeScript Plugin

Compiles specified TypeScript files to a single Javascript file.

Dependencies

• NodeJS 10.19.0 or later.
• NPM 6.14.4 or later.
• NPX 6.14.4 or later.

All must be available on the PATH (e.g. node --version, npm --version and npx --version all print version strings when executed in a Bash terminal).

Installing on Debian-based Linux distributions

These are available from most Debian-based Linux distributions' package managers; for example, they can be installed when running Ubuntu 20.04 LTS using the following command:

sudo apt-get install nodejs npm --yes

Installing within GitHub Actions

Add an appropriate actions/setup-node action step before the make action step:

name: Continuous Integration
on: [push, pull_request]
jobs:
  main:
    runs-on: ubuntu-20.04
    steps:
    - uses: actions/checkout@v3
      with:
        submodules: true

    # Insert this block:
    ###############################
    - uses: actions/setup-node@v3
      with:
        node-version: 12
    ###############################

    - run: make --file ./submodules/dreck/makefile
      shell: bash
    - if: github.event_name == 'release' && github.event.action == 'created'
      uses: softprops/action-gh-release@v1
      with:
        files: dist/**

Installation

Run the following in a Bash shell at the root of your project:

git submodule add https://github.com/sunruse/dreck-type-script-plugin plugins/type-script

On the next build, a tsconfig.json file will be created in the root of your repository. You should commit this and may customize it to your project's requirements.

Input

This plugin includes every TypeScript file in the DRECK_TYPE_SCRIPT_INPUT_TYPE_SCRIPT_PATHS Make variable as an input TypeScript file.

Output

This plugin writes a single Javascript file to ./plugins/type-script/generated/index.js by default; this path is also appended to the DRECK_TYPE_SCRIPT_OUTPUT_JAVASCRIPT_PATHS Make variable.