Reconstruímos os sites do Flutter com Dart e Jaspr
Entenda por que e como a equipe do Flutter reconstruiu sua presença na web com Dart e Jaspr.
Apesar de o Dart ter começado como uma linguagem web e de ser usado todos os dias para criar apps em várias plataformas, incluindo a web, nossos próprios sites (dart.dev, flutter.dev, docs.flutter.dev) dependiam de uma mistura fragmentada de ferramentas que não eram baseadas em Dart. Isso finalmente mudou. Migramos os três sites para usar o Jaspr, um framework de código aberto para criar sites com Dart.
O resultado é uma stack unificada, com uma experiência de desenvolvimento consistente, em que contribuir exige apenas Dart. Se você tem curiosidade sobre criar experiências web com Dart além dos apps web padrão do Flutter, este post explora o que motivou nossa migração e como o Dart e o Jaspr tornaram tudo isso possível.
Uma stack técnica fragmentada e pouco familiar
Embora a configuração anterior dos nossos sites funcionasse, as implementações eram fragmentadas e exigiam cada vez mais esforço para atualizá-los de acordo com nossas necessidades em evolução. Os sites de documentação eram construídos com o Eleventy, um gerador de sites estáticos baseado em Node.js. Enquanto isso, o flutter.dev tinha uma configuração completamente separada, alimentada pelo Wagtail, um CMS construído em Python e Django.
Essa fragmentação significava que qualquer pessoa que quisesse contribuir ou manter nossos sites precisava de experiência e ferramentas adicionais fora do ecossistema Dart: ferramentas de Node.js para um conjunto de sites, Python para outro. Embora parte da infraestrutura ao redor e alguns componentes interativos já fossem construídos com Dart, os ecossistemas separados limitavam o compartilhamento de código, aumentavam bastante a barreira de configuração e de contribuição e ficavam cada vez mais complicados.
Queríamos mudar isso. Queríamos uma stack única e unificada, construída com a linguagem e as ferramentas que nossa equipe e nossa comunidade já conhecem. Também tínhamos ambições e necessidades crescentes de interatividade nos nossos sites, desde exemplos de código mais ricos até quizzes para tutoriais. Nossas configurações anteriores faziam de cada novo elemento interativo uma batalha árdua, muitas vezes exigindo lógica imperativa de DOM feita sob medida.
Encontrando uma solução unificada no Jaspr
O Jaspr é um framework web versátil em Dart que oferece suporte a renderização no cliente, renderização no servidor e geração de sites estáticos. Além de ser um framework web tradicional baseado em DOM (com HTML e CSS) e escrito na linguagem que já conhecemos, o Jaspr se destacou por alguns motivos:
Habilidades do Flutter se transferem diretamente. O framework Jaspr e o seu modelo de componentes foram projetados para parecerem naturais e familiares para qualquer desenvolvedor Flutter, ao mesmo tempo que são compatíveis com o modelo DOM da web. Se você já escreveu um widget Flutter, pode ler isto:
class FeatureCard extends StatelessComponent {
const FeatureCard({
required this.title,
required this.description,
super.key,
});
final String title;
final String description;
@override
Component build(BuildContext context) {
return div(classes: 'feature-card', [
h3([.text(title)]),
p([.text(description)]),
]);
}
}
Com o Jaspr, colaboradores podem aplicar diretamente a experiência em Dart e Flutter que já têm a uma nova plataforma, reduzindo significativamente a barreira de entrada para membros da equipe e da comunidade que querem melhorar nossa documentação e nossos sites.
Suporte integrado à hidratação parcial. Um dos principais motivos para essa exploração e migração foi tornar mais fácil construir e integrar experiências interativas em nossos sites. O suporte nativo do Jaspr à hidratação parcial permite que cada página seja pré-renderizada como HTML estático, e a lógica do lado do cliente é anexada apenas aos componentes que precisam dela. Isso é ideal para sites como o nosso, em que a maior parte do conteúdo é estática e só pequenos trechos precisam de interatividade, garantindo carregamento rápido das páginas e um bom SEO.
Jaspr Content para sites orientados a Markdown. O Jaspr também oferece o Jaspr Content, um pacote que dá suporte à criação rápida de sites orientados a conteúdo. Ele traz funcionalidades suficientes prontas para uso para montar um site baseado em Markdown em poucos minutos, além de ser fácil de expandir e personalizar amplamente. Essa funcionalidade integrada nos economizou um tempo considerável, enquanto a personalização nos permitiu manter nossas funcionalidades e práticas de conteúdo originais intactas.
O que ganhamos
A migração trouxe todos os benefícios que imaginávamos e mais, tanto para os sites em si quanto para a experiência de contribuição.
Uma toolchain única e unificada. Como tudo é escrito em Dart, você precisa de apenas um SDK para contribuir, e ainda ganhamos acesso às ferramentas poderosas e unificadas do Dart. Podemos gerenciar todas as dependências com
dart pub, formatar o código com dart format, analisá-lo com dart analyze e testá-lo com
dart test. Gerenciar o site agora exige apenas um conjunto de ferramentas para conhecer, um conjunto de convenções para seguir e um ecossistema para acompanhar, e é aquele com o qual já estamos mais familiarizados.
Uma stack que nossos colaboradores já conhecem. Nossos sites têm muitos colaboradores, de engenheiros a redatores técnicos e membros apaixonados da comunidade. Queremos que todos possam contribuir, mas a configuração fragmentada era complexa e pouco familiar para a maioria. Agora os sites são implementados como projetos Dart padrão, e quem conhece Dart já tem tudo o que precisa. Esperamos que isso reduza a barreira para membros da equipe e da comunidade que querem ajudar a melhorar a documentação do Flutter e do Dart.
Mudou menos do que você imagina. Como o Jaspr Content já oferece a maior parte do que precisávamos prontamente, como suporte a templates, Markdown e carregamento de dados, nosso fluxo de conteúdo e de escrita quase não precisou mudar. Nem nossos estilos, pois já usávamos o Sass, uma linguagem de extensão para CSS, que na verdade é implementada em Dart e, por isso, exige uma configuração ainda mais simples do que a que tínhamos antes.
A migração colaborativa
No geral, a migração do site para o Jaspr e o Jaspr Content correu bem, mas, claro, houve alguns desafios no caminho. Ocasionalmente encontramos problemas, bem como oportunidades de melhoria, tanto nas ferramentas web do Dart quanto no próprio Jaspr.
O que tornou a migração possível foi o Kilian, criador e mantenedor do Jaspr. Além de criar o Jaspr, ele nos apoiou durante toda a migração. Ele migrou componentes como provas de conceito iniciais, respondeu a issues, lançou correções, melhorou a experiência do desenvolvedor e até construiu o Jaspr Content tendo os nossos sites como caso de uso principal. Para apoiar esse esforço contínuo e formalizar a colaboração, fizemos parceria com o Kilian e a consultoria dele, Netlight, para nos ajudar a migrar o restante da nossa presença web e continuar investindo diretamente no Jaspr. Foi um processo genuinamente colaborativo. Tanto nossos sites quanto o Jaspr cresceram como resultado.
No ecossistema do Dart e do Flutter, a comunidade é tudo, e o que o Kilian ofereceu à comunidade com o Jaspr é um ótimo exemplo disso. O Jaspr se mostrou um framework web poderoso e moderno, bem mantido, responsivo a feedbacks e pronto para você experimentar. Obrigado, Kilian!
Para ouvir a perspectiva do Kilian sobre construir e manter o framework, confira o artigo dele: Jaspr: Por que desenvolvimento web em Dart pode ser uma boa ideia.
Dart e Jaspr crescendo juntos
Um dos aspectos mais gratificantes de construir sobre uma stack totalmente em Dart é que as melhorias na linguagem Dart e nas ferramentas ao redor beneficiam tudo. Não apenas seus apps Flutter, mas também seus sites. Aqui estão alguns recursos recentes do Dart que impactaram e melhoraram diretamente a experiência de construir com o Jaspr.
Dot shorthands deixam as árvores de componentes mais limpas. O Dart 3.10 introduziu suporte à sintaxe de dot shorthand
que permite omitir o nome do tipo em acessos a membros estáticos quando eles podem ser inferidos pelo contexto. O Kilian aproveitou isso para consolidar vários construtores de componentes na classe
Component e projetá-los para funcionar naturalmente com a nova sintaxe:
Component build(BuildContext context) => const div([
// After the API changes:
h1([Component.text('Dash says hi!')]),
Component.fragment([
Component.text('First element'),
Component.text('Second element'),
]),
Component.empty(),
// With dot shorthands:
h1([.text('Dash says hi!')]),
.fragment([
.text('First element'),
.text('Second element'),
]),
.empty(),
]);
O resultado foi uma API mais consistente, com melhor descoberta e uma sintaxe concisa que ainda funciona em contextos constantes. Melhor de tudo, a CLI do Jaspr vem com um comando
jaspr migrate que cuida automaticamente da migração para a nova API, bem como de outras mudanças.
Elementos de coleção null-aware simplificam a renderização condicional. O Dart 3.8 adicionou suporte a elementos de coleção null-aware, oferecendo uma sintaxe limpa para incluir condicionalmente valores não nulos em coleções. No código Jaspr, em que você frequentemente compõe listas de componentes filhos, eles oferecem uma forma elegante de lidar com elementos de UI condicionais:
Component build(BuildContext context) => div(classes: 'header', [
h1([.text('Welcome to Flutter!')]),
// Before null-aware collection elements:
if (eventBanner != null) eventBanner!,
// With a null-aware collection element:
?eventBanner,
]);
Chega de verificações verbosas de if e de asserções de não nulo poluindo suas árvores de componentes.
Interop com JS moderno e leve e compilação para WebAssembly. Para possibilitar acesso eficiente às APIs web modernas e a compilação para WebAssembly, o Dart 3.3 introduziu novas bibliotecas de
interop com JS e também package:web. O Jaspr migrou e passou a dar suporte rapidamente às novas APIs, garantindo que os desenvolvedores do Jaspr pudessem se beneficiar dos novos recursos e criar apps Dart modernos. Com base nisso, o Jaspr oferece suporte experimental à compilação para WebAssembly quando executado no cliente. Aliás, o dart.dev já usa e se beneficia desse suporte em navegadores compatíveis.
Um plugin de analyzer útil e integrado. Por um tempo, o Jaspr teve um pacote de lints útil construído sobre o
package:custom_lint, ajudando os desenvolvedores a escrever código Jaspr idiomático e correto. Com o lançamento do suporte oficial a plugins de analyzer no Dart 3.10, o Jaspr migrou para adotar o recurso. O plugin é um ótimo exemplo do que é possível, oferecendo diagnósticos específicos do Jaspr e assists de código. Por exemplo, ele consegue converter entre tipos de componentes ou envolver rapidamente um componente com outro, de forma semelhante aos assists que você já deve conhecer no Flutter.
Nenhum desses recursos foi criado especificamente para o Jaspr. Eles são melhorias na linguagem e nas ferramentas do Dart que beneficiam todo o ecossistema, não apenas o Flutter. Em alguns casos, o Jaspr pôde aproveitar imediatamente, enquanto outros exigiram mudanças no framework feitas pelo Kilian e colaboradores para desbloquear seu potencial. Em ambos os casos, fica claro que o Dart continua evoluindo e que essa evolução segue abrindo melhorias e possibilidades para tudo o que é construído com ele, incluindo o Jaspr e o Flutter.
O que vem a seguir e como começar
Ainda não terminamos. Agora que nossos sites compartilham essa nova stack técnica, podemos começar a compartilhar mais código, criar novos recursos interativos e continuar melhorando a experiência de desenvolvimento web com Dart. Também estamos migrando os blogs do Dart e do Flutter do Medium para serem hospedados diretamente nos nossos sites com Jaspr. Você poderá ler este post por lá em breve, esperamos.
Se você é desenvolvedor Dart ou Flutter e tem curiosidade sobre criar sites com as habilidades que já possui, nunca houve um momento melhor para experimentar. O Jaspr é uma ótima opção para sites com muito conteúdo, como landing pages e documentação. Ele pode até integrar-se naturalmente aos seus apps web Flutter. Experimente agora no playground online do Jaspr (que também foi feito com Jaspr!) ou seguindo o quickstart do Jaspr.
Ou, se você tem interesse em contribuir com os sites de documentação do Flutter ou do Dart, a barreira de entrada acaba de ficar bem menor. Agora, com o Jaspr, tudo o que você precisa é de Dart.