# @tsplus/installer

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

Latest version **0.0.188** (published 2025-05-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install @tsplus/installer
pnpm add @tsplus/installer
yarn add @tsplus/installer
bun add @tsplus/installer
```

Provides the command `tsplus-install`.

## Health

**Score 35/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 0.0.188 |
| Published | 2025-05-31 |
| First published | 2022-01-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 4.5 MB |
| Known vulnerabilities | 0 (+12 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 18 |
| Author | Michael Arnaldi |
| Maintainers | michael.arnaldi |

## Links

- npm: https://www.npmjs.com/package/@tsplus/installer
- Repository: https://github.com/ts-plus/installer
- Homepage: https://github.com/ts-plus/installer#readme
- Issues: https://github.com/ts-plus/installer/issues
- npm.io page: https://npm.io/package/@tsplus/installer

## Dependencies (5)

- [tar](https://npm.io/package/tar.md) ^6.1.11
- [zlib](https://npm.io/package/zlib.md) ^1.0.5
- [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.4
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [ts-node](https://npm.io/package/ts-node.md) ^10.4.0

## Recent versions

- 0.0.188 (latest) — 2025-05-31
- 0.0.187 — 2025-03-03
- 0.0.186 — 2024-09-29
- 0.0.185 — 2024-07-13
- 0.0.184 — 2024-07-13
- 0.0.183 — 2024-03-06
- 0.0.182 — 2023-12-03
- 0.0.181 — 2023-10-11
- 0.0.180 — 2023-10-11
- 0.0.179 — 2023-09-15
- 0.0.178 — 2023-07-23
- 0.0.177 — 2023-06-03
- 0.0.176 — 2023-04-23
- 0.0.175 — 2023-04-23
- 0.0.174 — 2023-04-23
- … 171 more at https://npm.io/package/@tsplus/installer/versions

## README

### Installation

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

```json
{
    "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:

```json
// 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:

```json
// 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

---
_Source: https://npm.io/package/@tsplus/installer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._