ts-classname-plugin

A TypeScript custom transformer for referencing parent className like & in Sass(Less).

Requirement

Typescript >= 2.4.1

Install

yarn add ts-classname-plugin --dev

Configuration

option

Option can be a object with properties below:

• flag: the string will be replaced by parent className. default: '&'

webpack

const pluginFactory = require('ts-classname-plugin');
module.exports = {
  // ...
  module: {
    rules: [
      {
        test: /\.(ts|tsx)$/,
        use: [
          {
            loader: require.resolve('ts-loader'),
            options: {
              // ...
              getCustomTransformers: () => ({
                before: [pluginFactory(/** options */)]
              })
            }
          }
        ]
      }
    ]
  }
}

Usage

Concepts

1. replaceable className

only the className of type string and includes the flag in option will be transformed by this plugin. for example:

// flag: '&'
// before
<div className="test">
  <div className"&-1"/>
</div>

// after
<div className="test">
  <div className"test-1"/>
</div>

2. lowest ancestor className

className of the lowest ancestor element which has a className attribute and the value of className attribute is a string or jsx expression in AST. for example:

// before
<div className="lowest">
  <div>
    <div className="&-1"/>
  </div>
</div>

// after
<div className="lowest">
  <div>
    <div className="lowest-1"/>
  </div>
</div>

How it works

We can describe the working process of this plugin with those two concepts above. Encounter the jsx element with a replaceable className in the AST traversal, then replace the flag with the lowest ancestor className. So, enjoy it.

Test

You can clone this project, the place your source code in demo/source, then run yarn demo. The resule code file will be generated in demo/target.