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

@avensia-oss/ts-transform-instrument-react-components

v0.0.2

Published

A TypeScript custom transformer that instruments React components to be able to detect which components aren't rendered

Downloads

5

Readme

ts-transform-instrument-react-components

Note! This transformer is currently experimental

A TypeScript custom transformer that instruments React components to report which components exists in your bundle and which gets rendered. This information can then be used to optimize your bundle and load unrendered components lazily.

How to extract the information

This transformer modifies all files that contains components to define a global variable called reactInstrumentationDefinedComponents. This is an object with file names as key and array of exported names as value. It might look like this:

global.reactInstrumentationDefinedComponents = {
  'Component1.tsx': ['default', 'SomeOtherComponent']
}

Another variable of the same type is created which is called reactInstrumentationRenderedComponents. That will contain a list of the same type of objects of c omponents that have been rendered. So if only the default export from the previous example was rendered it would look like this:

global.reactInstrumentationRenderedComponents = {
  'Component1.tsx': ['default']
}

In order to know which components your file includes that doesn't get rendered you'd run this transform on your code, load the code in Node.js and call ReactDOM.renderToString() on your main components and then check the diff of reactInstrumentationDefinedComponents and reactInstrumentationRenderedComponents. You can of course also run the transformed code in the browser as well and view those global objects in the dev tools.

Other useful transform

If you find this transform useful you might want to use these ones as well: https://github.com/avensia-oss/ts-transform-export-const-folding and https://github.com/avensia-oss/ts-transform-async-import

Installation

yarn add @avensia-oss/ts-transform-instrument-react-components

Usage with webpack

Unfortunately TypeScript doesn't let you specifiy custom transformers in tsconfig.json. If you're using ts-loader with webpack you can specify it like this: https://github.com/TypeStrong/ts-loader#getcustomtransformers-----before-transformerfactory-after-transformerfactory--

The default export of this module is a function which expects a ts.Program an returns a transformer function. Your config should look something like this:

const instrumentReactComponentsTransform = require('@avensia-oss/ts-transform-instrument-react-components');

return {
  ...
  options: {
    getCustomTransformers: (program) => ({
      before: [instrumentReactComponentsTransform(program)]
    })
  }
  ...
};