personare/plugin-boilerplate

Personare Plugin Boilerplate.

v2.0.0 2020-10-27 18:05 UTC

Requires

• php: >=7.3
• composer/installers: ^1.9
• league/container: ^3.3
• psr/log: ^1.1

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^0.7.0
• php-stubs/wordpress-stubs: ^5.5
• phpcompatibility/phpcompatibility-wp: ^2.1
• phpunit/phpunit: ^9.4
• slevomat/coding-standard: ^6.4
• squizlabs/php_codesniffer: ^3.5
• wp-coding-standards/wpcs: ^2.3

GPL-2.0-only

README

Plugin destinado a ser usado como boilerplate, ele irá ser usado principalmente quando surgir a necessidade de criar um plugin WordPress do zero, mas com uma estrutura já bem definida, pronto para testes unitários, linter + analisador estático de código e com container de injeção de dependência.

Requirements

• PHP >= 7.3
• Composer

Release automático

Este projeto tem uma action do semantic release, que a cada push no branch master ela roda para verificar se será necessário gerar um novo release, para isso ele percorre os commits verificando se está no padrão Conventional Commit.

Importante: Quando for fazer squash dos commits, será necessário alterar a mensagem do squash para o padrão Conventional Commit, caso isso não seja feito, o release não será gerado automaticamente.

Quickstart

1. Entre em wp-content/plugins.
2. Execute composer create-project personare/plugin-boilerplate nome-do-seu-novo-plugin.
3. Renomeie as strings.
4. Ative o seu novo plugin.

Não esqueça de renomear

Renomeie todas as strings abaixo para algo que faça sentido para o projeto que está a desenvolver.

• MY_APP_
• MyApp
• my-app
• plugin-boilerplate
• GPL-2.0-only

Scripts

• composer ci irá executar todos os scripts importantes para o CI, consulte o composer.json caso queira roda-los individualmente;
• yarn lint irá executar o linter para JavaScript + SASS;
• yarn build comando para gerar os bundles;

Configurando Phan como external tool no PHPStorm

• Em Preferences -> Tools -> External Tools clique para adicionar uma nova tool. Coloque o nome que achar melhor, selecione run_phan.sh script como "Program" e selecione o diretório do projeto como "Working directory" e por ultimo coloque $FILE_PATH$:$LINE$ como "Output filters" clicando em "Advanced Options". Você consegue executar external tools em Tools -> External Tools.

Caso dê algum erro de permissão, execute chmod +x run_phan.sh no seu terminal.

Exemplo de uso

Consulte os arquivos dentro de src/WordPress/, lá vai encontrar bons exemplos de como declarar hooks nesta estrutura, caso queira registrar um CPT consulte src/WordPress/Services/ExampleServiceProvider.php ou se caso quer registrar uma Taxonomia, então consulte src/WordPress/Services/ExampleCategoryServiceProvider.php