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

tsc-hooks

Package Overview
Dependencies
Maintainers
1
Versions
48
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

tsc-hooks

Add tsc compiler hooks to your TypeScript project

  • 1.1.2
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.9K
decreased by-39.97%
Maintainers
1
Weekly downloads
 
Created
Source

TypeScript Compiler Hooks

Installation

For Project Specific tsc:

yarn add tsc-hooks --dev

For Global tsc:

yarn global add tsc-hooks

Getting Started

Example tsconfig.json

{
  "compilerOptions": {
    "outDir": "dist"
  },
  "include": [ "src/**/*" ],
  "exclude": [ "src/**/*.txt" ],
  "hooks": [ "copy-files" ] // hooks is a new property you can add to tsconfig to add custom hooks
  
  /* For more hooks look below... */
}

Hooks are executed in the same order as defined in tsconfig.jsons hook property.

Available Hooks

Hook IDDescriptionAuthor
copy-filestsc does not copy over extra files like .xml, .txt, .html, etc. after compilation. This hook fixes this by copying over files specified in "include". It also ignores files specified in "exclude".Mark Auger (swimauger)
file-permissionsThis hook sets permissions to files after tsc has completed.joel(dderjoel)
<your-hook-id>Learn how to create your own hook here<Your name here>

Examples

file-permissions

  1. tsc compiles index.ts to ./dist/index.js
  2. The copy-files-hook will copy the src/helperProgram.bin to ./dist/helperProgram.bin
  3. The file-permissions-hook will set the permissions r-xr--r-- to ./dist/{helperProgram.bin, index.js} (assuming ./src/index.ts has a shebang like #!/usr/bin/env node, one can now execute ./dist/index.js)

Expample-tsconfig.json:

{
  "compilerOptions": {
    "outDir": "dist"
  },
  "include": [ "src/index.ts", "src/helperProgram.bin" ],
  "exclude": [ "src/**/*.txt" ],
  "hooks": [ "copy-files", "file-permissions" ] 
  "filePermissions": {
    "./dist/helperProgram.bin": "0544",
    "./dist/index.js": "0544"
  }
}

What Can TSC Hooks Do?

  • TypeScript Compiler hooks are scripts that can execute on compilation of your TypeScript project using tsc
  • They can provide new tsconfig options to help your project run smoother
  • They can add new functionality to the compilation process

Keywords

FAQs

Package last updated on 24 Mar 2023

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