npmpackage.info

Gathering detailed insights and metrics for tsc-alias

Other packages similar to tsc-alias

rollup-plugin-tsc-alias

1.1.2

Replace alias paths with relative paths after typescript compilation during rollup bundling (tsc-alias)

vue-tsc

2.1.10

tsc-watch

6.2.1

The TypeScript compiler with onSuccess command

esbuild-node-tsc

2.0.5

Build your Typescript Node.js projects using blazing fast esbuild

Gathering detailed insights and metrics for tsc-alias

tsc-alias

Replace alias paths with relative paths after typescript compilation

1.8.10

910

MIT

TypeScript

44.83 kB

54,126,785 3.2

Installations

npm install tsc-alias

Pull Requests

Open

1

Total

90

Closed

11

Merged

78

Issues

Open

26

Total

125

Closed

99

Releases

v1.8.10 (2024-05-13)

v1.8.10

Published on 13 May 2024

v1.8.9 (2024-05-09)

v1.8.9

Published on 09 May 2024

v1.8.8 (2023-09-20)

v1.8.8

Published on 20 Sept 2023

v1.8.7 (2023-07-03)

v1.8.7

Published on 03 Jul 2023

v1.8.6 (2023-04-27)

v1.8.6

Published on 27 Apr 2023

v1.8.5 (2023-03-29)

v1.8.5

Published on 29 Mar 2023

View all 52 releases

Developer

justkey007

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

21.6.2

NPM Version

10.2.4 Statistics

910 Stars

231 Commits

62 Forks

5 Watching

3 Branches

31 Contributors

Updated on 19 Nov 2024

Bundle Size

142.28 kB

Minified

44.83 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (96.16%)

JavaScript (3.69%)

Shell (0.14%)

Total Downloads

Cumulative downloads

Total Downloads

54,126,785

Last day

3.3%

133,552

Compared to previous day

Last week

4.1%

708,718

Compared to previous week

Last month

11.6%

2,906,683

Compared to previous month

Last year

83.1%

26,763,241

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

chokidar commander globby mylas normalize-path plimit-lit

Dev Dependencies

@types/jest @types/node @types/rimraf @types/shelljs husky jest prettier rimraf shelljs ts-jest typescript

Versions

tsc-alias

Replace alias paths with relative paths after typescript compilation. You can add aliases that reference other projects outside your tsconfig.json project by providing a relative path to the baseUrl.

Comparison to tsconfig-paths

+ Compile time (no runtime dependencies)

Getting Started

First, install tsc-alias as devDependency using npm.

1npm install -g tsc-alias

npm install --save-dev tsc-alias

Add it to your build scripts in package.json

1"scripts": {
2  "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
3}
4
5================ OR ===================
6
7"scripts": {
8  "build": "tsc && tsc-alias",
9  "build:watch": "tsc && (concurrently \"tsc -w\" \"tsc-alias -w\")"
10}

Issues

If you have an issue, please create one. But, before:

try to check the FAQ.
try to check if there exits alike issues.
try to run with --debug and check if config is correctly loaded and all sourcefiles are found.

API

Installation

1npm install tsc-alias

Usage

1import { replaceTscAliasPaths } from 'tsc-alias';
2
3replaceTscAliasPaths(options?);

Here are all the available options:

Option	Description	Default Value
project, p	path to tsconfig.json	`'tsconfig.json'`
watch	Observe file changes	`false`
outDir	Run in a folder leaving the "outDir" of the tsconfig.json (relative path to tsconfig)	`tsconfig.compilerOptions.outDir`
declarationDir	Works the same as outDir but for declarationDir	`tsconfig.compilerOptions.declarationDir`
resolveFullPaths	Attempt to replace incomplete import paths (those not ending in `.js`) with fully resolved paths (for ECMAScript Modules compatibility)	`false`
resolveFullExtension	Allows you to specify the extension of incomplete import paths, works with `resolveFullPaths`	`'.js' \| '.mjs' \| '.cjs'`
silent	Reduced terminal output. This is a deprecated option and no longer has any effect.	`true`
verbose	Additional information is output to the terminal	`false`
debug	Debug information is send to the terminal	`false`
replacers	Files to import as extra replacers More info	`[]`
output	The output object tsc-alias will send logs to.	`new Output(options.verbose)`
fileExtensions	Overwrite file extensions tsc-alias will use to scan and resolve files.	`undefined`

Configuration via `tsconfig.json` Example

1{
2  "compilerOptions": {
3    ...
4  },
5  "tsc-alias": {
6    "verbose": false,
7    "resolveFullPaths": true,
8    "replacers": {
9      "exampleReplacer": {
10        "enabled": true,
11        "file": "./exampleReplacer.js"
12      },
13      "otherReplacer": {
14        "enabled": true,
15        "file": "./otherReplacer.js"
16      }
17    },
18    "fileExtensions": {
19      "inputGlob": "{js,jsx,mjs}",
20      "outputCheck": ["js", "json", "jsx", "mjs"]
21    }
22  }
23}

Single file replacer

We can use tsc-alias in a single file, with a function that returns the modified contents.

We prepare the replacer with prepareSingleFileReplaceTscAliasPaths(), passing the same options that we would pass to replaceTscAliasPaths(). That will return a promise of a function that receives the file contents and path, and returns the transformed contents, synchronously.

1import { prepareSingleFileReplaceTscAliasPaths } from 'tsc-alias';
2
3const runFile: SingleFileReplacer = await prepareSingleFileReplaceTscAliasPaths(options?);
4
5function treatFile(filePath: string) {
6  const fileContents = fs.readFileSync(filePath, 'utf8');
7  const newContents = runFile({fileContents, filePath});
8  // do stuff with newContents
9}

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.2

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to tsc-alias

Other packages similar to tsc-alias

tsc-alias

Installations

Pull Requests

1

90

11

78

Issues

26

125

99

Releases

Developer

justkey007

Developer Guide

CommonJS

Yes

21.6.2

10.2.4

Statistics

Bundle Size

142.28 kB

44.83 kB

Languages

Total Downloads

54,126,785

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

tsc-alias

Comparison to tsconfig-paths

Getting Started

Add it to your build scripts in package.json

Issues

API

Installation

Usage

Configuration via tsconfig.json Example

Single file replacer

10

10

10

4

0

0

0

0

0

0

0

0

3.2

/10

Configuration via `tsconfig.json` Example