porygon-cli v0.1.3

Porygon CLI

O que é a Porygon CLI?

A Porygon é um conjunto de comandos criados para melhorar a produtividade em projetos React e evitar a chatice de criar (ou copiar e colar) cada novo arquivo de storybook, estilos e testes na hora de criar um componente novo.

Alguns avisos:

• Esse projeto está nas fases iniciais do desenvolvimento, eventuais bugs são esperados.
• Todas as configurações são pensadas para projetos React + TypeScript projects.
• Os testes foram criados pensando em Testing Library e Jest. Essa CLI considera que essas libs já estão instaladas no seu projeto.
• A organização dos arquivos é a grouping by feature, onde a pasta de cada component contém todos os seus arquivos relacionados (estiilos, testes, storys, etc).

Como rodar a Porygon CLI?

  npx porygon-cli <component-name>

(npx está disponível a partir do npm 5.2+)

PorygonConfig.json

Ao rodar o Porygon pela primeira vez, será criado um arquivo de config que customiza algumas opções para a criação de componentes. Esse arquivo pode ser editado.

Exemplo de um porygonConfig.json:

{
  "path": "src/components/",
  "storybook": true,
  "unitTests": false
}

Gerando um novo componente

  npx porygon-cli <component-name>

Esse comando vai criar um componente e seus respectivos arquivos na pasta especificada no path ou no caminho default (src/components).

Exemplo de estrutura de arquivos default:

|-- /src
    |-- /components
        |-- /Pikachu
            |-- Pikachu.tsx
            |-- styles.ts
            |-- Pikachu.test.js
            |-- Pikachu.stories.tsx

License

Porygon CLI é um open source software e pode ser usada ou modicada por qualquer um.