Compositor para WordPress, Parte 1

Ok, então depois de falar sobre todas as várias bibliotecas que podem ajudar a melhorar a qualidade do código do seu trabalho, ainda levanta uma questão:

Como fazemos com que esses projetos funcionem em nossa base de código?

Em suma, requer Composer. Se você nunca usou, já escrevi brevemente sobre isso antes, mas pretendo fornecer o básico do que você precisa para começar a usá-lo e as bibliotecas mencionadas acima em seu trabalho.

Tanto neste post quanto no próximo, vou compartilhar como configurar tudo localmente na forma mais básica e depois como ele se integra ao Git para que você possa começar a usá-lo no seu dia-a-dia.

Configurando o Composer para WordPress

Há muitas informações que podem (e eu diria que deveriam entrar em um arquivo para o Composer). Isso inclui coisas como informações do autor, PSR, informações etc. Mas isso está realmente além do escopo deste post. Em vez disso, quero compartilhar o mínimo necessário sobre como configurar e configurar essas informações.

Um diretório de amostra

Suponha que, por um momento, você está prestes a começar a trabalhar em um plugin ou algo relacionado ao WordPress que exigirá as várias bibliotecas discutidas na série anterior. E ao configurar o diretório para isso, você terá muito poucos arquivos. Pode haver alguns arquivos PHP vazios, ativos, etc. Talvez fique assim:

É verdade que o exemplo acima já está um pouco à frente do que seu trabalho pode parecer porque:

• Existe um composer.lock arquivo mostrando que o Composer foi executado,
• Ele tem um vendor diretório que mostra que as bibliotecas foram instaladas via Composer,
• Existe um grumphp.yml arquivo que define como o GrumPHP deve funcionar (e falarei sobre isso mais tarde) ao farejar código.

Mas a essência do acima é a mesma: Você tem composer.jsone define e inclui tudo o que precisamos com base no post anterior. Então, como vamos configurá-lo?

Configurando o Compositor

Primeiro, você precisa ter uma ideia de como vai estruturar seu plugin. Por exemplo, eu tenho uma configuração de plugin como esta:

• Todos os arquivos PHP residem no src diretório,
• Todos os arquivos CSS, JavaScript, imagens, etc., estão no assets diretório,
• O vendor diretório é para coisas que são instaladas via Composer,
• views é o que é usado no front-end do projeto.

Por exemplo:

Segundo, no diretório em questão, você desejará criar um arquivo chamado composer.json. Isso pode ser feito via Terminal apenas emitindo um touch comando ou você pode criá-lo em seu IDE.

O importante a tirar disso é que existe um src diretório porque esse é o diretório que inclui nossos arquivos PHP e esse é o diretório que queremos cheirar.

Um arquivo de compositor básico

Com isso dito, aqui está um composer.jsonarquivo básico que você pode usar em seus projetos com base na série anterior e com base no que é compartilhado abaixo:

{
  "name": "pressware/demo-wordpress-plugin",
  "description": "This file is used to show how to configure a WordPress plugin using Composer.",
  "autoload": {
    "psr-4": {
      "Pressware": "src/"
    }
  },
  "require-dev": {
    "phpro/grumphp": "^0.11.6",
    "phpmd/phpmd": "^2.6",
    "phpunit/phpunit": "5.7.21",
    "nikic/php-parser": "^3.0",
    "sebastian/phpcpd": "^3.0",
    "povils/phpmnd": "^1.1",
    "squizlabs/php_codesniffer": "^3.0",
    "jakub-onderka/php-parallel-lint": "^0.9.2",
    "sensiolabs/security-checker": "^4.0"
  }
}

Observando o arquivo acima, veja como analisá-lo:

1. As linhas 2 e 3 dão uma pequena descrição do que é o plugin. Essas também são outras áreas neste arquivo para fornecer mais informações sobre o que precisa ser feito.
2. As linhas 4 a 8 são importantes porque explicam que estamos usando o PSR-4 para carregamento automático e que todos os arquivos se enquadram no namespace de nível superior Presswaree que os arquivos PHP estão no src diretório.
3. As linhas 9 a 18 cobrem todos os arquivos abordados na série anterior.

Em seguida, emita o seguinte comando no seu terminal:

$ composer install

E isso instalará esses pacotes.

E os compromissos?

Para ter certeza de que você está snuffing e manipulando commits corretamente, é importante que você configure o GrumPHP para que ele observe os arquivos. Mas vou dar uma olhada nisso no próximo post.

Enquanto isso, talvez esta seja uma boa oportunidade para configurar um plugin de demonstração e praticar com o código acima. Acertar na primeira vez pode ser difícil. Felizmente, muitos dos erros de saída são realmente fáceis de entender, por isso é relativamente simples resolvê-los.