@liferay-react/create-react-liferay-client-extension

CLI para gerar um template de Client Extension React para Liferay.

Descrição

Este pacote fornece um CLI que copia o template do diretório template/ e substitui placeholders pelo nome do projeto especificado. É útil para iniciar rapidamente uma client-extension React pronta para Liferay.

Requisitos

• Node.js >= 14
• npm ou yarn

Instalação

Instale globalmente:

npm install -g @liferay-react/create-react-liferay-client-extension

Ou execute via npx (não precisa instalar):

npx @liferay-react/create-react-liferay-client-extension "Meu Projeto"

Durante desenvolvimento você também pode rodar o CLI localmente:

node ./bin/cli.js "Meu Projeto"

Uso

Comando principal (instalado como create-client-react):

create-client-react <nome-do-projeto> [opções]

Exemplos (genéricos):

• Criar no diretório padrão (gera ./nome-do-projeto-em-kebab):

create-client-react "My Project"

• Criar dentro de um diretório pai existente (o projeto será criado em <diretorio>/<nome-em-kebab>):

create-client-react "My Project" -d ./output

• Forçar nome do ZIP gerado:

create-client-react "My Project" -z my-project.zip

• Rodando localmente apontando para pasta específica:

node ./bin/cli.js "My Project" -d ./output -z my-project.zip

Opções

• -z, --zip <zipName>: nome do arquivo ZIP (ex.: meu-projeto.zip). -- -d, --directory <path>: diretório de destino (absoluto ou relativo). Se informado, o CLI criará/usar {directory}/{nome-em-kebab} (ou apenas {directory} se o nome do diretório já corresponder ao kebab-case do projeto).

Comportamento

• Se --directory for passado e apontar para uma pasta existente que contenha o mesmo nome em kebab-case, o CLI usará essa pasta.
• Se --directory for um caminho para uma pasta pai, o CLI criará/usar {pastaPai}/{nome-do-projeto-em-kebab}.
• Se o targetDir já existir e não estiver vazio, o CLI aborta para evitar sobrescrever conteúdo.

Licença

MIT