feat: initial release

Author: gregberge

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env", "@babel/preset-react"]
+}

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+/dist/

.npmignore

@@ -0,0 +1,4 @@
+/*
+!/dist/**/*.js
+!/src/**/*.js
+*.test.js

.travis.yml

@@ -0,0 +1,19 @@
+language: node_js
+
+node_js:
+  - 10
+
+before_install:
+  - curl -o- -L https://yarnpkg.com/install.sh
+  - export PATH="$HOME/.yarn/bin:$PATH"
+
+notifications:
+  email: false
+
+cache:
+  yarn: true
+  directories:
+    - 'node_modules'
+
+git:
+  depth: 5

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Smooth Code
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,41 @@
+# prop-desc
+
+[![License](https://img.shields.io/npm/l/prop-desc.svg)](https://github.com/smooth-code/prop-desc/blob/master/LICENSE)
+[![npm package](https://img.shields.io/npm/v/prop-desc/latest.svg)](https://www.npmjs.com/package/prop-desc)
+[![Build Status](https://img.shields.io/travis/smooth-code/prop-desc.svg)](https://travis-ci.org/smooth-code/prop-desc)
+[![DevDependencies](https://img.shields.io/david/dev/smooth-code/prop-desc.svg)](https://david-dm.org/smooth-code/prop-desc?type=dev)
+
+React prop-types with metadata inside ✨
+
+It is a drop-in replacement for prop-types that includes metadata to generate documentation from prop-types consistently.
+
+```sh
+npm install prop-desc prop-types
+```
+
+## Example
+
+```js
+import React from 'react'
+import PropTypes from 'prop-desc'
+
+function MyComponent() {
+  // ... do things with the props
+}
+
+MyComponent.propTypes = {
+  optionalArray: PropTypes.array,
+  optionalBool: PropTypes.bool,
+  optionalFunc: PropTypes.func,
+}
+
+console.log(PropTypes.getMetadata(MyComponent.propTypes))
+```
+
+## Why?
+
+Generating documentation from prop types is useful but not easy. A project call [react-docgen](https://github.com/reactjs/react-docgen) try to introspect code to extract type but it remains static and does not work with complex prop types (in other files). prop-desc solves this and permits to generate consistent documentation from your prop-types.
+
+# License
+
+MIT

package.json

@@ -0,0 +1,34 @@
+{
+  "name": "prop-desc",
+  "description": "Add metadata to React prop-types",
+  "keywords": [
+    "react",
+    "prop-types"
+  ],
+  "version": "1.0.0",
+  "author": "Greg Bergé <berge.greg@gmail.com>",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "umd:main": "dist/index.umd.js",
+  "module": "dist/index.mjs",
+  "source": "src/index.js",
+  "scripts": {
+    "test": "jest",
+    "prebuild": "rm -rf dist/",
+    "build": "microbundle --external react",
+    "prepublishOnly": "yarn build",
+    "release": "standard-version && conventional-github-releaser --preset angular"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.5.5",
+    "@babel/preset-env": "^7.5.5",
+    "@babel/preset-react": "^7.0.0",
+    "babel-core": "^7.0.0-0",
+    "babel-jest": "^24.8.0",
+    "conventional-github-releaser": "^3.1.3",
+    "jest": "^24.8.0",
+    "microbundle": "^0.11.0",
+    "react": "^16.9.0",
+    "standard-version": "^7.0.0"
+  }
+}

src/index.js

@@ -0,0 +1,139 @@
+import PropTypes from 'prop-types'
+
+function typeToString(prop) {
+  const meta = prop.__meta
+  if (!meta) return 'unknown'
+  const propName = meta.type.name
+  if (propName === 'arrayOf') {
+    return `[${typeToString(meta.type.value)}]`
+  }
+  if (propName === 'objectOf') {
+    return `{${typeToString(meta.type.value)}}`
+  }
+  if (propName === 'shape' || propName === 'exact') {
+    return `{ ${Object.entries(meta.type.value)
+      .map(([name, type]) => `${name}: ${typeToString(type)}`)
+      .join(' , ')} }`
+  }
+  if (propName === 'union') {
+    return `${meta.type.value.map(type => typeToString(type)).join(' | ')}`
+  }
+  if (propName === 'enum') {
+    return `${meta.type.value.map(type => type.value).join(' | ')}`
+  }
+  return propName
+}
+
+const createType = typeDesc => {
+  const checkPropType = (...args) => typeDesc.propType(...args)
+  checkPropType.__meta = {
+    ...typeDesc,
+    toString() {
+      return typeToString(checkPropType)
+    },
+  }
+  Object.defineProperties(checkPropType, {
+    isRequired: {
+      get() {
+        return createType({
+          ...typeDesc,
+          propType: typeDesc.propType.isRequired,
+          required: true,
+        })
+      },
+    },
+    defaultTo: {
+      get() {
+        return value =>
+          createType({ ...typeDesc, defaultValue: { value: String(value) } })
+      },
+    },
+    desc: {
+      get() {
+        return description => createType({ ...typeDesc, description })
+      },
+    },
+  })
+  return checkPropType
+}
+
+const type = (propType, name, { value = null } = {}) => {
+  return createType({
+    propType,
+    type: {
+      name,
+      value,
+    },
+    required: false,
+    defaultValue: undefined,
+  })
+}
+
+export const getMetadata = descriptors =>
+  Object.keys(descriptors).reduce(
+    (props, key) => ({
+      ...props,
+      [key]: descriptors[key].__meta,
+    }),
+    {},
+  )
+
+export const array = type(PropTypes.array, 'array')
+export const bool = type(PropTypes.bool, 'boolean')
+export const func = type(PropTypes.func, 'function')
+export const number = type(PropTypes.number, 'number')
+export const object = type(PropTypes.object, 'object')
+export const string = type(PropTypes.string, 'string')
+export const symbol = type(PropTypes.symbol, 'symbol')
+export const any = type(PropTypes.any, 'any')
+export const arrayOf = value =>
+  type(PropTypes.arrayOf(value), 'arrayOf', { value })
+export const element = type(PropTypes.element, 'element')
+export const elementType = type(PropTypes.elementType, 'elementType')
+export const instanceOf = value =>
+  type(PropTypes.instanceOf(value), 'instanceOf', { value })
+export const node = type(PropTypes.node, 'node')
+export const objectOf = value =>
+  type(PropTypes.objectOf(value), 'objectOf', { value })
+export const oneOf = values =>
+  type(PropTypes.oneOf(values), 'enum', {
+    value: values.map(value => ({ value })),
+  })
+export const oneOfType = types =>
+  type(PropTypes.oneOfType(types), 'union', { value: types })
+export const shape = shape =>
+  type(PropTypes.shape(shape), 'shape', {
+    value: shape,
+  })
+export const exact = shape =>
+  type(PropTypes.exact(shape), 'exact', {
+    value: shape,
+  })
+
+const PropDesc = {
+  array,
+  bool,
+  func,
+  number,
+  object,
+  string,
+  symbol,
+  any,
+  arrayOf,
+  element,
+  elementType,
+  instanceOf,
+  node,
+  objectOf,
+  oneOf,
+  oneOfType,
+  shape,
+  exact,
+  getMetadata,
+  checkPropTypes: PropTypes.checkPropTypes,
+  resetWarningCache: PropTypes.resetWarningCache,
+}
+
+PropDesc.PropTypes = PropDesc
+
+export default PropDesc