{"_id":"@arthurpolon/tilt.it","name":"@arthurpolon/tilt.it","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"version":"0.1.0","license":"MIT","main":"dist/index.js","typings":"dist/index.d.ts","engines":{"node":">=10"},"scripts":{"start":"tsdx watch","build":"tsdx build","test":"tsdx test --passWithNoTests","lint":"tsdx lint","prepare":"tsdx build","size":"size-limit","analyze":"size-limit --why"},"peerDependencies":{"react":">=16"},"husky":{"hooks":{"pre-commit":"tsdx lint"}},"prettier":{"printWidth":80,"semi":true,"singleQuote":true,"trailingComma":"es5"},"name":"@arthurpolon/tilt.it","author":{"name":"Your Name"},"module":"dist/polon-tilt.esm.js","size-limit":[{"path":"dist/polon-tilt.cjs.production.min.js","limit":"10 KB"},{"path":"dist/polon-tilt.esm.js","limit":"10 KB"}],"devDependencies":{"@size-limit/preset-small-lib":"^7.0.8","@types/react":"^18.0.6","@types/react-dom":"^18.0.2","husky":"^7.0.4","react":"^18.0.0","react-dom":"^18.0.0","size-limit":"^7.0.8","tsdx":"^0.14.1","tslib":"^2.4.0","typescript":"^4.6.3"},"gitHead":"29399c010c1242d8070b04326e8f679f773de691","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":"@arthurpolon/tilt.it@0.1.0","_nodeVersion":"14.17.4","_npmVersion":"6.14.14","dist":{"integrity":"sha512-cbV7XE5Yw0eQjnjUyCHmp+j5q34xgw8DxOWPzHrrnaNNEKzroFQRnbqBMCe3W2xMfWB5x1/R0ilHpSvFIgM1/Q==","shasum":"4d43980a856e6a623a7cd1b4fd539937ff7d5312","tarball":"https://registry.npmjs.org/@arthurpolon/tilt.it/-/tilt.it-0.1.0.tgz","fileCount":14,"unpackedSize":28991,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC4O47U2pjy/AeYK+tF0AbOH/Qc3zBzBtMfivE++onTxgIgayv1wtXD2BgLcj0y55c+7hFeAODAQS8FFlLEJxKpO7M="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiYz16ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpXtQ//YHYpXdB6O9Jyn5ufX5w6Yhf/UwJnNXQaPcFRegjlxwXC96kF\r\nh8JPv6kBnurL+ONLLmJ7T5FvBs750Gv0qoqKSfg3eyyVfIsqxRJMGIx2e4gl\r\n31kLcaDU1Ok0AfSLGb09yaNj+FsZj9oaqrsAulSTBmFaFoNDO4NmpLnR1+x6\r\nVISxL2xcMivOz2WbMw//G9x8llsG8ZX28MU1y4OUW2RH0Y1/kWdKRsg7Tq5f\r\ndFiWytxy9qj/T7/L6qhOtI8XBKA9bbHHSsNSv5jUCjAgGv0adkeV97UAouR1\r\nrT87evCClN89ahlZ2+wNzs40nrwJ53Kj7byV30iQcVN+WEtQ7yDd+bUx4+Aq\r\nqYaopSa9+lwQcoi9C4uqArSeFXyj2uulqqn+WjaG3n21dSrV7p+AS5L4gEIF\r\n9+RQtS+ASt8gGu8KpJaqR9KKAPvUt0zqMxA/n+uyhvn/eN4SgtvCWFto7IfU\r\nelekwZvPRM6DFQddISeEzXtK9Gk8qF3ZQvN6a0LYUwwVW2RPQUWEerT4Ku9b\r\n+R1AKlN9fhxrPaHOxCiGJ94pQTWuDvfoTvVno223VRsO6V9XLtRXP8QUs6pC\r\nDthnST96zHKAUYq1ixmpB32MpzAjBRpcB/epyuSG65mzv0oh5kBRIDlRxufA\r\n+pcXwyqd6y7H/U+21FPToAJWhBjoSAFii08=\r\n=ubC1\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"arthurpolon","email":"arthurpolon@hotmail.com"},"directories":{},"maintainers":[{"name":"arthurpolon","email":"arthurpolon@hotmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/tilt.it_0.1.0_1650670969733_0.8869823387748577"},"_hasShrinkwrap":false}},"time":{"created":"2022-04-22T23:42:49.660Z","0.1.0":"2022-04-22T23:42:50.076Z","modified":"2022-04-22T23:42:50.210Z"},"maintainers":[{"name":"arthurpolon","email":"arthurpolon@hotmail.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.","author":{"name":"Your Name"},"license":"MIT","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 component libraries (not apps!) that can be published to NPM. If you’re looking to build a React-based 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```bash\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```bash\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://parceljs.org/module_resolution.html#aliases).\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 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`.\n\n### Bundle analysis\n\nCalculates the real cost of your library using [size-limit](https://github.com/ai/size-limit) with `npm run size` and visulize it with `npm run analyze`.\n\n#### Setup Files\n\nThis is the folder structure we set up for you:\n\n```txt\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](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### GitHub Actions\n\nTwo actions are added by default:\n\n- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix\n- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)\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## Deploying the Example 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: yarn build && 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 [np](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"}