Socket
Socket
Sign inDemoInstall

maybe-you-meant

Package Overview
Dependencies
3
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    maybe-you-meant

Find deceptive prop-type typeo's in your react apps


Version published
Maintainers
1
Install size
211 kB
Created

Readme

Source

maybe-you-meant

CI

Find deceptive typo's in your react projects.

Are you familiar with the following?


class Foo extends Component {
  static propTypes = {
    foobar: PropTypes.string
  }

  static defaultProps = {
    foobar: 'whatever'
  }
}

// Somewhere in the app

// Oops! We misspelled, but we won't blow up because of a default prop type.
<Foo foobbar='not whatever' />

If so, maybe-you-meant can help. Maybe you meant patches React.createElement to patch every single components componentDidMount, componentDidUpdate (wraps for functional components) to issue console warnings whenever a prop type is similar (but not equal) to one of your defined propTypes.

The preceding, albeit contrived, example would issue the following:

console

In addition, maybe-you-meant will warn when Components are passed props not defined in propTypes, only when propTypes are defined. By default, maybe-you-meant whitelists react's internal properties (events, data-attributes, aria-attributes, html, and svg). The following...

  class Foo extends Component {
    static propTypes = {}
  }
  // The following will result in a warning for the `bar` prop.
  <Foo
    bar='Bang'
    data-foo='bar'
    aria-expanded='false'
    onClick={() => {}}
  />

...will result in:

console

Installation

  yarn add -D maybe-you-meant
  # Or
  npm i -D maybe-you-meant

Usage

  // Somewhere in the top of your app
  import maybeYouMeant from 'maybe-you-meant'
  maybeYouMeant()

  // or
  maybeYouMeant({
    maxDistance: 3,
    include: [/^Include/, 'PatchMe'],
    exclude: [/^Connect/, 'DoNotPatchMe']
  })

  // Don't want warnings about undeclared props?
  maybeYouMeant({
    warnOnUndeclaredProps: false
  })

  // Want to extend the set of whitelisted props (for warning on undeclared props)?
  import maybeYouMeant, { whitelisted } from 'maybe-you-meant'
  // maybe-you-meant exports whitelisted properies from all of the following
  // `all` is a combination of the rest.
  const { all, react, events, aria, data, html, svg } = whitelisted

  maybeYouMeant({
    whitelistedProps: [
      ...whitelisted.all,
      // Don't warn when these are passed and not declared in `propTypes`
      'myProp',
      /^myProps/
    ]
  })

API

maybeYouMeant([opts])

  • opts {Object}
  • opts.maxDistance {Number} The max distance between given prop and prop-type (from Levenshtein algorithm) for warnings
  • opts.include {String|RegExp|Array<String|RegExp>} String or RegExp matching for including Components (tested on displayName)
  • opts.exclude {String|RegExp|Array<String|RegExp>} String or RegExp matching for excluding Components (tested on displayName)
  • opts.warnOnUndeclaredProps {Boolean} Warn when a Component is passed props that are not declared in propTypes (default is ture)
    • Note: warnings will only be issued if the given Component has defined propTypes
  • opts.whitlistedProps {String|RegExp|Array<String|RegExp>} Props that should be ignored when issuing warnings for undeclared props. By default this is all of the React internal properties (see reactProps.js for more info)

Inspiration

The awesome why-did-you-update module.

Keywords

FAQs

Last updated on 25 May 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc