agentleFS
otavioserraotavioserra/conn2flow-ai-workspace/.claude/skills/c2f-dev-scripts/SKILL.md

c2f-dev-scripts

Skill4 starsChanged 33 days agoMITView on GitHub

LEIA ANTES de rodar scripts em dev-environment/ ou ferramentas CLI do projeto. Se não ler: comandos falham por caminhos relativos errados, variáveis de ambiente ausentes ou execução fora do container Docker.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Registre o comando: no console (cli/src/Console/) para que ele apareça no c2f help.

    line 79

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Scripts de Automação e Desenvolvimento (ai-workspace/scripts/)

⚡ Gatilho Obrigatório

  • TRIGGER: Executar tarefas de automação, sincronização, geração de recursos, migrações ou testes via scripts PowerShell/Bash em dev-environment/ ou scripts/.
  • SKIP APENAS SE: Edição manual de documentação Markdown sem execução de scripts auxiliares.
  • CONSEQUÊNCIA DE IGNORAR: Comandos falham por caminhos incorretos, permissões do Docker ou sobrescrita indevida de arquivos de ambiente.

Consulte as convenções para uso e criação de scripts de desenvolvimento no Conn2Flow:

1. Estrutura de Diretórios de Scripts

Os scripts são bilíngues e vivem sob o idioma (en/ ou pt-br/), nunca na raiz de ai-workspace/:

ai-workspace/<idioma>/scripts/
├── api/               # Sondas e clientes das APIs do gestor
├── commits/           # Validação e padronização de commits
├── dev-environment/   # Configuração e criação de novos módulos/instalações
├── projects/          # Deploy, recover, sync e atualização de projetos
├── releases/          # Tags e automação de releases Git
├── resources/         # CLI de manipulação de recursos (upsert-resources.php)
├── tests/             # Scripts de teste e diagnóstico
├── translates/        # Rotinas de tradução e paridade bilíngue
├── updates/           # Builds locais e compilação de pacotes
└── utils/             # Scripts auxiliares Node/JS (ex: fix-tailwind-spacing.js)

2. Principais Scripts Utilitários Disponíveis

  • ai-workspace/<idioma>/scripts/resources/upsert-resources.php: CLI para criar, clonar, editar e deletar recursos com suporte a --type, --id, --action=copy e --open.
  • ai-workspace/<idioma>/scripts/projects/deploy-project-v2.sh: Empacotamento e deploy automatizado de projetos via API OAuth.
  • ai-workspace/<idioma>/scripts/projects/recover-project.sh: Recuperação/pull de dados e estrutura do servidor.
  • ai-workspace/<idioma>/scripts/dev-environment/create-new-module.sh: Scaffold de novos módulos.
  • ai-workspace/<idioma>/scripts/dev-environment/create-new-installation.sh: Setup de nova instalação local.
  • ai-workspace/pt-br/scripts/utils/fix-tailwind-spacing.js: Utilitário Node para correção de classes Tailwind.

3. Contrato Canônico do Console CLI (c2f)

[!IMPORTANT] O console c2f não usa Symfony Console. Ele tem contratos próprios em Conn2Flow\Cli\Contracts. Nunca invente Symfony\Component\Console\Command\Command, configure(), InputArgument, addOption() ou atributos #[AsCommand]: nada disso existe no projeto e o comando não será registrado.

Todo novo comando DEVE implementar Conn2Flow\Cli\Contracts\CommandInterface ou estender Conn2Flow\Cli\Commands\BaseProcessCommand (que já implementa a interface e adiciona runShell()).

Superfície obrigatória da CommandInterface (cli/src/Contracts/CommandInterface.php):

MétodoRetornoPapel
getName()stringNome único no formato grupo:acao (ex.: resources:sync).
getDescription()stringDescrição curta exibida no c2f help.
getAliases()array<string>Aliases aceitos (ex.: ['release:installer']).
getHelp()stringTexto de uso detalhado do comando.
execute(InputInterface $input, OutputInterface $output)intLógica do comando. 0 = sucesso; diferente de 0 = falha.

Regras de implementação:

  1. Entrada e saída pelos contratos: leia argumentos com $input->getArgument(<indice>, <padrao>) e escreva com $output->title(), $output->info() e $output->error(). Não use $argv, echo ou print_r direto.
  2. Herde BaseProcessCommand para orquestrar processos: ele recebe string $rootPath no construtor e expõe runShell(string $cmd, OutputInterface $output, ?string $cwd = null): int, que já faz streaming de stdout, captura de stderr e propagação do exit code.
  3. Resolva caminhos a partir de $this->rootPath, nunca de getcwd() ou de caminhos relativos ao script.
  4. Valide argumentos antes de executar e devolva 1 com $output->error() explicando o uso correto.
  5. Declare declare(strict_types=1);, use o namespace Conn2Flow\Cli\Commands e marque a classe como final.
  6. Registre o comando no console (cli/src/Console/) para que ele apareça no c2f help. Um comando que não consta no catálogo não é executável.

4. Regra Anti-Deadlock: Sondas HTTP Partem do Front-End

[!WARNING] PROIBIDO disparar sonda HTTP de loopback síncrona de dentro do próprio processo PHP em modo web.

Em ambiente local, Docker e VPS single-pool, o PHP-FPM tem um número reduzido de workers. Se um script PHP que está atendendo uma requisição abre um cURL para o próprio host, ele ocupa um worker enquanto espera outro worker atender a sonda. Com o pool saturado, ninguém atende: o cURL só retorna no timeout e a requisição original trava. É deadlock de auto-requisição, não lentidão.

Regra normativa:

  1. Modo web: quem executa a sonda de conectividade, rewrite ou healthcheck de URL é o navegador (fetch/XMLHttpRequest assíncrono no JavaScript do front-end). O backend apenas monta o plano da sonda (URL alvo, resposta esperada, snippet de configuração) e registra o veredito devolvido pelo cliente.
  2. Modo CLI / headless: aí sim o próprio PHP pode sondar, porque não há navegador e o runner não compete pelo pool do PHP-FPM. Proteja com uma checagem explícita de SAPI.
  3. Nunca deixe a rota de diagnóstico depender do recurso que ela diagnostica. Ofereça sempre um caminho determinístico alcançável pelo front-controller (ex.: ?api=rewrite-probe além de api/rewrite-probe).

Implementação de referência (sonda de rewrite do gestor instalador, REQ-027/REQ-028):

  • gestor-instalador/src/InstallerGuard.php: constantes REWRITE_PROBE, REWRITE_PROBE_OK e API_REWRITE_PROBE.
  • gestor-instalador/index.php: responde à sonda antes de sessão/trava e aceita ?api=rewrite-probe como rota determinística; o veredito chega no request como rewrite_ok.
  • gestor-instalador/assets/js/installer.js: é o navegador que dispara o fetch da sonda.
  • gestor-instalador/src/Installer.php: rewriteProbeReport() consome o veredito do cliente; probeRewrite() aborta com if (!InstallerGuard::isCli()) return null; — a sonda pelo servidor só roda em CLI.
// Padrão obrigatório para qualquer sonda HTTP no servidor.
private function probeSelf($url)
{
    // Em modo web a requisição atingiria o mesmo pool PHP-FPM que conduz esta execução.
    if (!InstallerGuard::isCli()) return null;
    if (!function_exists('curl_init')) return null;
    // ... cURL com CURLOPT_TIMEOUT e CURLOPT_CONNECTTIMEOUT curtos ...
}

5. Diretrizes para Criar Novos Scripts de Desenvolvimento

  1. Parâmetros Flexíveis: Suporte a flags explícitas (--project=ID, --lang=pt-br, --force) e fallbacks seguros para execução interativa se os argumentos omitirem parâmetros requeridos.
  2. Idempotência e Segurança: Scripts de atualização/sincronização devem ser idempotentes (poder rodar múltiplas vezes sem corromper dados).
  3. Logs e Retorno: Emita saída colorida/formatada no console (echo -e "\033[0;32mOK...\033[0m") e verifique códigos de saída HTTP ou status de comandos.
  4. Modo --dry-run: scripts que mutam arquivos versionados (ex.: bump de versão em release) devem oferecer --dry-run, calculando e imprimindo o resultado sem escrever em disco, para que os gates de release possam pré-validar tags e documentação antes da mutação.
  5. Staging Git explícito: scripts que commitam DEVEM listar os caminhos (git add -- "$ARQUIVO"). git add . e git add -A são proibidos: arrastam trabalho concorrente de outros agentes para o commit.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.