{"_id":"@canes/shadcn-ui","name":"@canes/shadcn-ui","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@canes/shadcn-ui","version":"1.0.0","description":"Boilerplate for writing React Libraries bundled with Rollup.js to commonJs and ES6 Modules and Storybookt","author":{"name":"hoangtd1706"},"license":"MIT","repository":{"type":"git","url":"git+ssh://git@github.com/hoangtd1706/shared.git"},"homepage":"https://github.com/hoangtd1706/shared.git","main":"dist/cjs/index.js","module":"dist/esm/index.js","types":"dist/index.d.ts","type":"module","engines":{"node":">=18"},"scripts":{"r:build":"rollup -c","start":"NODE_ENV=development BABEL_ENV=development yarn storybook","build":"rimraf dist && NODE_ENV=production BABEL_ENV=production rollup -c","lint":"yarn check-types && yarn eslint && yarn stylelint","lint:fix":"yarn eslint:fix && yarn stylelint:fix","eslint":"eslint . --ext .js,.jsx,.tsx,.ts","eslint:fix":"eslint . --ext .js,.jsx,.tsx,.ts --fix","check-types":"tsc --noEmit true","ci":"yarn lint && yarn test --watch=false","test":"vitest --config ./vitest.config.ts","release":"yarn ci && yarn build && npm publish","storybook":"storybook dev -p 6006","storybook:build":"storybook build","storybook:deploy":"yarn storybook:build && touch ./storybook-static/.nojekyll && gh-pages -d ./storybook-static -t true"},"peerDependencies":{"class-variance-authority":"0.7.0","clsx":"2.x","lucide-react":"^0.292.0","react":"18.2.0","react-dom":"18.2.0","tailwind-merge":"^2.0.0","tailwindcss-animate":"1.0.7"},"devDependencies":{"@radix-ui/react-slot":"^1.0.2","@rollup/plugin-commonjs":"^25.0.7","@rollup/plugin-node-resolve":"^15.2.3","@rollup/plugin-typescript":"^11.1.5","@rollup/plugin-url":"^8.0.2","@storybook/addon-docs":"^7.5.2","@storybook/addon-essentials":"^7.5.2","@storybook/addon-interactions":"^7.5.2","@storybook/addon-links":"^7.5.2","@storybook/addon-onboarding":"^1.0.8","@storybook/addon-styling":"^1.3.7","@storybook/addon-themes":"^7.5.2","@storybook/blocks":"^7.5.2","@storybook/react":"^7.5.2","@storybook/react-vite":"^7.5.2","@storybook/testing-library":"^0.2.2","@svgr/rollup":"^8.1.0","@testing-library/jest-dom":"^6.1.4","@testing-library/react":"^14.0.0","@testing-library/user-event":"^14.5.1","@types/node":"^20.8.10","@types/react":"^18.2.34","@types/react-dom":"^18.2.14","@typescript-eslint/eslint-plugin":"latest","@typescript-eslint/parser":"latest","autoprefixer":"^10.4.16","class-variance-authority":"0.7.0","clsx":"^2.0.0","eslint":"^8.52.0","eslint-config-prettier":"^9.0.0","eslint-plugin-import":"^2.29.0","eslint-plugin-jsx-a11y":"^6.8.0","eslint-plugin-prettier":"^5.0.1","eslint-plugin-react":"^7.33.2","eslint-plugin-react-hooks":"^4.6.0","eslint-plugin-react-refresh":"^0.4.4","eslint-plugin-storybook":"^0.6.15","gh-pages":"^6.0.0","jsdom":"^22.1.0","lucide-react":"^0.292.0","postcss":"^8.4.31","postcss-scss":"^4.0.9","prettier":"3.0.3","react":"^18.2.0","react-dom":"^18.2.0","regenerator-runtime":"^0.14.0","rimraf":"^5.0.5","rollup":"^4.3.0","rollup-plugin-dts":"^6.1.0","rollup-plugin-peer-deps-external":"^2.2.4","rollup-plugin-postcss":"^4.0.2","rollup-plugin-terser":"^7.0.2","storybook":"^7.5.2","tailwind-merge":"^2.0.0","tailwindcss":"^3.3.5","tailwindcss-animate":"^1.0.7","tslib":"^2.6.2","typescript":"5.2.2","vite":"^4.5.0","vite-plugin-svgr":"^4.1.0","vitest":"^0.34.6"},"packageManager":"yarn@3.6.3","_id":"@canes/shadcn-ui@1.0.0","gitHead":"da6603aceab5c98cc07fb052a348b82c981fa13a","bugs":{"url":"https://github.com/hoangtd1706/shared/issues"},"_nodeVersion":"20.18.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-rjPqEZooZF/PEnLGXpPugnSBGS0bXI/O8EPQ69iYoY5syOnHuaFch046V0374M13qvkhRNCcBpFIseu+iJTfBg==","shasum":"ae2e5d46174fd3e46dc9485a2a3813e85820efe3","tarball":"https://registry.npmjs.org/@canes/shadcn-ui/-/shadcn-ui-1.0.0.tgz","fileCount":24,"unpackedSize":43013,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDweBgNLsGbLbi1zDXvPx8hc8dJwOVFzrv0gAn5q1/2VwIhALxN7j+c9miRewMwGOcFGZVevD+/ZCYR7hewqGbi13Ts"}]},"_npmUser":{"name":"mrhoon","email":"hoangtd1706@gmail.com"},"directories":{},"maintainers":[{"name":"mrhoon","email":"hoangtd1706@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/shadcn-ui_1.0.0_1738654981219_0.03371917088726284"},"_hasShrinkwrap":false}},"time":{"created":"2025-02-04T07:43:01.124Z","1.0.0":"2025-02-04T07:43:01.443Z","modified":"2025-02-04T07:43:01.749Z"},"maintainers":[{"name":"mrhoon","email":"hoangtd1706@gmail.com"}],"description":"Boilerplate for writing React Libraries bundled with Rollup.js to commonJs and ES6 Modules and Storybookt","homepage":"https://github.com/hoangtd1706/shared.git","repository":{"type":"git","url":"git+ssh://git@github.com/hoangtd1706/shared.git"},"author":{"name":"hoangtd1706"},"bugs":{"url":"https://github.com/hoangtd1706/shared/issues"},"license":"MIT","readme":"# Shared\n\nShared is a boilerplate for writing React Libraries bundled with Rollup.js to commonJs ,ES6 Modules, Storybookt, Tailwind CSS, Shadcn/ui.\n\nThis project is a clone of [React Rollup Boilerplate](https://github.com/KaiHotz/react-rollup-boilerplate) and has been updated for Tailwind and Shadcn/ui.\n\n## Getting started\n\n```\ngit clone git@github.com:behzadam/shared.git\ncd shared\nyarn install\n```\n\n## Developing\n\nTo start the developing run :\n\n```\nyarn start\n```\n\nThis will build a version of your library, run the watcher and also run Storybook.\nTo open Storybook manually open your Browser and navigate to [http://localhost:6060](http://localhost:6060).\nStart developing your components in `src/components` folder and update the `src/index.js` file accordingly.\nAlways provide an `YourComponent.story.tsx` file, so your component will show up in Storybook.\n\nYou can refer to example `Button` component, but I think you'll get the idea.\n\n## Linting and Code formating for Typescript\n\nLinting and code formating is done via [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) using [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react) and\n[eslint-config-prettier](https://github.com/prettier/eslint-config-prettier).\nYou can modify linting rules by overriding them in the `.eslintrc.cjs` file.\n\n```\nyarn lint\n```\n\nor (if automatic fixing is possible)\n\n```\nyarn lint:fix\n```\n\n## Testing\n\nTesting is done with [Vitest](https://vitest.dev/) and [@testing-library/react](https://testing-library.com/docs/react-testing-library/intro/)\nYou can refer to `Button.test.js` as an example.\n\n```\nyarn test\n```\n\n## Publishing your library to NPM\n\nTo release your library to NPM or your private Registry, make sure you have an active account at [NPM](https://www.npmjs.com/), your `.npmrc` file is correctly setup and the registry url at publishConfig in `package.json` file is set to your repository url, then:\n\n```\nyarn release\n```\n\n## Storybook\n\nFor custom layouts, styling and more information about Storybook, please refer to [Storybook](https://storybook.js.org/basics/writing-stories/) documentation.\n\n#### Deploy Storybook to GitHub Pages\n\nMake sure the homepage url in `package.json` file is set to your githup pages url, then:\n\n```\nyarn deploy\n```\n\n## Scripts\n\n- `yarn start` : Only serves Storybook.\n- `yarn build` : Builds your library (build can be found in `dist` folder).\n- `yarn storybook:build` : Builds the static Storybook in case you want to deploy it.\n- `yarn test` : Runs the tests.\n- `yarn test:coverage`: Runs the test and shows the coverage.\n- `yarn lint` : Runs the linter, Typescript typecheck and stylelint.\n- `yarn lint:fix` : Runs the linter, Typescript typecheck and stylelint and fixes automatic fixable issues.\n- `yarn eslint`: Runs only the JavaScript linter.\n- `yarn eslint:fix`: Runs only the JavaScript linter and fixes automatic fixable issues.\n- `yarn stylelint`: Runs only the style linter.\n- `yarn stylelint:fix`: Runs only the style linter and fixes automatic fixable issues.\n- `yarn check-types`: Runs typescript type checker.\n- `yarn ci`: Runs Linting, tests and type checker all together.\n- `yarn release` : Publishes your Library on NPM or your private Registry (depending on your config in your `.npmrc` file).\n- `yarn storybook`: Same as yarn start, to serve storybook.\n- `yarn storybook:build`: Generates the build for storybook in `storybook-static` folder, that can be deployed wherever you need.\n- `yarn storybook:deploy`: Builds and deploys Storybook to GitHub Pages.\n\n## Resources\n\n### Bundler\n\n- [Rollup.js](https://rollupjs.org/guide/en)\n\n### Code Formatter\n\n- [Prettier](https://prettier.io/)\n\n### Storybook\n\n- [Storybook](https://storybook.js.org/)\n\n### Testing\n\n- [Vitest](https://vitest.dev/)\n- [@testing-library/react](https://testing-library.com/docs/react-testing-library/intro/)\n- [@testing-library/jest-dom](https://github.com/testing-library/jest-dom)\n\n### Linting\n\n- [ESLint](https://eslint.org/)\n- [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react)\n- [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier)\n- [stylelint-prettier](https://github.com/prettier/stylelint-prettier)\n- [stylelint-scss](https://github.com/kristerkari/stylelint-scss)\n\n### Compiler\n\n- [Typescript](https://www.typescriptlang.org/)\n","readmeFilename":"README.md"}