Giter Club home page Giter Club logo

babel-plugin-react-element-info's Introduction

babel-plugin-react-element-info

Babel plugin for exposing React element name and filename in DOM nodes

npm version npm downloads Build Status

Dependencies DevDependencies

Installation

npm install --save-dev babel-plugin-react-element-info

The problem solved

This is useful for auto-generating selectors to run selenium tests.

Example

In

myInputFile.js

class Foo extends React.Component {
  render() {
    return (
      <MyReactComponent>
        My component contents
      </MyReactComponent>
    );
  }
}

Out

class Foo extends React.Component {
  render() {
    return (
      <MyReactComponent data-qa-node="MyReactComponent" data-qa-file="myInputFile">
        My component contents
      </MyReactComponent>
    );
  }
}

Usage

Via .babelrc (Recommended)

.babelrc

without options:

{
  "env": {
    "development": {
      "plugins": [
        "react-element-info"
      ]
    }
  }
}

with options. Prefix is the attribute prefix, defaulting to qa (data-qa-*). To get data-test-prefix-* attributes, set prefix to test-prefix:

{
  "env": {
    "development": {
      "plugins": [
        ["react-element-info", {"prefix": "test-prefix"}]
      ]
    }
  }
}

Via CLI

babel --plugins react-element-info script.js

Via Node API

without options:

require('babel-core').transform('code', {
  plugins: [
    'react-element-info',
  ],
});

with options:

require('babel-core').transform('code', {
  plugins: [
    ['react-element-info', {prefix: 'text-prefix'}],
  ],
});

License

MIT

babel-plugin-react-element-info's People

Contributors

camlegleiter avatar dependabot[bot] avatar sharils avatar suprraz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

babel-plugin-react-element-info's Issues

Disabling the plugin for selected items

Hi!
Is it possible to disable this plugin for selected elements? In my project I use <React.Fragment /> and I get this error:

Warning: Invalid prop `data-qa-file` supplied to `React.Fragment`. React.Fragment can only have `key` and `children` props.

Does anyone have any idea what to do about it?

1.0.2 Isn't published

It looks like the 1.0.2 update didn't get published. I'm currently running it from a fork with the built version committed but an official version bump would be awesome. Thanks!

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.