O que é Manifesto de plugin?

O que é manifesto de plugin

Manifesto de plugin é o arquivo que descreve uma extensão para a ferramenta que vai executá-la. Ele informa o nome e a versão. Também declara o ponto de entrada, as permissões e os programas usados pelo plugin.

Cada plataforma define o formato e os campos obrigatórios. O VS Code usa um arquivo JSON, e o WordPress lê um cabeçalho no arquivo principal. Outras ferramentas adotam TOML ou YAML, com a mesma função de apresentar a extensão ao ambiente antes de carregá-la.

O que ele declara

O manifesto declara a identidade do plugin, a versão compatível com a ferramenta e os comandos que ele acrescenta. Também pode listar dependências, permissões e o executável chamado em cada ação.

Essas declarações orientam a instalação e a atualização. Quando o manifesto informa um programa compilado, você sabe que a extensão executa código no seu ambiente. Ela não se limita a um arquivo de configuração.

Como ler antes de instalar

Comece pelo nome e pela versão, depois confira a compatibilidade com a ferramenta instalada. Leia a lista de permissões e de programas. Um plugin que altera arquivos do projeto tem alcance diferente de outro que apenas consulta informações.

O manifesto não substitui a leitura do repositório. Ele mostra o que o autor declara, e o código mostra o que a extensão faz. Abrir os arquivos principais e conferir as chamadas externas reduz a diferença entre a declaração e o comportamento.

O que o manifesto não garante

O manifesto não confirma a qualidade do código, a ausência de falhas ou a manutenção futura. Também não informa se o catálogo revisou a extensão. A declaração descreve a intenção do autor, e a execução revela o comportamento.

Um campo de permissões amplo pode indicar acesso desnecessário, mas a avaliação depende do que a extensão precisa fazer. Sem essa comparação, a lista de permissões vira um aviso genérico.

Atualização e compatibilidade

Atualizar a ferramenta pode invalidar um campo do manifesto. Quando a versão mínima muda ou um campo é removido, a extensão deixa de carregar até ser ajustada. Acompanhar o changelog do plugin e o da ferramenta evita a surpresa.

Manter um fork permite corrigir o manifesto quando o autor interrompe o desenvolvimento. A cópia ainda exige testes com a versão instalada e acompanhamento das mudanças da ferramenta.

Para revisar uma extensão antes de instalar, o Desenvolvimento Colaborativo da Dev Side Studio permite abrir o manifesto e o código com orientação ao vivo.

Aplicação na formação

Developer Workspace

Ler o manifesto mostra o que um plugin adiciona ao ambiente antes de instalar a extensão.

Conhecer a formação →