Git Product home page Git Product logo

ts-react-pure-class-plugin's Introduction

ts-react-pure-class-plugin

A TypeScript AST Transformer that transform class based stateless pure component to functional component.

Example

from

export default class extends React.PureComponent<{}> {

  render() {
    return <div />
  }

}

to

import { memo as react_memo_1 } from "react";

function rewrited_pure_class_1(rewrited_props_2) {
    return React.createElement("div", null);
}

export default react_memo_1(rewrited_pure_class_1);

How to use

getCustomTransformers: () => ({
  before: [pureClsPlugin()],
})

Notice

if you want to use this plugin, please make sure there're no components were described like following code, otherwise, the transformation will break your app.

class Foo extends React.PureComponent {

  render() {
    return <div />
  }

}

class Bar extends Foo {
  // bala bala
}

In most situations, you can just mark Foo as abstract class to skip the optmization and solve the problem.

Option

pureClsPlugin(option?: Option)

interface Option {
  verbose?: boolean
  useMemo?: boolean
}

Deopt

if transformer meets one of following conditions, optmization will be skipped.

  • contain react component lifecycle
  • contain state
  • contain getter/setter
  • contain decorator
  • contain static property
  • abstract class
  • not a pure component
  • a special comment directive
  • non-top-level class

Deopt directive

/*@__DEOPT__*/
export class A1 extends React.PureComponent {
  render() {
    return <div>Foo</div>
  }
}

License

Apache-2.0

ts-react-pure-class-plugin's People

Contributors

dependabot[bot] avatar saviio avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.