Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

aliases-from-tsconfig

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

aliases-from-tsconfig

Reads a jsconfig/tsconfig.json baseUrl and paths and provides a methods to replace its aliases in your files paths.

  • 0.2.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
24
increased by84.62%
Maintainers
1
Weekly downloads
 
Created
Source

Aliases from tsconfig.json

Continuous Integrations License

Reads a jsconfig/tsconfig.json baseUrl and paths and provides a method to replace its aliases in your files paths.

Installation

This library is published in the NPM registry and can be installed using any compatible package manager.

npm install aliases-from-tsconfig --save

# For Yarn, use the command below.
yarn add aliases-from-tsconfig

Usage for Custom Implementations

Create an AliasesFromTSConfig instance with the path to your jsconfig/tsconfig.json, and use its methods to check if the file's path has an alias or to apply the alias.

import AliasesFromTSConfig from 'aliases-from-tsconfig';

const aliases = new AliasesFromTSConfig('./tsconfig.json');

aliases.apply('@/components/Button/ButtonGhost.js');
//=> './app/assets/components/Button/ButtonGhost.js'

function processFilePath(path) {
  if (aliases.hasAlias(path)) {
    console.log(`The file path "${path}" has an alias from tsconfig.json.`);
  }

  return aliases.apply(path);
}

Usage with Webpack

Create an instance of AliasesFromTSConfig using the path to your tsconfig.json as argument, and then call the method getAliasesForWebpack to get the correct alias configuration for webpack.

// configuration/webpack.config.mjs
import AliasesFromTSConfig from 'aliases-from-tsconfig';


const aliases = new AliasesFromTSConfig('../jsconfig.json');

export default {
  resolve: {
    alias: aliases.getAliasesForWebpack(),
    // ...
  },
  // ...
};

Documentation

Documentation generated from source files by Typedoc.

License

Released under MIT License.

FAQs

Package last updated on 25 Apr 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc