@sankhyalabs/ezui NPM

Bibliteca de componentes EzUI

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.

O EzUI foi baseado no UiKit disponibilizado pela equie de UX da Sankhya, que pode ser visto aqui

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.

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: Esse comando deve ser utilizado em ambiente de desenvolvimento, ele facilita o build e o link entre os projetos ezui e react-output, executando em um só comando: o build do ezui, link do react-output e ezui, build do react-output e a disponibilização da dist do react-output no diretório correto do ezui.
npm run build

Para conhecer detalhes do projeto acesse:

@infinitebrahmanuniverse/nolb-_san @everything-registry/sub-chunk-806 movimentacao-bancaria @sankhyalabs/react-ezui @zalastax/nolb-_san

5.20.0-dev.4

2 days ago

0.0.0-feat-dev-KB-33080.0

3 days ago

0.0.0-feat-dev-KB-24906.0

3 days ago

0.0.0-hotfix-rc-KB-27703.3

10 days ago

0.0.0-hotfix-ga-KB-8888.0

14 days ago

0.0.0-bugfix-dev-KB-17130.0

13 days ago

5.19.1-rc.1

14 days ago

5.19.1

14 days ago

0.0.0-feat-dev-KB-18474.0

14 days ago

5.20.0-dev.3

13 days ago

5.20.0-dev.2

13 days ago

5.20.0-dev.1

14 days ago

0.0.0-hotfix-ga-KB-99999.0

15 days ago

0.0.0-hotfix-ga-5134744.0

15 days ago

0.0.0-feat-dev-19450.0

15 days ago

0.0.0-feat-dev-KB-19536.0

16 days ago

5.18.0-dev.4

16 days ago

5.18.0-dev.3

16 days ago

0.0.0-hotfix-rc-KB-27703.2

16 days ago

5.18.0-rc.2

17 days ago

5.18.0-dev.2

17 days ago

5.19.0

17 days ago

0.0.0-feat-dev-KB-28409.0

17 days ago

0.0.0-feat-dev-KB-15152.0

20 days ago

5.18.0-rc.1

20 days ago

5.18.0

20 days ago

5.18.0-dev.1

20 days ago

0.0.0-feat-dev-KB-31325.0

20 days ago

5.17.2

21 days ago

0.0.0-feat-dev-18332.0

22 days ago

5.17.1

22 days ago

0.0.0-hotfix-rc-KB-27703.1

22 days ago

5.17.1-dev.1

22 days ago

5.17.1-rc.1

22 days ago

0.0.0-hotfix-ga-5137918.0

24 days ago

0.0.0-hotfix-ga-5108282.0

27 days ago

0.0.0-hotfix-ga-KB-27795.0

28 days ago

5.17.0-dev.1

1 month ago

5.16.0

1 month ago

0.0.0-hotfix-ga-KB-24726.4

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

0.0.0-hotfix-ga-KB-24726.3

1 month ago

5.15.1-dev.2

1 month ago

5.15.1-rc.2

1 month ago

0.0.0-hotfix-ga-KB-15571.2

1 month ago

0.0.0-hotfix-ga-KB-22504.4

1 month ago

0.0.0-hotfix-ga-KB-24726.2

1 month ago

0.0.0-hotfix-ga-KB-24726.1

1 month ago

0.0.0-hotfix-ga-KB-22504.3

1 month ago

5.15.2

1 month ago

0.0.0-hotfix-ga-KB-24726.0

1 month ago

0.0.0-hotfix-ga-KB-22504.2

1 month ago

0.0.0-hotfix-ga-KB-15571.1

1 month ago

0.0.0-hotfix-ga-5085277.2

1 month ago

5.15.1-dev.1

1 month ago

5.15.1-rc.1

1 month ago

0.0.0-hotfix-ga-KB-15571.0

1 month ago

0.0.0-hotfix-rc-KB-27703.0

1 month ago

5.15.1

1 month ago

0.0.0-hotfix-ga-5085277.1

1 month ago

0.0.0-hotfix-ga-5085277.0

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

0.0.0-feat-dev-KB-22227.0

1 month ago

5.15.0-dev.1

1 month ago

0.0.0-hotfix-ga-KB-22504.1

1 month ago

0.0.0-hotfix-ga-KB-22504.0

1 month ago

0.0.0-hotfix-ga-KB-25174.2

2 months ago

0.0.0-hotfix-ga-KB-25174.3

2 months ago

0.0.0-hotfix-ga-KB-25174.0

2 months ago

0.0.0-hotfix-ga-KB-25174.1

2 months ago

0.0.0-feat-dev-KB-18468.3

2 months ago

0.0.0-feat-dev-KB-18468.2

2 months ago

0.0.0-hotfix-ga-KB-24722-5.0

2 months ago

0.0.0-hotfix-ga-KB-24722-2.1

2 months ago

0.0.0-hotfix-ga-KB-24722-2.0

2 months ago

0.0.0-feat-dev-KB-18468.1

2 months ago

5.14.3

2 months ago

0.0.0-hotfix-ga-KB-24722.0

2 months ago

0.0.0-hotfix-ga-KB-22238.0

2 months ago

5.14.2

2 months ago

0.0.0-feat-dev-KB-18468.0

2 months ago

5.14.1

2 months ago

0.0.0-hotfix-ga-KB-23329.1

2 months ago

5.14.0-rc.5

2 months ago

5.14.0-rc.4

2 months ago

5.14.0-rc.3

2 months ago

0.0.0-hotfix-ga-KB-18941.0

2 months ago

0.0.0-hotfix-ga-KB-23329.0

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

0.0.0-feat-dev-KB-14960.3

2 months ago

5.13.0-dev.2

2 months ago

0.0.0-feat-dev-KB-14960.2

2 months ago

5.13.0-dev.1

2 months ago

5.13.0

2 months ago

0.0.0-feat-dev-KB-14960.0

2 months ago

0.0.0-feat-dev-KB-14960.1

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

0.0.0-bugfix-rc-KB-2229.0

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

0.0.0-bugfix-dev-KB-6165.0

4 months ago

5.11.0

4 months ago

0.0.0-bugfix-dev-KB-08202.0

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

0.0.0-feat-dev-kb-41583.0

4 months ago

5.11.0-dev.1

4 months ago

5.11.0-dev.2

4 months ago

5.11.0-rc.1

4 months ago

0.0.0-feat-dev-kb-4158.0

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

0.0.0-hotfix-ga-KB-5491.5

5 months ago

5.10.6

5 months ago

0.0.0-hotfix-ga-KB-5491.4

5 months ago

0.0.0-hotfix-ga-KB-5491.2

5 months ago

0.0.0-hotfix-ga-KB-5491.3

5 months ago

5.10.5

5 months ago

0.0.0-hotfix-ga-KB-5491.0

5 months ago

0.0.0-hotfix-ga-KB-5491.1

5 months ago

0.0.0-hotfix-ga-KB-999999

5 months ago

8 months ago

9 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

9 months ago

6 months ago

6 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

10 months ago

10 months ago

10 months ago

9 months ago

6 months ago

7 months ago

8 months ago

8 months ago

10 months ago

10 months ago

7 months ago

7 months ago

8 months ago

8 months ago

8 months ago

8 months ago

5 months ago

5 months ago

6 months ago

6 months ago

6 months ago

10 months ago

10 months ago

8 months ago

7 months ago

6 months ago

8 months ago

10 months ago

10 months ago

10 months ago

9 months ago

6 months ago

6 months ago

6 months ago

8 months ago

10 months ago

10 months ago

6 months ago

9 months ago

9 months ago

9 months ago

10 months ago

10 months ago

9 months ago

9 months ago

9 months ago

6 months ago

7 months ago

7 months ago

9 months ago

10 months ago

9 months ago

9 months ago

9 months ago

9 months ago

6 months ago

12 months ago

11 months ago

12 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

11 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago