Workspace + EVP

[Chico Gois]

Desenvolvimento, organização e pré-validação de extensões em um único lugar

O que é o Workspace?

O Workspace é uma extensão para phpBB criada inicialmente com a ideia de oferecer um ambiente próprio de organização e edição de projetos, inspirado no conceito de um repositório Git.

Durante o desenvolvimento, o projeto evoluiu e passou a ter um objetivo ainda mais importante: ajudar desenvolvedores de extensões phpBB a encontrar problemas antes de enviar uma extensão para validação no Extension Database.

Hoje o Workspace funciona como um ambiente de desenvolvimento e, ao mesmo tempo, como uma camada de pré-validação para extensões phpBB.

Para que serve?

A ideia é simples:

Código: Selecionar todos

Desenvolver a extensão
↓
Importar ou editar no Workspace
↓
Executar o preflight interno
↓
Executar o EPV oficial do phpBB
↓
Corrigir os problemas encontrados
↓
Gerar o ZIP no formato correto
↓
Enviar para validação

O objetivo é diminuir a quantidade de erros que só seriam descobertos depois do envio da extensão para o phpBB.

Validação própria do Workspace

Além do EPV oficial, o Workspace possui seu próprio sistema de análise.

Entre as verificações estão:

• estrutura da extensão;
• composer.json;
• namespace;
• ext.php;
• services.yml;
• routing.yml;
• controllers e listeners;
• permissões;
• arquivos de idioma;
• comparação de chaves entre idiomas;
• textos de interface hard-coded;
• proteção CSRF;
• uso de superglobais;
• SQL potencialmente inseguro;
• DBAL e portabilidade SQL;
• migrations;
• criação de índices UNIQUE;
• arquivos .sql indevidos;
• coding style;
• indentação;
• BOM e finais de linha;
• chamadas rejeitadas pelo EPV;
• namespaces em classes;
• assets, templates e estilos;
• resíduos de debug;
• geração correta do pacote de submissão.

Várias dessas regras foram acrescentadas a partir de problemas reais encontrados durante validações de extensões.

Ou seja, quando encontramos um novo tipo de problema, ele pode virar uma regra permanente do Workspace.


Integração com o EPV oficial

Um dos principais recursos é a integração com o EPV — Extension Pre Validator oficial do phpBB.

O Workspace pode executar o EPV diretamente pelo navegador.

Não é necessário abrir terminal toda vez que quiser validar uma extensão.

O resultado aparece dentro do próprio Workspace:

Código: Selecionar todos

EPV oficial do phpBB

APROVADO

0 fatais
0 erros
0 avisos
0 informações

Se houver problemas, as mensagens do EPV são apresentadas junto com o relatório do Workspace.

Instalação automática do EPV

O Workspace também possui um assistente para instalar ou reparar o EPV oficial.

Ele verifica automaticamente itens como:

• PHP CLI;
• proc_open;
• suporte ZIP;
• acesso HTTPS;
• diretório gravável;
• Composer;
• instalação existente do EPV.

Quando possível, basta clicar em:

Instalar EPV oficial

O próprio Workspace prepara o ambiente.

Esse recurso foi pensado especialmente para quem desenvolve com ajuda de IA ou possui conhecimento de phpBB, mas não quer depender constantemente de terminal, Git e Composer para executar uma validação.

Correções seguras automáticas

O Workspace também consegue aplicar determinadas correções automáticas de baixo risco.

Por exemplo:

• UTF-8 BOM;
• CRLF/CR para LF;
• espaços antes de <?php;
• fechamento ?> em PHP puro;
• alguns ajustes do composer.json;
• indentação por tabs;
• formatação segura de arquivos suportados.

Antes de modificar um arquivo, o conteúdo anterior é salvo no histórico do projeto.

Correções que possam alterar a lógica da extensão continuam sendo deixadas para revisão manual.

Editor e gerenciamento do projeto

O Workspace não é apenas um validador.

Ele também oferece um ambiente para trabalhar no projeto:

• árvore de arquivos;
• editor de código;
• criação de arquivos e pastas;
• upload por arrastar e soltar;
• histórico de versões;
• comparação de alterações;
• organização do projeto;
• download;
• geração do ZIP para phpBB.

A interface segue uma proposta semelhante a ambientes como GitHub, mantendo tudo dentro do próprio phpBB.


Geração do pacote para o Extension Database

Depois da validação, o Workspace pode gerar o pacote no formato esperado pelo phpBB:

Código: Selecionar todos

vendor/
└── extension/
├── composer.json
├── ext.php
├── config/
├── controller/
├── language/
└── ...

Por exemplo:

Código: Selecionar todos

mundophpbb/
└── antispamguard/

Isso também reduz erros de empacotamento.

O Workspace substitui a validação humana do phpBB?

Não.

O objetivo não é substituir a equipe de validação do phpBB.

Mesmo uma extensão que passe no Workspace e no EPV oficial ainda poderá receber observações durante uma revisão humana.

O objetivo é outro:

Encontrar localmente o maior número possível de problemas antes da submissão.

Quanto mais problemas forem resolvidos antes do envio, menor a chance de uma extensão voltar por erros mecânicos, estruturais ou de coding style.

Para quem é indicado?

O Workspace pode ser útil para:

• desenvolvedores de extensões phpBB;
• usuários que desenvolvem projetos com auxílio de IA;
• quem tem dificuldade em utilizar o EPV pelo terminal;
• quem deseja organizar extensões em um ambiente próprio;
• quem quer realizar uma pré-validação antes do envio ao Extension Database.

Workspace

Desenvolver → Validar → Corrigir → EPV → Empacotar → Enviar

Uma ferramenta criada para diminuir a distância entre uma ideia de extensão e um pacote realmente preparado para o processo de validação do phpBB.

[Chico Gois]

Workspace for phpBB
Extension development, organization, and pre-validation in one place

What is Workspace?

Workspace is a phpBB extension originally created with the idea of providing a dedicated environment for organizing and editing projects, inspired by the concept of a Git repository.

During development, the project evolved and gained an even more important purpose: helping phpBB extension developers find issues before submitting an extension for validation in the Extension Database.

Today, Workspace works as both a development environment and a pre-validation layer for phpBB extensions.

What is it for?

The idea is simple:

Código: Selecionar todos

Develop the extension
↓
Import or edit it in Workspace
↓
Run the internal preflight
↓
Run the official phpBB EPV
↓
Fix the issues found
↓
Generate the ZIP in the correct format
↓
Submit it for validation

The goal is to reduce the number of issues that would otherwise only be discovered after submitting the extension to phpBB.

Workspace's own validation

In addition to the official EPV, Workspace has its own analysis system.

Among the checks are:

• extension structure;
• composer.json;
• namespace;
• ext.php;
• services.yml;
• routing.yml;
• controllers and listeners;
• permissions;
• language files;
• comparison of language keys between languages;
• hard-coded interface text;
• CSRF protection;
• use of superglobals;
• potentially unsafe SQL;
• DBAL and SQL portability;
• migrations;
• UNIQUE index creation;
• improper .sql files;
• coding style;
• indentation;
• BOM and line endings;
• calls rejected by the EPV;
• namespaces in classes;
• assets, templates, and styles;
• debug leftovers;
• correct generation of the submission package.

Several of these rules were added based on real issues found during extension validation.

In other words, whenever a new type of issue is discovered, it can become a permanent Workspace rule.

Integration with the official EPV

One of the main features is integration with phpBB's official EPV — Extension Pre Validator.

Workspace can run the EPV directly from the browser.

There is no need to open a terminal every time you want to validate an extension.

The result is displayed inside Workspace itself:

Código: Selecionar todos

Official phpBB EPV

APPROVED

0 fatals
0 errors
0 warnings
0 notices

If there are issues, the EPV messages are displayed together with the Workspace report.

Automatic EPV installation

Workspace also includes an assistant for installing or repairing the official EPV.

It automatically checks items such as:

• PHP CLI;
• proc_open;
• ZIP support;
• HTTPS access;
• writable directory;
• Composer;
• existing EPV installation.

When possible, simply click:

Install official EPV

Workspace prepares the environment automatically.

This feature was designed especially for people who develop with the help of AI or have phpBB knowledge, but do not want to constantly depend on the terminal, Git, and Composer just to run a validation.

Automatic safe fixes

Workspace can also apply certain low-risk automatic fixes.

For example:

• UTF-8 BOM;
• CRLF/CR to LF;
• spaces before <?php;
• closing ?> tag in pure PHP files;
• some composer.json adjustments;
• tab indentation;
• safe formatting of supported files.

Before modifying a file, the previous content is saved in the project history.

Fixes that could alter the extension's logic are still left for manual review.

Editor and project management

Workspace is not only a validator.

It also provides an environment for working on the project:

• file tree;
• code editor;
• file and folder creation;
• drag-and-drop upload;
• version history;
• change comparison;
• project organization;
• download;
• ZIP generation for phpBB.

The interface follows an approach similar to environments such as GitHub, while keeping everything inside phpBB itself.

Generating the package for the Extension Database

After validation, Workspace can generate the package in the format expected by phpBB:

Código: Selecionar todos

vendor/
└── extension/
├── composer.json
├── ext.php
├── config/
├── controller/
├── language/
└── ...

For example:

Código: Selecionar todos

mundophpbb/
└── antispamguard/

This also helps reduce packaging errors.

Does Workspace replace phpBB's human validation?

No.

The goal is not to replace the phpBB validation team.

Even an extension that passes both Workspace and the official EPV may still receive comments during human review.

The goal is different:

Find as many issues as possible locally before submission.

The more issues are solved before submission, the lower the chance that an extension will be returned because of mechanical, structural, or coding-style problems.

Who is it for?

Workspace can be useful for:

• phpBB extension developers;
• users who develop projects with the help of AI;
• people who have difficulty using the EPV through the terminal;
• those who want to organize extensions in their own environment;
• those who want to run a pre-validation before submitting to the Extension Database.

Workspace

Develop → Validate → Fix → EPV → Package → Submit

A tool created to reduce the gap between an extension idea and a package truly prepared for the phpBB validation process.

Se quiser, também posso adaptar essa versão para soar mais natural para o público do **phpBB.com**, com um tom mais técnico e “release announcement”.