{"dist":{"shasum":"5e4b8e5f3b1971b99a3cc531c3f3336fd80722f6","tarball":"https://registry.npmjs.org/docz-components/-/docz-components-2.0.0-rc.2.tgz","fileCount":17,"integrity":"sha512-iH15KFHwF/LD+wORJ/pZ5BRU+XnJMBMkj56gJmrsrCTF9TVnq6wZmfFxFFEh0ahz9ia1dVKYsEhPXFj0tRiVmA==","signatures":[{"sig":"MEQCIF8Is4mwXz42wCAnCDDxDqV80o2Te7fXqgbWD4n1IkYIAiBDI+WnP50Yt1y5cGeQy98mZk3RjzDKgs30XSVCzHpSdA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":53598,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdaozmCRA9TVsSAnZWagAA9zQP/RIDwgBetz6gxxIGjTx+\nMi5NTroC/xp0F8GkNNzmRuCnUDg5Tz44xohp7/U8QZ2yqiZ/yWFoAFhXtARu\nPxuLztU99fQjQYmp8QP/zo3heUWba31J++EkqrH0Bp7Wl/Ee6C/3etTVBDo8\n8MBr3bg2HPtlrR1ZlCxVftxExLqu5RAUozHlWGXCBwSC8on11AkGpGrZu15u\ncE6ayZiPTYJJ3j5G1fnD6AksYstPavdDyrAbDUvrXFDkIfZ92scl0U3JqGhK\nt78WfD1GCK6ZjyE1LsLTli9fuQ3mz9+BEmEIKABvIcA2wrGmiCmm5WjlL+QC\nUvm6in0XOTzBN066tISSV21j7DNOWXVxWaQeFeMHzH8qEdpb3RBQhfY2MOZr\nbksK0ZSbmjSrolJzyktC0wPN5sYSamf3UG7pJRIpNmRFokZqLfb8Vqj8F3Bz\no+cxtqyAcQdahiMxHEqKW4U0KEv32isOTPyNkcEMopSTm1EtJg5TKMbErlpb\nftTwEvTOZafoC4w85/2ramS4YK1dHWHhkagE/PsjRt/I6IPfICq5MU/K9lYr\nmKlm+QpfWAI9jN6u6cHg45Di4W53Gn8mJzT5exDrbjEbpwSUflRG5EWUbPqr\nmyf/wwWf5UVyl+c2IkHOvez8+X2jyQx//EHG1hG9Fyue/exvK2RHS3Oz1suj\nUPY0\r\n=0Gai\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","name":"docz-components","husky":{"hooks":{"pre-commit":"pretty-quick --staged"}},"module":"dist/docz-components.esm.js","readme":"# TSDX React User Guide\n\nCongrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.\n\n> This TSDX setup is meant for developing React components (not apps!) that can be published to NPM. If you’re looking to build an app, you should use `create-react-app`, `razzle`, `nextjs`, `gatsby`, or `react-static`.\n\n> If you’re new to TypeScript and React, checkout [this handy cheatsheet](https://github.com/sw-yx/react-typescript-cheatsheet/)\n\n## Commands\n\nTSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based](https://parceljs.org) playground for it inside `/example`.\n\nThe recommended workflow is to run TSDX in one terminal:\n\n```\nnpm start # or yarn start\n```\n\nThis builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.\n\nThen run the example inside another:\n\n```\ncd example\nnpm i # or yarn to install dependencies\nnpm start # or yarn start\n```\n\nThe default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**, [we use Parcel's aliasing](https://github.com/palmerhq/tsdx/pull/88/files).\n\nTo do a one-off build, use `npm run build` or `yarn build`.\n\nTo run tests, use `npm test` or `yarn test`.\n\n## Configuration\n\nCode quality is [set up for you](https://github.com/palmerhq/tsdx/pull/45/files) with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.\n\n### Jest\n\nJest tests are set up to run with `npm test` or `yarn test`. This runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.\n\n#### Setup Files\n\nThis is the folder structure we set up for you:\n\n```\n/example\n  index.html\n  index.tsx       # test your component here in a demo app\n  package.json\n  tsconfig.json\n/src\n  index.tsx       # EDIT THIS\n/test\n  blah.test.tsx   # EDIT THIS\n.gitignore\npackage.json\nREADME.md         # EDIT THIS\ntsconfig.json\n```\n\n#### React Testing Library\n\nWe do not set up `react-testing-library` for you yet, we welcome contributions and documentation on this.\n\n### Rollup\n\nTSDX uses [Rollup v1.x](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.\n\n### TypeScript\n\n`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.\n\n## Continuous Integration\n\n### Travis\n\n_to be completed_\n\n### Circle\n\n_to be completed_\n\n## Optimizations\n\nPlease see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:\n\n```js\n// ./types/index.d.ts\ndeclare var __DEV__: boolean;\n\n// inside your code...\nif (__DEV__) {\n  console.log('foo');\n}\n```\n\nYou can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.\n\n## Module Formats\n\nCJS, ESModules, and UMD module formats are supported.\n\nThe appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.\n\n## Using the Playground\n\n```\ncd example\nnpm i # or yarn to install dependencies\nnpm start # or yarn start\n```\n\nThe default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**!\n\n## Deploying the Playground\n\nThe Playground is just a simple [Parcel](https://parceljs.org) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):\n\n```bash\ncd example # if not already in the example folder\nnpm run build # builds to dist\nnetlify deploy # deploy the dist folder\n```\n\nAlternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:\n\n```bash\nnetlify init\n# build command: cd example && yarn && yarn build\n# directory to deploy: example/dist\n# pick yes for netlify.toml\n```\n\n## Named Exports\n\nPer Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.\n\n## Including Styles\n\nThere are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.\n\nFor vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.\n\n## Publishing to NPM\n\nWe recommend using https://github.com/sindresorhus/np.\n\n## Usage with Lerna\n\nWhen creating a new package with TSDX within a project set up with Lerna, you might encounter a `Cannot resolve dependency` error when trying to run the `example` project. To fix that you will need to make changes to the `package.json` file _inside the `example` directory_.\n\nThe problem is that due to the nature of how dependencies are installed in Lerna projects, the aliases in the example project's `package.json` might not point to the right place, as those dependencies might have been installed in the root of your Lerna project.\n\nChange the `alias` to point to where those packages are actually installed. This depends on the directory structure of your Lerna project, so the actual path might be different from the diff below.\n\n```diff\n   \"alias\": {\n-    \"react\": \"../node_modules/react\",\n-    \"react-dom\": \"../node_modules/react-dom\"\n+    \"react\": \"../../../node_modules/react\",\n+    \"react-dom\": \"../../../node_modules/react-dom\"\n   },\n```\n\nAn alternative to fixing this problem would be to remove aliases altogether and define the dependencies referenced as aliases as dev dependencies instead. [However, that might cause other problems.](https://github.com/palmerhq/tsdx/issues/64)\n","scripts":{"lint":"tsdx lint","test":"tsdx test --env=jsdom","build":"tsdx build","start":"tsdx watch"},"typings":"dist/index.d.ts","_npmUser":{"name":"rakannimer","email":"rakannimer@gmail.com"},"prettier":{"semi":true,"printWidth":80,"singleQuote":true,"trailingComma":"es5"},"_npmVersion":"6.9.0","description":"Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.","directories":{},"maintainers":[{"name":"rakannimer","email":"rakannimer@gmail.com"}],"_nodeVersion":"10.16.0","dependencies":{"lodash":"^4.17.15","theme-ui":"^0.2.38","lodash-es":"^4.17.15","react-live":"^2.2.0","re-resizable":"^6.0.0","react-feather":"^2.0.3","copy-text-to-clipboard":"^2.1.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"tsdx":"^0.9.0","husky":"^3.0.4","react":"^16.9.0","tslib":"^1.10.0","prettier":"^1.18.2","react-dom":"^16.9.0","typescript":"^3.6.2","@types/jest":"^24.0.18","@types/react":"^16.9.2","pretty-quick":"^1.11.1","@types/theme-ui":"^0.2.2","@types/react-dom":"^16.9.0"},"peerDependencies":{"react":">=16"},"_npmOperationalInternal":{"tmp":"tmp/docz-components_2.0.0-rc.2_1567263974083_0.10301835614215848","host":"s3://npm-registry-packages"},"_id":"docz-components@2.0.0-rc.2","version":"2.0.0-rc.2"}