feat: add @xstyled/prop-types utility

Closes #23

Author: gregberge

package.json

@@ -55,6 +55,7 @@
     "jest-styled-components": "^6.3.1",
     "lerna": "^3.14.1",
     "prettier": "^1.18.2",
+    "prop-types": "^15.7.2",
     "react": "^16.8.6",
     "react-dom": "^16.8.6",
     "rollup": "^1.14.3",

packages/prop-types/.npmignore

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

packages/prop-types/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.

packages/prop-types/README.md

@@ -0,0 +1,5 @@
+# @xstyled/prop-types
+
+Generate prop-types from [@xstyled/system](https://www.smooth-code.com/open-source/xstyled/docs/system-props/).
+
+See [documentation](https://www.smooth-code.com/open-source/xstyled/docs/prop-types/)

packages/prop-types/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@xstyled/prop-types",
+  "description": "Generate prop-types from xstyled utilities.",
+  "version": "1.2.0",
+  "keywords": [
+    "emotion",
+    "styled-components",
+    "css",
+    "system",
+    "styled-system",
+    "prop-types"
+  ],
+  "sideEffects": false,
+  "main": "dist/xstyled-prop-types.cjs.js",
+  "module": "dist/xstyled-prop-types.es.js",
+  "author": "Greg Bergé <berge.greg@gmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "build": "rollup -c",
+    "prebuild": "shx rm -rf dist",
+    "prepublishOnly": "yarn build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "prop-types": "^15.0.0"
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.4.4"
+  }
+}

packages/prop-types/rollup.config.js

@@ -0,0 +1,12 @@
+import { getRollupConfig } from '../../config/rollup'
+import pkg from './package.json'
+
+export default getRollupConfig({
+  pwd: __dirname,
+  buildName: 'xstyled-prop-types',
+  name: 'xstyledPropTypes',
+  pkg,
+  globals: {
+    'prop-types': 'PropTypes',
+  },
+})

packages/prop-types/src/index.js

@@ -0,0 +1,9 @@
+import { oneOfType, number, string, object } from 'prop-types'
+
+export function getSystemPropTypes(system) {
+  if (!system) return {}
+  return system.meta.props.reduce((obj, prop) => {
+    obj[prop] = oneOfType([number, string, object])
+    return obj
+  }, {})
+}

packages/prop-types/src/index.test.js

@@ -0,0 +1,39 @@
+import { space } from '@xstyled/system'
+import { getSystemPropTypes } from '.'
+
+describe('#getSystemPropTypes', () => {
+  it('generates empty object if falsy', () => {
+    const propTypes = getSystemPropTypes()
+    expect(propTypes).toEqual({})
+  })
+
+  it('generates PropTypes from system', () => {
+    const propTypes = getSystemPropTypes(space)
+    expect(Object.keys(propTypes)).toEqual([
+      'margin',
+      'm',
+      'marginTop',
+      'mt',
+      'marginRight',
+      'mr',
+      'marginBottom',
+      'mb',
+      'marginLeft',
+      'ml',
+      'mx',
+      'my',
+      'padding',
+      'p',
+      'paddingTop',
+      'pt',
+      'paddingRight',
+      'pr',
+      'paddingBottom',
+      'pb',
+      'paddingLeft',
+      'pl',
+      'px',
+      'py',
+    ])
+  })
+})

website/src/pages/docs/prop-types.mdx

@@ -0,0 +1,29 @@
+---
+menu: Guides
+title: Prop Types
+order: 30
+---
+
+# Prop Types
+
+`@xstyled/prop-types` exposes a utility to generate prop-types from a system prop utility.
+
+## How to get Prop Types?
+
+Import `getUtilityPropTypes` from `@xstyled/prop-types` and generates prop-types for a custom utility.
+
+```js
+import { compose, space, color } from '@xstyled/system'
+import { getUtilityPropTypes } from '@xstyled/prop-types'
+
+const customSystem = compose(
+  space,
+  color,
+)
+
+const SystemBox = styled.div`
+  ${customSystem}
+`
+
+SystemBox.propTypes = getUtilityPropTypes(customSystem)
+```