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

@dtsgenerator/decorate-typename

v1.3.1

Published

decorate the output typename.

Downloads

1,518

Readme

@dtsgenerator/decorate-typename

This is the dtsgenerator plugin. Decorate the output typename. Such as it add the I prefix to the interface name.

Install

npm install @dtsgenerator/decorate-typename

Usage

dtsgen.json

{
    "plugins": {
        "@dtsgenerator/decorate-typename": {
            "interface": {
                "prefix": "I"
            },
            "type": {
                "prefix": "T"
            }
        }
    }
}

Configuration

  • the type of configuration
interface ConfigContent {
    prefix?: string;
    postfix?: string;
}
export type Config =
    | {
          interface: ConfigContent;
          type: ConfigContent;
      }
    | ConfigContent;

| key | type | description | |-----|------|-------------| | prefix | string | the prefix of type name. | | postfix | string | the postfix of type name. | | interface | ConfigContent | the prefix and postfix apply to the interface name only. | | type | ConfigContent | the prefix and postfix apply to the type alias name only. |

  • Example
{
  "prefix": "I",
}
{
  "interface": {
    "prefix": "I",
    "postfix": "_"
  },
  "type": {
    "prefix": "T",
    "postfix": "_"
  }
}

Development

npm run build
npm test

Stacks

  • TypeScript
  • eslint
  • prettier

Files

  • index.ts: plugin main file
  • test/snapshot_test.ts: test main file. should not edit this file.
  • test/post_snapshots/: post process test patterns. Please add folder if you need.
  • test/pre_snapshots/: pre process test patterns. Please add folder if you need.

npm scripts

main scripts

  • npm run build: transpile this plugin. This command need before publishing this plugin.
  • npm test: test this plugin with coverage.

sub scripts

  • npm run watch: watch editing files for compile.
  • npm run lint:fix: fix lint error automatically.
  • npm run test:update-snapshot: update snapshot files for unit test.
  • npm run coverage: report to coveralls. Need coveralls configuration file.