@sankhyalabs/ezui 1.1.4 → 1.1.8

package/README.md

@@ -1,72 +1,72 @@
-# Bibliteca de componentes EzUI
-
-[![Build status](https://git.sankhya.com.br/sankhyalabs/ez-ui/badges/master/pipeline.svg)](https://git.sankhya.com.br/sankhyalabs/ez-ui/-/commits/master)
-
-Esse projeto é constituido por um monorepo com a seguinte hierarquia.
-
-```
---ez-ui
-    -- package.json
-    -- .storybook
-    -- .storybook-dev
-    -- src/components
-        -- component1
-        -- component2
-    -- .gitlab-ci.yml
-```
-
-Observe que na raiz o ez-ui temos um packege.json que define as configurações de sotrybook para todos os componentes filhos dentro da hierarquia. 
-Cada subpasta (component1, component1) são componentes [Stencil](https://stenciljs.com/).
-
-#### O EzUI foi baseado no UiKit disponibilizado pela equie de UX da Sankhya, que pode ser visto [aqui](https://xd.adobe.com/view/d45d91bf-f5a8-4814-899f-e781732807d1-810e/grid)
-
-## Executando o projeto
-Para iniciar o projeto, basta ir até a pasta do componente que deseja testar (ex: ez-ui/component1), e executar o comando: ``npm install && npm run dev``
-Este procedimento irá iniciar um servidor do storybook para testar o componente. A porta que o servidor estará sendo executado é apresentada no console ao final do comando.
-
-## Padrão de commit e merge request:
-Hoje estamos utilizando o padrão de semantic release baseado no [angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
-* A sintáxe pode ser observada logo abaixo:
-```
-<type>(<scope>): <short summary>
-  │       │             │
-  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
-  │       │
-  │       └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core|
-  │                          elements|forms|http|language-service|localize|platform-browser|
-  │                          platform-browser-dynamic|platform-server|router|service-worker|
-  │                          upgrade|zone.js|packaging|changelog|dev-infra|docs-infra|migrations|
-  │                          ngcc|ve
-  │
-  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test
-```
-
- - Na solicitação de merge request deve ter um titulo com o seguinte padrão: SKA-111 - Titulo  sugestivo da minha modificação, onde, SKA-111 é id do card do jira.
-
-## Fontes notáveis
-
-- **ez-ui/.storybook/***: Nessa pasta temos arquivos de configuração do storybook. Essa pasta é utilizada em ambiente de produção.
-    * **ez-ui/.storybook/preview-head.html**: Esse arquivo é responsavél por fazer o import de módulos dos webcomponents e dos styles globais da aplicação. Esse arquivo é utilizado em ambiente de produção. 
-- **ez-ui/.storybook-dev/***: Nessa pasta temos arquivos de configuração do storybook. Prém essa pasta é utilizada apenas em ambiente de desenvolvimento.
-    * **ez-ui/.storybook-dev/preview-head.html**: Esse arquivo é responsavél por fazer o import de módulos dos webcomponents e dos styles globais da aplicação apenas em ambiente de desenvolviemento. **É aqui que devemos incluir os scripts de novos componentes para serem apresentados no storybook.** 
-- **ez-ui/.diststorybook**: Esse diretório é gerado automáticamente pelo ``Gulp`` no momento que executamos o comando ``npm run dev`` na pasta de um componente. É nesse diretório que temos os arquivos estáticos utilizados pelo storybook. O ``ez-ui/.storybook-dev/preview-head.html`` mapeia os modulos de componentes a partir desse diretório. Nele também podem ser encontrados arquivos .CSS(temas) globais da aplicação.
-- **ez-ui/.gitlab-ci.yml**: Esse é o arquivo responsavél pelo pipeline do projeto, nele você vai encontrar:
-    *  Definição de stages: Por conta da depêndência entre projetos, a ordem com que a publicação dos componentes é feita no NPM é importante, para isso definimos stages para cada componente, e esses são utilizados no job de deploy para que seja respeitada essa ordem de publicação.
-    *  Implementação dos jobs: build, test, deploy e storybook.
-
-## Comandos NPM
-- `npm run dev`: Esse comando foi criado com o intuito de facilitar a criação de novos componentes, ele executa em paralelo três comandos, sendo eles: storybook, build.watch e gulp. Ele tem como principal objetivo subir um servidor do sotrybook e monitorar alterações nos componentes, quando as alterações acontecerem, automanticamente o pagina do sotrybook é atualizada.
-- `npm run storybook`: Esse comando inicia um servidor do storybook, com os seguintes parâmetros: .storybook-dev: pasta onde estão as configurações do storybook, e .diststorybook: pasta onde estão os arquivos estáticos utilizados pelo storybook.
-- `npm run build.watch`: Esse comando tem o papel de iniciar o build dos componentes e monitorar alterações nos mesmo, caso ocorra alguma, o build dos componentes é executado e os arquivos são colocados na pasta /dist.
-- `npm run gulp`: Utilizamos o gulp para automatizar as tarefas de desenvolvimento no projeto, essa task tem como principal tarefa a de monitorar alterações na pasta /dist e realizar a cópia dos arquivos para a pasta /.diststorybook. No Gulp file temos as seguintes tasks:
-    *  `watch`: Task que monitora alterações no diretório /dist fazendo a cópia dos mesmos para a pasta .diststorybook/
-    *  `watch-global-css`: Monitora depedência @sankhyalabs/ez-design e realiza a cópia dos arquivos pra a pasta .diststorybook/themes/
-    *  `css-docs`: Monitora arquivos de CSS e SASS do projeto, quando houver alterações no mesmo é gerada a documentação referente a temas.
-- `npm run link`
-- `npm run build`
-
-
-## Para conhecer detalhes do projeto acesse:
-- [Olá EZUi](https://git.sankhya.com.br/sankhyalabs/ez-ui/-/wikis/Ol%C3%A1-EzUI)
-- [Diretrizes de codificação](https://git.sankhya.com.br/sankhyalabs/ez-ui/-/wikis/Diretrizes-de-codifica%C3%A7%C3%A3o)
-- [Diretrizes de componentização](https://git.sankhya.com.br/sankhyalabs/ez-ui/-/wikis/Diretrizes-de-componentiza%C3%A7%C3%A3o)
+# Bibliteca de componentes EzUI
+
+[![Build status](https://git.sankhya.com.br/sankhyalabs/ez-ui/badges/master/pipeline.svg)](https://git.sankhya.com.br/sankhyalabs/ez-ui/-/commits/master)
+
+Esse projeto é constituido por um monorepo com a seguinte hierarquia.
+
+```
+--ez-ui
+    -- package.json
+    -- .storybook
+    -- .storybook-dev
+    -- src/components
+        -- component1
+        -- component2
+    -- .gitlab-ci.yml
+```
+
+Observe que na raiz o ez-ui temos um packege.json que define as configurações de sotrybook para todos os componentes filhos dentro da hierarquia. 
+Cada subpasta (component1, component1) são componentes [Stencil](https://stenciljs.com/).
+
+#### O EzUI foi baseado no UiKit disponibilizado pela equie de UX da Sankhya, que pode ser visto [aqui](https://xd.adobe.com/view/d45d91bf-f5a8-4814-899f-e781732807d1-810e/grid)
+
+## Executando o projeto
+Para iniciar o projeto, basta ir até a pasta do componente que deseja testar (ex: ez-ui/component1), e executar o comando: ``npm install && npm run dev``
+Este procedimento irá iniciar um servidor do storybook para testar o componente. A porta que o servidor estará sendo executado é apresentada no console ao final do comando.
+
+## Padrão de commit e merge request:
+Hoje estamos utilizando o padrão de semantic release baseado no [angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
+* A sintáxe pode ser observada logo abaixo:
+```
+<type>(<scope>): <short summary>
+  │       │             │
+  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
+  │       │
+  │       └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core|
+  │                          elements|forms|http|language-service|localize|platform-browser|
+  │                          platform-browser-dynamic|platform-server|router|service-worker|
+  │                          upgrade|zone.js|packaging|changelog|dev-infra|docs-infra|migrations|
+  │                          ngcc|ve
+  │
+  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test
+```
+
+ - Na solicitação de merge request deve ter um titulo com o seguinte padrão: SKA-111 - Titulo  sugestivo da minha modificação, onde, SKA-111 é id do card do jira.
+
+## Fontes notáveis
+
+- **ez-ui/.storybook/***: Nessa pasta temos arquivos de configuração do storybook. Essa pasta é utilizada em ambiente de produção.
+    * **ez-ui/.storybook/preview-head.html**: Esse arquivo é responsavél por fazer o import de módulos dos webcomponents e dos styles globais da aplicação. Esse arquivo é utilizado em ambiente de produção. 
+- **ez-ui/.storybook-dev/***: Nessa pasta temos arquivos de configuração do storybook. Prém essa pasta é utilizada apenas em ambiente de desenvolvimento.
+    * **ez-ui/.storybook-dev/preview-head.html**: Esse arquivo é responsavél por fazer o import de módulos dos webcomponents e dos styles globais da aplicação apenas em ambiente de desenvolviemento. **É aqui que devemos incluir os scripts de novos componentes para serem apresentados no storybook.** 
+- **ez-ui/.diststorybook**: Esse diretório é gerado automáticamente pelo ``Gulp`` no momento que executamos o comando ``npm run dev`` na pasta de um componente. É nesse diretório que temos os arquivos estáticos utilizados pelo storybook. O ``ez-ui/.storybook-dev/preview-head.html`` mapeia os modulos de componentes a partir desse diretório. Nele também podem ser encontrados arquivos .CSS(temas) globais da aplicação.
+- **ez-ui/.gitlab-ci.yml**: Esse é o arquivo responsavél pelo pipeline do projeto, nele você vai encontrar:
+    *  Definição de stages: Por conta da depêndência entre projetos, a ordem com que a publicação dos componentes é feita no NPM é importante, para isso definimos stages para cada componente, e esses são utilizados no job de deploy para que seja respeitada essa ordem de publicação.
+    *  Implementação dos jobs: build, test, deploy e storybook.
+
+## Comandos NPM
+- `npm run dev`: Esse comando foi criado com o intuito de facilitar a criação de novos componentes, ele executa em paralelo três comandos, sendo eles: storybook, build.watch e gulp. Ele tem como principal objetivo subir um servidor do sotrybook e monitorar alterações nos componentes, quando as alterações acontecerem, automanticamente o pagina do sotrybook é atualizada.
+- `npm run storybook`: Esse comando inicia um servidor do storybook, com os seguintes parâmetros: .storybook-dev: pasta onde estão as configurações do storybook, e .diststorybook: pasta onde estão os arquivos estáticos utilizados pelo storybook.
+- `npm run build.watch`: Esse comando tem o papel de iniciar o build dos componentes e monitorar alterações nos mesmo, caso ocorra alguma, o build dos componentes é executado e os arquivos são colocados na pasta /dist.
+- `npm run gulp`: Utilizamos o gulp para automatizar as tarefas de desenvolvimento no projeto, essa task tem como principal tarefa a de monitorar alterações na pasta /dist e realizar a cópia dos arquivos para a pasta /.diststorybook. No Gulp file temos as seguintes tasks:
+    *  `watch`: Task que monitora alterações no diretório /dist fazendo a cópia dos mesmos para a pasta .diststorybook/
+    *  `watch-global-css`: Monitora depedência @sankhyalabs/ez-design e realiza a cópia dos arquivos pra a pasta .diststorybook/themes/
+    *  `css-docs`: Monitora arquivos de CSS e SASS do projeto, quando houver alterações no mesmo é gerada a documentação referente a temas.
+- `npm run link`
+- `npm run build`
+
+
+## Para conhecer detalhes do projeto acesse:
+- [Olá EZUi](https://git.sankhya.com.br/sankhyalabs/ez-ui/-/wikis/Ol%C3%A1-EzUI)
+- [Diretrizes de codificação](https://git.sankhya.com.br/sankhyalabs/ez-ui/-/wikis/Diretrizes-de-codifica%C3%A7%C3%A3o)
+- [Diretrizes de componentização](https://git.sankhya.com.br/sankhyalabs/ez-ui/-/wikis/Diretrizes-de-componentiza%C3%A7%C3%A3o)