{"_id":"@bercos34/vecomponents","_rev":"2-7cd5182f3325bbab762da3a686379cd0","name":"@bercos34/vecomponents","dist-tags":{"latest":"0.2.0"},"versions":{"0.1.0":{"name":"@bercos34/vecomponents","version":"0.1.0","main":"dist/index.js","umd:main":"dist/vecomponents.umd.production.js","module":"dist/vecomponents.es.production.js","typings":"dist/index.d.ts","scripts":{"start":"tsdx watch","build":"tsdx build","test":"tsdx test --env=jsdom"},"peerDependencies":{"react":">=16.8"},"husky":{"hooks":{"pre-commit":"pretty-quick --staged"}},"prettier":{"printWidth":80,"semi":true,"singleQuote":true,"trailingComma":"es5"},"devDependencies":{"@types/jest":"^24.0.13","@types/react":"^16.8.19","@types/react-dom":"^16.8.4","husky":"^2.4.0","prettier":"^1.17.1","pretty-quick":"^1.11.0","react":"^16.8.6","react-dom":"^16.8.6","tsdx":"^0.6.1","tslib":"^1.9.3","typescript":"^3.5.1"},"dependencies":{"@emotion/core":"^10.0.10","@emotion/styled":"^10.0.11","@fortawesome/fontawesome-svg-core":"^1.2.19","@fortawesome/free-solid-svg-icons":"^5.9.0","@fortawesome/react-fontawesome":"^0.1.4"},"gitHead":"b18cdfd11b43274ef31bcf1cc28ed00ce071d572","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.","_id":"@bercos34/vecomponents@0.1.0","_nodeVersion":"12.3.1","_npmVersion":"6.9.0","dist":{"integrity":"sha512-QUmf3YRe4uOQqfTZs/NT3HI6zIhgvpeU5+rt6M7HFJoda5uUBjXd+E3foUIKFETzKmxoxw4SJceoD3RIUELOjQ==","shasum":"0ca07d9df1347d601eed1f79437a1e737864aa7b","tarball":"https://registry.npmjs.org/@bercos34/vecomponents/-/vecomponents-0.1.0.tgz","fileCount":26,"unpackedSize":216229,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc+e3ICRA9TVsSAnZWagAAgHsP/AsXb7Nlm8JZvaQVwwh8\nps+3SG1AGEe1LSYGo0ZarMQr78PQOHXr/8UYdkqZd2jfG/4nNYHcrLymHTgK\nUuXaJ7xQ69oRfV0AvDnNP48eM7Y/2JvgEHQ46RJ7fEoINBbiUR0Awhq8Zz8K\n3ElklfmzksxsW5i/DFNM6eT8abE2evaBsTSKq/+S1YC82FF7KM78QqElqWPS\nWMXjw0rXKLosiz7AFvSWdhNs1vP8TOoEbfTFaeElpe3Ymxuf4/fUcOELdiE6\nn8a51lPFYLYO3PaU2wgjv7PI2fJUka+o1te+bRb8mI5DT+EQqPXT5deMJbm8\nMLZQrs9JXWomtTvIkdGMkHicu0ASVQ6ybQnshS63YhYUHfxw7qwfiCpAMqFh\nBSffNxQd5/LCFvcNbAi04R0PIUWm/NuzMoJUnGqWSKnJbc+txqtodPsbJZsD\noGy5t+tL+yZ/2GpIDBUvEE0UYqfJYxXgUfIBPPFK0JOeHV6qI1He1A8Wuks5\nPw7HBDm/r6ZVkbGrrn6S/YMdzj77j3YcNsrqEFkNol5inK9MxDFj9j2ypoi3\ngWaXy9sPImdmcyQalCbRWkjdaYX+v7oeUGuq9L8a+vhmBYNEej4D2VvGu2dU\nOZ3z5YuBaAKcZtHpizh/w5GS36AYbHvUZdMEaJEkwXA0O2dcgx1dvf/+oawR\nsl0F\r\n=YJuG\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGJcM/wAC0rBaASFAxr1b4YoUwyx4tN95hMFH85sx2ibAiAjcQGkR7ibYbp+J918JaLxeY4ehzqniTXrADDyyP2TLg=="}]},"maintainers":[{"name":"bercos34","email":"bernardcosgriff@gmail.com"}],"_npmUser":{"name":"bercos34","email":"bernardcosgriff@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/vecomponents_0.1.0_1559883208164_0.383792897276392"},"_hasShrinkwrap":false},"0.2.0":{"name":"@bercos34/vecomponents","version":"0.2.0","main":"dist/index.js","umd:main":"dist/vecomponents.umd.production.js","module":"dist/vecomponents.es.production.js","typings":"dist/index.d.ts","scripts":{"start":"tsdx watch","build":"tsdx build","test":"tsdx test --env=jsdom"},"peerDependencies":{"react":">=16.8"},"husky":{"hooks":{"pre-commit":"pretty-quick --staged"}},"prettier":{"printWidth":80,"semi":true,"singleQuote":true,"trailingComma":"es5"},"devDependencies":{"@types/jest":"^24.0.13","@types/react":"^16.8.19","@types/react-dom":"^16.8.4","husky":"^2.4.0","prettier":"^1.18.2","pretty-quick":"^1.11.0","react":"^16.8.6","react-dom":"^16.8.6","tsdx":"^0.6.1","tslib":"^1.9.3","typescript":"^3.5.1"},"dependencies":{"@emotion/core":"^10.0.10","@emotion/styled":"^10.0.11","@fortawesome/fontawesome-svg-core":"^1.2.19","@fortawesome/free-solid-svg-icons":"^5.9.0","@fortawesome/react-fontawesome":"^0.1.4","resize-observer-polyfill":"^1.5.1"},"gitHead":"bd8b4eccd2b5f58bdf227516714fc17ac9a4b299","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.","_id":"@bercos34/vecomponents@0.2.0","_nodeVersion":"12.3.1","_npmVersion":"6.9.0","dist":{"integrity":"sha512-QAqxc+eRYn281wwLdQNUstmT6WhpFTSb2sB4Ew4dNKpWEj/75QuvBZvpR7aEVesQIBOW88DnYCNZ6Tb+1t9row==","shasum":"cfe1ef2f1311b460e5c3f11746fbb7cda4ebc9df","tarball":"https://registry.npmjs.org/@bercos34/vecomponents/-/vecomponents-0.2.0.tgz","fileCount":36,"unpackedSize":421793,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc/IyjCRA9TVsSAnZWagAA6yUP/1MCBdZ6Xg+iaDyM6UBu\nr3bYb/9ix4PYRf4HQoj/oUJn/tODzF17ZWEGXxHuKX3Qqi+ZDltqdCIuGzP3\n2JUAMgHxlXhc/DMh54qWubbw+yEgH7RV3oylYSqBGkJrITE7FfhX4YWMXLjd\n9ja+cRDuOMaHTk3lvXvpTty2SbcjW7FztzfPo9KvGz20AjqyIrZOfD/09v99\ngYFsOwvPRwj2eGrK06fEdnW1vMx9hw9jJEjOOqsfftAp8m5F0cvHQmoMO/wn\noZ/5qeE2+hTlyTnRgtllFA7PQ9e0U/bfLqIw5ETpKq142ZPUKvBBYb7OiSeg\njm857ixr/nuvYvt1p5ChcjA6HGUeqJ4uAlh/x3rN7noHpC8TlBV6Z1nY/vmT\nmr2tYAdZQbiqq/g50JNy8X3SSnamHf4SqEAoaXAjAfYuWk/YjOKIoJ5EJNwA\njiti10KAioM9JrTbYwJM+IhLbkxB3SQF3tgbRTLmUMB48vUx0D2NYkqCuvM7\nCs0ovTFEU+f9q2B00eBjiB5WnDMnQ+L2bEZRNHvLj6aepf8Y5JbdyinbMb47\nUih3FEOrlcFRsPSzjr/4URy73qhBiyT4+R8KhJB45+0YOj7lOm0KwTkM88Wu\nPjGzmTIl2Jz0RMTLGyOSOt2oL2fFCDRuHaBx00uDf89IZqEOcdkAUQlLttMc\nwIDF\r\n=ansN\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCID+qZ2hP4/UGnUIBI1yc3u3jt8Sb1Wv+ThFbfdlb0ZCEAiEAiH9pvSAZUn2TEfa01mcVIBlycWbRUP5qXtToDMD1jY8="}]},"maintainers":[{"name":"bercos34","email":"bernardcosgriff@gmail.com"}],"_npmUser":{"name":"bercos34","email":"bernardcosgriff@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/vecomponents_0.2.0_1560054946810_0.9922748119714293"},"_hasShrinkwrap":false}},"time":{"created":"2019-06-07T04:53:28.123Z","0.1.0":"2019-06-07T04:53:28.287Z","modified":"2022-04-04T18:28:44.954Z","0.2.0":"2019-06-09T04:35:46.977Z"},"maintainers":[{"name":"bercos34","email":"bernardcosgriff@gmail.com"}],"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.","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## 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","readmeFilename":"README.md"}