Vá para a documentação Alpine para a maioria das coisas: Alpine Docs
Você está convidado a enviar atualizações aos documentos enviando um PR para este repositório. Os documentos estão localizados no diretório /packages/docs
.
Fique aqui para obter informações relacionadas às contribuições.
Procurando documentos V2? aqui estão eles
npm install
e npm run build
/packages/alpinejs/dist/cdn.js
de uma tag <script>
em uma página da web e pronto! Você pode instalar tudo com: npm install
no diretório raiz deste repositório após cloná-lo localmente.
Este repositório é um "mono-repo" que usa espaços de trabalho npm para gerenciar os pacotes. Cada pacote possui sua própria pasta no diretório /packages
.
Em vez de ter que executar compilações separadas para cada pacote, todos os pacotes configuráveis são tratados com o mesmo comando: npm run build
Aqui está uma breve visão de cada pacote neste repositório:
Pacote | Descrição |
---|---|
alpine js | O principal repositório Alpine com todo o núcleo do Alpine |
colapso | Um plugin para expandir e recolher elementos usando animações suaves |
csp | Um repositório para fornecer uma versão "segura para CSP" do Alpine |
documentos | A documentação Alpina |
foco | Um plugin que permite gerenciar o foco dentro de um elemento |
história | Um plug-in para vincular dados a parâmetros de string de consulta usando a API de histórico (o nome provavelmente mudará) |
cruzar | Um plugin para acionar expressões JS com base em elementos que se cruzam com a janela de visualização |
máscara | Um plugin para formatar automaticamente um campo de entrada de texto conforme o usuário digita |
metamorfose | Um plugin para transformar HTML (como morphdom) dentro da página de forma inteligente |
persistir | Um plug-in para persistir o estado Alpine durante o carregamento de páginas |
Os arquivos JS compilados (como resultado da execução de npm run [build/watch]
) a serem incluídos como uma tag <script>
, por exemplo, são armazenados no diretório packages/[package]/dist
de cada pacote.
Cada pacote deve ter pelo menos: uma compilação "cdn" que seja auto-inicializada e possa ser incluída usando o atributo src
em uma tag <script defer>
e um module.[esm/cjs].js
que seja usado para importação como um módulo JS (cjs para nó, esm para todo o resto).
O pacote do Alpine V3 é feito exclusivamente pela ESBuild. Toda a configuração dessas compilações é armazenada no arquivo scripts/build.js
.
Existem 2 ferramentas de teste diferentes usadas neste repositório: Cypress (para testes de integração) e Jest (para testes unitários).
Todos os testes são armazenados dentro da pasta /tests
em /tests/cypress
e /tests/jest
.
Você pode executar ambos na linha de comando usando: npm run test
Se você deseja apenas executar o cypress e abrir sua interface de usuário (recomendado durante o desenvolvimento), você pode executar: npm run cypress
Se desejar executar apenas testes Jest, você pode executar npm run jest
como testes normais e específicos de destino. Você pode especificar opções de configuração de linha de comando para encaminhar para o comando jest com --
assim: npm run jest -- --watch