@pismo/bolt
    TypeScript icon, indicating that this package has built-in type declarations

    3.21.0 • Public • Published
    Bolt

    Bolt é um conjunto de estilos e componentes para aplicações front-end que faz parte do design system da Pismo.



    Instalação

    npm install @pismo/bolt

    Uso

    import '@pismo/bolt/dist/css/bolt-css.css'
    import {Sidebar} from '@pismo/bolt'

    Devido ao tamanho da biblioteca css adicione o plugin postcss-purge conforme descrito abaixo:

    npm i @fullhuman/postcss-purgecss -D
    
    /* package.json */
    "scripts": {
     "postbuild": "purgecss --css build/static/css/*.css --content build/index.html build/static/js/*.js --output build/static/css"
    }

    substitua o build/static pela pasta de build do seu projeto

    Acesse a documentação para mais detalhes da utilização de cada componente


    Desenvolvimento

    Após clonar o projeto, crie uma branch à partir da master e faça checkout.

    Após certificar que está na branch de trabalho execute o comando a seguir para baixar as dependencias do projeto:

    yarn

    O componentes estão separados por pastas dentro da pasta src. Cada pasta de componente deve conter: ou um arquivo .css, ou um arquivo .ts, ou ambos e um arquivo .mdx para a documentação.

    O processo de desenvolvimento é feito sobre a documentação com docz. Para executar a documentação em modo de desenvolvimento rode o comando no terminal:

    yarn docz:dev

    Para iniciar o desenvolvimento, vamos rodar o build do css e do typescript em modo watch. Para isso execute o comando a seguir em outro terminal:

    yarn dev


    Documentação

    Após a conclusão do desenvolvimento, o componente deve ser totalmente documentado. A documentação é feita utilizando mdx com base em React.


    Testes

    Os testes são no formato e2e, e é executado em cima do docz e cypress. Para rodar um teste, monte o componente no formato mdx na pasta __test__. Escreva o teste na pasta cypress/integration. Para executar em modo de desenvolvimento rode o comando em um terminal:

    yarn docz:test

    Em outro terminal rode o comando:

    yarn cy:open


    Commit

    Para criar um commit execute o comando:

    git commit

    Esse comando vai:

    • buildar o projeto
    • formatar todos os arquivos
    • adicionar todos os arquivos adicionais ao stage
    • rodar os testes

    Se os testes estiverem passando, em seguida será apresentado um menu para guiar no conventional commit.


    Release

    O release deve ser feito na branch master após a aprovação da PR. Para gerar o release rode o comando:

    yarn release

    Este comando vai mostrar um menu com opções para subir a versão do projeto, após a escolha serão executadas as tarefas a seguir de forma automatizada:

    • sobe a versão no package.json
    • cria o changelog de forma automatizada
    • cria o commit
    • cria a tag da versão

    Obs.: o push deve ser feito de forma manual


    Publish

    Após usbir a tag, deve ser criado a release no github e a plublicação no npm.

    Keywords

    none

    Install

    npm i @pismo/bolt

    DownloadsWeekly Downloads

    49

    Version

    3.21.0

    License

    ISC

    Unpacked Size

    6.05 MB

    Total Files

    9

    Last publish

    Collaborators

    • henrique.nunes
    • davi.firmino
    • amandasantos
    • anneke.knox
    • wkerswell-pismo
    • thiagofribeiro
    • danibinatti
    • vinicius_vieira
    • abraaobueno
    • dmarinss
    • rodribeze
    • rmuliterno
    • victorwpbastos