npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tsc-committed

v1.1.1

Published

A CLI tool to report tsc errors on committed files between base branch and feature branch in a git repo

Downloads

3

Readme

TSC Committed


TSC Committed is a CLI tool that helps identify the committed files between a base branch and a feature branch that fail the TypeScript compilation on committed files in a Git repository.

The tool is designed to be used in a continuous integration/continuous deployment (CI/CD) environment or as a Git hook to ensure that only TypeScript files that compiled successfully are committed to the codebase.

Installation

To install TSC Committed, run the following command:

npm install -g tsc-committed

or using npx:

npx tsc-committed

Usage

TSC Committed can be used as a command-line tool by passing in the project directory, root directory, file extensions and the base branch and feature branch to compare. The tool will output the list of files TypeScript compilation errors found on the committed files.

tsc-committed --projectDir path/to/project --rootDir src --extensions ts,tsx --baseBranch main

Options

The following options are available:

  • --projectDir: The project directory to run tsc against. Default is the current directory.
  • --rootDir: The root directory for TypeScript files. Default is "src".
  • --extensions: The file extensions to include. Default is "ts,tsx".
  • --baseBranch: The base branch to compare with. Default is main.
  • --verbose: Enables verbose output.

Using as a Git Hook

To use TSC Committed as a Git hook, add the following to your .git/hooks/pre-commit file:

#!/bin/sh

tsc-committed --baseBranch main  || exit 1

Make sure the pre-commit file is executable:

bash Copy code

chmod +x .git/hooks/pre-commit

Contributing

If you would like to contribute to TSC Committed, please follow the steps below:

  • Fork the repository.
  • Create a new branch for your feature or bug fix.
  • Make your changes and write tests for them.
  • Run the tests to ensure they pass.
  • Commit your changes and push your branch to your fork.
  • Create a pull request to the main branch of the vinothpandian/tsc-committed repository.

License

TSC Committed is licensed under the MIT License. See the LICENSE file for more information.