Skip to content

Latest commit

 

History

History
44 lines (36 loc) · 1.27 KB

README.md

File metadata and controls

44 lines (36 loc) · 1.27 KB

Installation

Run yarn add -D typescript @tsplus/installer and add tsplus-install in your package.json scripts like:

{
    "scripts": {
        "postinstall": "tsplus-install"
    }
}

Additionally add a config like the following to be specified that tells the compiler how to map source files to traces and imports:

// tsplus.config.json
{
  "importMap": {
    "^(.*)/packages/([^/]*)/src(.*)/index\\.ts$": "@tsplus-test/$2$3",
    "^(.*)/packages/([^/]*)/src(.*)\\.ts$": "@tsplus-test/$2$3"
  },
  "traceMap": {
    "^(.*)/packages/([^/]*)/(.*)$": "(@tsplus-test/$2) $3"
  }
}

and linked to each tsconfig where either a main build happens or any project reference:

// tsconfig.json
{
  "compilerOptions": {
    "tsPlusConfig": "../../tsplus.config.json"
  }
}

Notes:

  • TS+ will add imports in your code and it will use fully qualified imports like @tsplus-tests/package/MyFile
  • It is your job to make sure every file is properly exported in your package.json exports.
  • Each file should correspond to a unique import, to avoid ending up with circular references as much as possible
  • It is advisable to use "typescript.preferences.importModuleSpecifier": "non-relative in vscode settings to ensure the IDE suggests the correct auto imports