@govbr-ds/webcomponents 2.0.0-next.4 → 2.0.0-next.40

package/package.json

@@ -1,111 +1,33 @@
 {
   "name": "@govbr-ds/webcomponents",
-  "version": "2.0.0-next.4",
-  "private": false,
-  "description": "Projeto de Webcomponents baseado no GovBR-DS",
+  "version": "2.0.0-next.40",
+  "description": "Biblioteca de Web Components baseado no GovBR-DS",
   "keywords": [
     "design system",
     "govbr-ds",
-    "web components",
-    "vue"
+    "web components"
   ],
   "homepage": "https://gov.br/ds/webcomponents",
   "bugs": {
-    "url": "https://gitlab.com/govbr-ds/dev/wbc/govbr-ds-wbc/issues"
+    "url": "https://gitlab.com/govbr-ds/bibliotecas/wbc/govbr-ds-wbc/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:govbr-ds/dev/wbc/govbr-ds-wbc.git"
+    "url": "git@gitlab.com:govbr-ds/bibliotecas/wbc/govbr-ds-wbc.git"
   },
   "license": "MIT",
-  "author": "SERPRO <govbr-ds@serpro.gov.br> (http://serpro.gov.br/)",
-  "contributors": [
-    "Dataprev (https://portal3.dataprev.gov.br/)"
-  ],
-  "main": "dist/webcomponents.umd.min.js",
+  "author": "SERPRO (http://serpro.gov.br/)",
+  "main": "./dist/index.cjs.js",
+  "unpkg": "./dist/webcomponents/webcomponents.esm.js",
+  "module": "./dist/index.js",
+  "types": "./dist/types/index.d.ts",
   "files": [
-    "/dist/**/*",
-    "!/dist/*.html"
+    "dist/"
   ],
-  "scripts": {
-    "build": "vue-cli-service build --target lib --inline-vue --name webcomponents src/library/lib.js",
-    "build:storybook": "build-storybook -o public",
-    "commit": "git-cz",
-    "lint:js": "vue-cli-service lint --fix",
-    "lint:md": "markdownlint -d --fix **/*.md",
-    "prepare": "chmod +x ./node_modules/husky/lib/bin.js && husky install",
-    "storybook": "start-storybook -p 6006",
-    "test:ci": "jest --config ./jest.config.js --collectCoverage --coverageDirectory=\"./coverage\" --ci --reporters=default --reporters=jest-junit --watchAll=false",
-    "test:unit": "vue-cli-service test:unit --updateSnapshot"
-  },
-  "lint-staged": {
-    "*.md": [
-      "prettier --write",
-      "markdownlint -d --fix"
-    ],
-    "*.{js,ts,vue}": [
-      "vue-cli-service lint --fix",
-      "vue-cli-service test:unit --findRelatedTests",
-      "prettier --write"
-    ]
-  },
-  "config": {
-    "commitizen": {
-      "path": "@commitlint/cz-commitlint"
-    }
-  },
-  "dependencies": {
-    "core-js": "3.30.1",
-    "maska": "^2.1.9",
-    "vue": "3.2.47",
-    "vuex": "^4.1.0"
+  "peerDependencies": {
+    "@govbr-ds/core": "3.6.1"
   },
-  "devDependencies": {
-    "@babel/core": "7.21.8",
-    "@babel/eslint-parser": "7.21.8",
-    "@fullhuman/postcss-purgecss": "5.0.0",
-    "@fullhuman/vue-cli-plugin-purgecss": "5.0.0",
-    "@govbr-ds/commit-config": "latest",
-    "@govbr-ds/core": "3.3.1",
-    "@govbr-ds/release-config": "latest",
-    "@semantic-release/exec": "6.0.3",
-    "@storybook/addon-actions": "6.5.16",
-    "@storybook/addon-docs": "6.5.16",
-    "@storybook/addon-essentials": "6.5.16",
-    "@storybook/addon-links": "6.5.16",
-    "@storybook/addons": "6.5.16",
-    "@storybook/builder-webpack5": "6.5.16",
-    "@storybook/manager-webpack5": "6.5.16",
-    "@storybook/theming": "6.5.16",
-    "@storybook/vue3": "6.5.16",
-    "@vue/cli-plugin-babel": "5.0.8",
-    "@vue/cli-plugin-eslint": "5.0.8",
-    "@vue/cli-plugin-unit-jest": "5.0.8",
-    "@vue/cli-service": "5.0.8",
-    "@vue/compiler-sfc": "3.2.47",
-    "@vue/eslint-config-prettier": "7.1.0",
-    "@vue/test-utils": "2.3.2",
-    "@vue/vue3-jest": "27.0.0",
-    "@whitespace/storybook-addon-html": "^5.1.4",
-    "babel-loader": "^8.3.0",
-    "eslint": "8.39.0",
-    "eslint-plugin-storybook": "0.6.12",
-    "eslint-plugin-vue": "9.11.0",
-    "git-pull-run": "1.4.0",
-    "husky": "8.0.3",
-    "jest-junit": "15.0.0",
-    "lint-staged": "13.2.2",
-    "markdownlint-cli": "0.34.0",
-    "postcss": "8.4.23",
-    "prettier": "^2.8.8",
-    "react": "16.8.0 || 17.0.0",
-    "react-dom": "16.8.0 || 17.0.0",
-    "sass": "1.58.3",
-    "sass-loader": "13.2.2",
-    "semantic-release-discord": "1.2.0",
-    "storybook-version": "^0.1.1",
-    "vue-loader": "^16.8.3",
-    "vue-router": "4.1.6",
-    "vue-syntax-highlight": "^0.1.8"
-  }
-}
+  "collection": "./dist/collection/collection-manifest.json",
+  "collection:main": "./dist/collection/index.js",
+  "es2017": "./dist/esm/loader.js"
+}

package/README.md

@@ -1,158 +0,0 @@
-# Web Components GovBR-DS
-
-Nosso objetivo é disponibilizar uma biblioteca de componentes baseada no [GovBR-DS](https://gov.br/ds 'GovBR-DS') que possa ser consumida independente de frameworks ou tecnologias utilizadas nos projetos.
-
-## Demonstração
-
-Acesse nossos sites e veja nossos componentes em ação:
-
-- [Storybook - Produção](https://gov.br/ds/webcomponents/)
-- [Storybook - Desenvolvimento](https://govbr-ds.gitlab.io/wbc/govbr-ds-wbc/)
-
-## Tecnologias
-
-Esse projeto é desenvolvido usando:
-
-1. [GovBR-DS](https://gov.br/ds/ 'GovBR-DS')
-2. [Font Awesome](https://fontawesome.com/ 'Font Awesome')
-3. [Fonte Rawline](https://www.cdnfonts.com/rawline.font/ 'Fonte Rawline')
-4. [VueJS 3](https://v3.vuejs.org/ 'VueJS 3')
-5. [Storybook](https://storybook.js.org/ 'Storybook')
-6. [Jest](https://jestjs.io/ 'Jest')
-
-> Para saber mais detalhes sobre Web Components sugerimos que consulte o [MDN](https://developer.mozilla.org/pt-BR/docs/Web/Web_Components 'Web Components | MDN').
-
-## Documentações Complementares
-
-Consulte nossa a seção sobre Web Componente na nossa [Wiki](https://govbr-ds.gitlab.io/tools/wiki/hugo-cms/desenvolvimento/web-components) para obter mais informações.
-
-## Uso
-
-Existem 2 maneiras de usar nossos Web Components:
-
-- Pacote NPM
-
-```bash
-npm install --save @govbr-ds/webcomponents
-```
-
-Depois de instalada, importe a biblioteca de dentro da pasta *node_modules*:
-
-```javascript
-@import "node_modules/@govbr-ds/webcomponents/dist/webcomponents.umd.min.js"
-```
-
-- CDN
-
-```html
-<script src="https://unpkg.com/@govbr-ds/webcomponents@VERSÃO/dist/webcomponents.umd.min.js"></script>
-```
-
-> Troque **versão** pela versão do pacote que deseja
-
-**Importante**: O CDN <https://unpkg.com/> não é mantido por nossa equipe e portanto não podemos garantir um SLO. Considere importar os arquivos necessários para uma infraestrutura interna caso isso seja um impedimento para seu projeto.
-
-### Font Awesome e Fonte Rawline
-
-Nossos componentes usam a [Fonte Rawline](https://www.cdnfonts.com/rawline.font/ 'Fonte Rawline') juntamente com a [Font Awesome](https://fontawesome.com/ 'Font Awesome') padrão do DS.
-
-Consulte a documentação no site do [GovBR-DS](https://www.gov.br/ds/como-comecar/instalacao 'GovBR-DS') para mais detalhes sobre como importá-los de seus respectivos CDNs.
-
-### Exemplos de uso
-
-Disponibilizamos alguns exemplos de como usar esse projeto com algumas tecnologias. Consulte o [nosso grupo aqui no gitlab](https://gitlab.com/govbr-ds/dev/wbc 'GovBR-DS/DEV/WBC') e procure pelos projetos de 'Quickstart' para mais detalhes.
-
-## Estrutura de pastas
-
-> Vamos explicar apenas as pastas/arquivos que são importantes para o entendimento do projeto e contribuição.
-
-```markdown
-/raiz
-└───src
-│───assets
-│───library
-│ │───lib.js
-│ │───components
-│ │───mixins
-│ └───util
-└───stories
-```
-
-- **src**
-  - **assets**: pasta com arquivos estáticos
-  - **library**
-    - **lib.js**: inicializa todos os custom elements e define o que faz parte da biblioteca. É usado para fazer o build final.
-    - **components**: pasta com os componentes da biblioteca, seus testes e stories do storybook.
-    - **mixins**: mixins que são usados em vários componentes.
-    - **util**: funções criadas para facilitar ações dentro dos componentes
-  - **stories**: Arquivos com as stories gerais do storybook
-
-> Aplicação Vue é uma aplicação criada para testar rapidamente nossos componentes. Ela não é disponibilizada no build e nem disponibilizamos um site com ela.
-
-## Rodar o projeto na máquina local
-
-Clone o projeto:
-
-```bash
-git clone git@gitlab.com:govbr-ds/dev/wbc/govbr-ds-wbc.git
-
-cd govbr-ds-wbc
-
-npm install
-
-npm run storybook
-```
-
-## Documentação
-
-Nossa documentação está disponível em <https://gov.br/ds/webcomponents/>.
-
-> Para outras informações, consulte nossa [Wiki](https://gov.br/ds/wiki/desenvolvimento/web-components/).
-
-## Polyfill
-
-Acesse os seguintes links para entender mais sobre o suporte dos browsers a [Custom Elements](https://caniuse.com/custom-elementsv1) e a [Shadow Dom](https://caniuse.com/shadowdomv1).
-
-Caso os requisitos do seu projeto incluam navegadores que não suportam completamente os Web Components, adicione os [polyfills](https://www.webcomponents.org/polyfills) ao seu projeto.
-
-Para aprender com instalar, consulte a [documentação oficial](https://github.com/webcomponents/polyfills/tree/master/packages/webcomponentsjs 'Polyfills')
-
-## Contribuindo
-
-Antes de abrir um Merge Request tenha em mente algumas informações:
-
-- Esse é um projeto opensource e contribuições são bem-vindas.
-- Para facilitar a aprovação da sua contribuição, escolha um título curto, simples e explicativo para o MR, e siga os padrões da nossa [wiki](https://gov.br/ds/wiki/ 'Wiki').
-- Quer contribuir com o projeto? Confira o nosso guia [como contribuir](./CONTRIBUTING.md 'Como contribuir?').
-
-### Reportar bugs/necessidades
-
-Você pode usar as [issues](https://gitlab.com/govbr-ds/dev/wbc/govbr-ds-wbc/-/issues/new) para nos informar os problemas que tem enfrentado ao usar nossa biblioteca ou mesmo o que gostaria que fizesse parte do projeto. Por favor use o modelo que mais se encaixa na sua necessidade e preencha com o máximo de detalhes possível.
-
-Nos comprometemos a responder a todas as issues.
-
-## Commits
-
-Nesse projeto usamos um padrão para branches e commits. Por favor observe a documentação na nossa [wiki](https://gov.br/ds/wiki/ 'Wiki') para aprender sobre os nossos padrões.
-
-## Precisa de ajuda?
-
-> Por favor **não** crie issues para fazer perguntas...
-
-Use nossos canais abaixo para obter tirar suas dúvidas:
-
-- Site do GovBR-DS <http://gov.br/ds>
-
-- Web Components <https://gov.br/ds/webcomponents/>
-
-- Pelo nosso email <govbr-ds@serpro.gov.br>
-
-- Usando nosso canal no discord <https://discord.gg/U5GwPfqhUP>
-
-## Créditos
-
-Os Web Components do [GovBR-DS](https://gov.br/ds/ 'GovBR-DS') são criados pelo [SERPRO](https://www.serpro.gov.br/ 'SERPRO | Serviço Federal de Processamento de Dados') e [Dataprev](https://www.dataprev.gov.br/ 'Dataprev | Empresa de Tecnologia e Informações da Previdência') juntamente com a participação da comunidade.
-
-## Licença
-
-Nesse projeto usamos a licença MIT.