{"_id":"@droz-js/monorepo","_rev":"2-bfd21402bb0bb7f84b1257cf85dbe6b8","name":"@droz-js/monorepo","dist-tags":{"latest":"3.4.1"},"versions":{"3.4.1":{"name":"@droz-js/monorepo","version":"3.4.1","_id":"@droz-js/monorepo@3.4.1","maintainers":[{"name":"yagrrusso","email":"yagrrusso@gmail.com"},{"name":"adm-droz","email":"adm-droz@meudroz.com"},{"name":"onhate","email":"onhate@gmail.com"}],"dist":{"shasum":"15a22752e4680114bdcec581ea8a30d2a0c4c37b","tarball":"https://registry.npmjs.org/@droz-js/monorepo/-/monorepo-3.4.1.tgz","fileCount":525,"integrity":"sha512-QgCb+7UBsDI8Wav5vZ9XTNolyb8ZDfLRNW6V6v5Evyd+0eChd2aB59qWlsR/9Es20CdJaoJe7XAGtLgPANxQvg==","signatures":[{"sig":"MEYCIQDI4L6CW0C6jPvtBEe5bl3dMbUbvnQuWM08Dp8XWW2FDAIhANqAV6XvMqjfB7iFcdxDBWssXKPzK4lxy5/boKGgzL8w","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":7754589},"engines":{"node":">=14.0.0"},"gitHead":"a1c63ffbcf5d6bd87a247f19b08c327edb94c262","private":false,"scripts":{"dev":"turbo run dev --parallel","test":"cd package && npm run test","build":"turbo run build","prepare":"husky","dev:docs":"cd docs && npm run dev","dev:visu":"cd package && npm run dev","lint:docs":"eslint --fix --ext .tsx,.ts,.jsx,.js docs/","lint:visu":"eslint --fix --ext .tsx,.ts,.jsx,.js package/","build:docs":"cd docs && npm run build","build:visu":"cd package && npm run build","test:watch":"cd package && npm run test:watch","test:coverage":"cd package && npm run test:coverage","prepublishOnly":"npm run build"},"_npmUser":{"name":"yagrrusso","email":"yagrrusso@gmail.com"},"workspaces":["package","docs"],"_npmVersion":"10.2.3","description":"<p align=\"center\">   <picture>     <img alt=\"Visu\" src=\"visu.svg\" height=\"64px\" />   </picture> </p>","directories":{},"lint-staged":{"**/*.{js, jsx, ts, tsx}":["eslint --fix"]},"_nodeVersion":"18.19.0","_hasShrinkwrap":false,"packageManager":"npm@10.2.3","devDependencies":{"glob":"^10.3.10","vite":"^5.1.7","husky":"^9.0.11","react":"^18.2.0","turbo":"latest","eslint":"^8.57.0","prettier":"3.2.5","tsconfig":"*","react-dom":"^18.2.0","typescript":"^5.3.3","lint-staged":"^15.2.2","@types/react":"^18.2.63","@types/react-dom":"^18.2.20","@vitejs/plugin-react":"^4.2.1","@phosphor-icons/react":"^2.1.3","@droz-js/eslint-config":"^1.0.1","prettier-plugin-tailwindcss":"^0.5.12"},"_npmOperationalInternal":{"tmp":"tmp/monorepo_3.4.1_1713298573441_0.8580515539750684","host":"s3://npm-registry-packages"}}},"time":{"created":"2024-04-16T20:16:13.220Z","modified":"2026-04-15T22:14:19.288Z","3.4.1":"2024-04-16T20:16:13.743Z"},"description":"<p align=\"center\">   <picture>     <img alt=\"Visu\" src=\"visu.svg\" height=\"64px\" />   </picture> </p>","maintainers":[{"email":"onhate@gmail.com","name":"onhate"},{"email":"adm-droz@meudroz.com","name":"adm-droz"},{"email":"yagrrusso@gmail.com","name":"yagrrusso"},{"email":"francis@targanski.com","name":"ftarganski"},{"email":"acavalcante@meudroz.com","name":"acavalcante"}],"readme":"<p align=\"center\">\n  <picture>\n    <img alt=\"Visu\" src=\"visu.svg\" height=\"64px\" />\n  </picture>\n</p>\n\n<p align=\"center\">\n  <a href=\"https://github.com/Coaktion/Droz-Visu/actions/workflows/build-and-test.js.yml\">\n    <img src=\"https://github.com/Coaktion/Droz-Visu/actions/workflows/build-and-test.js.yml/badge.svg\" alt=\"CI/CD visu\">\n  </a>\n</p>\n\nUma biblioteca de componentes e design system Droz. Com testes e documentação para todos os componentes.\n\n## Como o projeto funciona?\n\nO projeto é um monorepo, que foi criado utilizando o [Turborepo](https://turbo.build/repo), para saber mais acesse o [Monorepo Handbook](https://turbo.build/repo/docs/handbook). O projeto conta com dois workspaces `docs` e `package`:\n\n### Docs\n\nProjeto onde são desenvolvidas as documentações dos components do Visu. Utilizando principalmente o [Storybook](https://storybook.js.org/). Os componentes documentados são baseados no último build feito na biblioteca, então é necessários que haja pelo menos um build antes de documentar os componentes.\n\n_**Importante:** Antes de criar/modificar uma story de qualquer componente **SEMPRE** construa o Visu e execute o comando `npm run install` para atualizar as dependências do Storybook (especialmente o Visu)_\n\n### Package\n\nProjeto onde são desenvolvidos os componentes e o design system da biblioteca Visu. O projeto utiliza principalmente [Vite](https://vitejs.dev), [React](https://react.dev/) e [Tailwindcss](https://tailwindcss.com/).\nO build é realizado na pasta `src/library` para os componentes e copiando os arquivos da pasta `src/theme` para o design system que consiste em um plugin do tailwindcss.\nO projeto testa os componentes utilizando [Jest](https://jestjs.io) e [React Testing Library](https://testing-library.com/docs/react-testing-library/intro).\n\n## Script\n\nAbaixo a lista dos scrips principais para a utilização do projeto.\n\n### Build\n\nPara executar o build em `docs` e `package` utilize o comando abaixo na raiz do projeto:\n\n```javascript\nnpm run build\n// npm run build:docs\n// npm run build:packages\n```\n\n### Desenvolvimento\n\nPara executar em paralelo e no modo de desenvolvimento todos os `docs` e `package` utilize o comando abaixo na raiz do projeto:\n\n```javascript\nnpm run dev\n// npm dev build:docs\n// npm dev build:packages\n```\n\n### Teste\n\nPara executar os testes da biblioteca, acesse o diretório `package` e utilize o comando abaixo:\n\n```javascript\nnpm run test\n// npm run test:watch\n// npm run test:coverage\n```\n\n## Biblioteca\n\nNa Biblioteca é publicado o conteúdo da pasta `dist` que é gerado a partir das pastas `src/library` e `src/theme`. Para realizar a publicação precisamos gerar um build da biblioteca que irá criar a pasta `dist` com essa pasta criada podemos então publicar o pacote.\n\n### Publicação NPM\n\nPara realizar a publicação no Github Packages, após ter feito todas as atualizações necessárias em uma PR separada, siga os passos abaixo.\n\n1. Abra uma nova branch chamada \"release-x.x.x\"\n1. Na nova branch rode o script scripts/versioning [`major` | `minor` | `patch`]\n1. Dê o nome pro commit de \"release: x.x.x\"\n1. Faça merge dessa branch na main\n1. Abra a branch main atualizada\n1. Em um terminal autenticado com o NPM, execute `npm publish` dentro da pasta `packages/visu` (importante) e pronto\n\n## Links úteis:\n\nAprenda mais sobre `Packages`:\n\n- [NPM Publish](https://docs.npmjs.com/cli/v9/commands/npm-publish)\n- [Vite Build Library Mode](https://docs.npmjs.com/cli/v9/commands/npm-publish)\n- [package.json Configs](https://docs.npmjs.com/cli/v9/configuring-npm/package-json)\n- [Github Packages](https://docs.github.com/en/packages/quickstart)\n\nAprenda mais sobre `Turborepo`:\n\n- [Package Installation](https://turbo.build/repo/docs/handbook/package-installation)\n- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)\n- [Caching](https://turbo.build/repo/docs/core-concepts/caching)\n- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)\n- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)\n- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)\n- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)\n\nAprenda mais sobre `Vite`:\n\n- [Início](https://vitejs.dev/guide/)\n- [CLI](https://vitejs.dev/guide/cli.html)\n- [Plugins](https://vitejs.dev/guide/using-plugins.html)\n- [Library Mode Build](https://vitejs.dev/guide/build.html#library-mode)\n\nAprenda mais sobre `React`:\n\n- [Início](https://react.dev/learn)\n- [Hooks](https://react.dev/reference/react)\n- [Built-in Components](https://react.dev/reference/react/components)\n- [Built-in APIs](https://react.dev/reference/react/apis)\n- [Directives](https://react.dev/reference/react/directives)\n- [Client APIs](https://react.dev/reference/react-dom/client)\n- [Server APIs](https://react.dev/reference/react-dom/server)\n\nAprenda mais sobre `Tailwindcss`:\n\n- [Instalação](https://tailwindcss.com/docs/installation/using-postcss)\n- [Configuração](https://tailwindcss.com/docs/configuration)\n- [Configuração do setup](https://tailwindcss.com/docs/editor-setup)\n- [Utility-first](https://tailwindcss.com/docs/utility-first)\n- [Responsive Design](https://tailwindcss.com/docs/responsive-design)\n- [Dark Mode](https://tailwindcss.com/docs/dark-mode)\n- [Plugins](https://tailwindcss.com/docs/plugins)\n\nAprenda mais sobre `Storybook`:\n\n- [Story](https://storybook.js.org/docs/react/get-started/whats-a-story)\n- [Setup](https://storybook.js.org/docs/react/get-started/setup)\n- [Addons](https://storybook.js.org/docs/react/addons/introduction)\n- [Testing](https://storybook.js.org/docs/react/writing-tests/introduction)\n- [Builders](https://storybook.js.org/docs/react/builders/overview)\n- [Controls](https://storybook.js.org/docs/react/essentials/controls)\n\nAprenda mais sobre `Testes`:\n\n- [Exemplos](https://testing-library.com/docs/react-testing-library/example-intro)\n- [API](https://testing-library.com/docs/react-testing-library/api)\n- [Cheatsheet](https://testing-library.com/docs/react-testing-library/cheatsheet)\n- [Expect](https://jestjs.io/pt-BR/docs/expect)\n\n## License\n\n[Copyright](./LICENSE)\n","readmeFilename":"README.md"}