@liferay-react/boilerplate-modulo

CLI para geração de boilerplates de módulos React para Liferay.

Acesse o repositório no GitHub

Este pacote fornece uma interface de linha de comando (CLI) fácil de usar para criar novos módulos React compatíveis com o Liferay, já configurados com as melhores práticas, suporte a SASS, e compatibilidade com diferentes versões do Java.

🚀 Como usar

Você pode executar o gerador diretamente usando npx:

npx @liferay-react/boilerplate-modulo

Ou instalar globalmente:

npm install -g @liferay-react/boilerplate-modulo
create-module-boilerplate

🛠️ O que ele faz?

O gerador irá guiá-lo através de uma série de perguntas para configurar seu novo projeto:

1. Nome do Projeto: Define o nome do diretório e do portlet.
2. Caminho do Liferay: Localização do seu bundle Liferay (para deploy automático).
3. Categoria do Portlet: Onde o portlet aparecerá no menu de widgets do Liferay.
4. Shared Bundle: Configure se o projeto usará um bundle compartilhado de dependências (como o @liferay-react/boilerplate-shared).
5. Versão do Java: Ajusta automaticamente as importações de jakarta.* para javax.* se você estiver usando uma versão do Java anterior à 21.

✨ Funcionalidades

• React Ready: Configurado com Babel para suporte total a React e JSX.
• Liferay NPM Bundler: Integração completa com o bundler oficial do Liferay.
• Suporte a Estilos: Suporte nativo para CSS e SASS/SCSS.
• Internacionalização: Estrutura de Language.properties pronta para uso.
• Configuração Dinâmica: Gera arquivos .npmbundlerrc, .npmbuildrc e package.json baseados nas suas respostas.
• Java 21+ Ready: Já preparado para a transição do ecossistema Java (Jakarta EE), com fallback inteligente.

📁 Estrutura do Projeto Gerado

meu-modulo/
├── assets/             # Arquivos estáticos e CSS
├── features/           # Configurações do Liferay (localization, configuration.json)
├── src/                # Código fonte React
├── .babelrc           # Configuração do Babel
├── .npmbuildrc        # Configurações de build do Liferay
├── .npmbundlerrc      # Configurações do Bundler
└── package.json       # Scripts e dependências

📜 Scripts Disponíveis

No projeto gerado, você terá os seguintes comandos:

• npm run build: Compila o código fonte e gera o bundle.
• npm run deploy: Compila e faz o deploy automático para o seu bundle Liferay.
• npm run start: Inicia o processo de build em modo watch.

📝 Licença

Este projeto está sob a licença MIT.

Liferay © 2024