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

ts-transformer-export-default-name

v0.1.0

Published

A TypeScript AST transformer that assigns a name to each arrow/anonymous function and class exported as default.

Downloads

4

Readme

This is a TypeScript AST transformer [1] that assigns a name to each arrow/anonymous function and class exported as default (e.g. export default () ⇒ 42). The name is derived from the name of the source file or its directory, in the case of index file.

This transformer does basically the same as babel-plugin-transform-export-default-name but it’s implemented for the TypeScript compiler. See README of the aforesaid Babel plugin for the explanation why is this useful.

Examples

Arrow Function

forty-two.ts:.

export default () => 42

This will be transformed to:

forty-two.js:.

const fortyTwo = () => 42;
export default fortyTwo;

Anonymous Function Declaration

forty-two.ts:.

export default function () {
  return 42
}

This will be transformed to:

forty-two.js:.

export default function fortyTwo () {
  return 42;
}

Anonymous Class Declaration

forty-two.ts:.

export default class {
  get answer() { return 42 }
}

This will be transformed to:

forty-two.js:.

export default class FortyTwo {
  get answer() { return 42; }
}

How to Use

Add ts-transformer-export-default-name package to your project as a development dependency and register it as a custom transformer.

Unfortunately, TypeScript itself does not currently provide any easy way to use custom transformers (see Microsoft/TypeScript#14419). Fortunately, there are few solutions.

TTypescript

If you don’t use any bundler such as Rollup or webpack, TTypescript is the way to go. It provides wrappers ttsc and ttserver for the tsc and tsserver commands that add support for custom transformers. All you have to do is to use these wrappers instead of the original commands and define the transformer in your tsconfig.json:

tsconfig.json:.

{
  "compilerOptions": {
    // ...
    "plugins": [
      { "transform": "ts-transformer-export-default-name" }
    ]
  },
  // ...
}

Rollup (with rollup-plugin-typescript2)

rollup.config.js:.

import typescript from 'rollup-plugin-typescript2'
import exportDefaultNameTransformer from 'ts-transformer-export-default-name'

export default {
  // ...
  plugins: [
    typescript({
      transformers: [
        (service) => ({
          before: [ exportDefaultNameTransformer(service.getProgram()) ],
          after: [],
        }),
      ],
    }),
  ],
}

Webpack (with ts-loader or awesome-typescript-loader)

webpack.config.js:.

const exportDefaultNameTransformer = require('ts-transformer-export-default-name').default

module.exports = {
  // ...
  module: {
    rules: [
      {
        test: /\.ts$/,
        loader: 'ts-loader', // or 'awesome-typescript-loader',
        options: {
          getCustomTransformers: (program) => ({
            before: [
              exportDefaultNameTransformer(program),
            ],
          }),
        },
      },
    ],
  },
}

Credits

License

This project is licensed under MIT License. For the full text of the license, see the LICENSE file.

[1] If you’ve never heard about TypeScript transformers, I can recommend this blog post to dive into the topic.