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

clean-typescript-build

v0.1.5

Published

Some commands in needs for nodemonorepo

Downloads

57

Readme

clean-typescript-build

Simple TypeScript build cleaning tool

Feature

  • Delete TypeScript compilation products if correspding TS source file is detected.

Requirements

  • Node.js ≥ 8.9.0

APIs

clean

declare function clean (root: string, options?: Options): Promise<Clean.Result>

// See https://git.io/fACtE for definition of Clean.Result

Parameters:

  • root: Path to the directory that contains source files.
  • options.deep (optional): Decides whether or not to dive deeper, default ignores node_modules and .git.
  • options.isSource (optional): Decides whether or not a file is a source, default chooses files with extensions of .ts or .tsx.
  • options.listTargets (optional): List corresponding build products of given source file.

Returns:

  • A promise of clean.Result.
  • clean.Result::targets is a list of all targeted files.
  • clean.Result::reports is a list of reports regarding deletion of targeted files.
  • clean.Result::success is a list of files that are successfully deleted, ideally equal to clean.Result::targets.
  • clean.Result::failure is a list of files that are targeted but failed to delete, ideally equal to [].

Effects:

  • Delete TypeScript compilation products if correspding TS source file is detected.

listAllTargets

declare function listAllTargets (root: string, options?: Options): Promise<ReadonlyArray<string>>

Parameters:

Returns:

  • A list of targeted files.

CLIs

clean-typescript-build <directory> [options]

Clean TypeScript compilation products

Options:
  --version     Show version number                                    [boolean]
  --help        Show help                                              [boolean]
  --directory   Directory that contains source files                    [string]
  --dry, -u     List files without deletion           [boolean] [default: false]
  --format, -f  Format of output to be printed to stdout
                             [choices: "text", "json", "none"] [default: "text"]
  --jsonIndent  JSON indentation when --format=json        [number] [default: 2]

License

MIT © Hoàng Văn Khải