Criar projetos de Suplemento do Office usando o Gerador Yeoman

O Gerador Yeoman para Suplementos do Office (também chamado de "Yo Office") é uma ferramenta de linha de comando interativa baseada em Node.js que cria projetos de desenvolvimento de Suplementos do Office. Esses projetos são baseados em Node.js. Quando você quiser que o código do lado do servidor do suplemento esteja em um arquivo . linguagem baseada em NET (como C# ou VB.Net) ou você deseja que o suplemento seja hospedado no IIS (Servidor de Informações da Internet), use o Visual Studio para criar o suplemento.

Os projetos que a ferramenta cria possuem as seguintes características.

• Eles têm uma configuração npm padrão que inclui um arquivo package.json .
• Eles incluem vários scripts úteis para criar o projeto, iniciar o servidor, fazer sideload do suplemento no Office e outras tarefas.
• Eles usam o webpack como empacotador e executor de tarefas básicas.
• No modo de desenvolvimento, eles são hospedados no localhost pelo webpack-dev-server baseado em Node.js do webpack, uma versão orientada para o desenvolvimento do servidor expresso que suporta recarregamento a quente e recompile-on-change.
• Por padrão, todas as dependências são instaladas pela ferramenta, mas você pode adiar a instalação com um argumento de linha de comando.
• Elas incluem um manifesto completo do suplemento.
• Eles têm um suplemento de nível "Olá, Mundo" que está pronto para ser executado assim que a ferramenta é concluída.
• Eles incluem um transpilador para transpilar TypeScript para ES5 JavaScript e um polyfill para permitir que o ES5 JavaScript use recursos de versões posteriores do JavaScript. Juntos, eles fornecem compatibilidade com versões anteriores com exibições da Web herdadas, como o Trident (Internet Explorer), embora a Microsoft não dê suporte ao desenvolvimento de suplementos para versões do Office que usam essas exibições da Web antigas.

Pré-requisitos

• Node.js (a versão LTS ativa mais recente). Visite o site doNode.js para baixar e instalar a versão correta para o seu sistema operacional.

• A versão mais recente do Yeoman e do Yeoman gerador de Suplementos do Office. Para instalar essas ferramentas globalmente, execute o seguinte comando por meio do prompt de comando.

  npm install -g yo generator-office
  

  Observação

  Mesmo se você já instalou o gerador Yeoman, recomendamos atualizar seu pacote para a versão mais recente do npm.

• Office conectado a uma assinatura Microsoft 365 (incluindo o Office na web).

  Observação

  Se você ainda não tem o Office, você pode se qualificar para uma assinatura de desenvolvedor do Microsoft 365 E5 por meio do Programa de Desenvolvedor do Microsoft 365. Para obter detalhes, consulte as Perguntas frequentes. Como alternativa, você pode se inscrever para uma avaliação gratuita de 1 mês ou adquirir um plano do Microsoft 365.

Usar a ferramenta

Inicie a ferramenta com o seguinte comando em um prompt do sistema (não em uma janela bash). Isso criará um novo projeto em uma nova pasta no diretório atual.

yo office 

Muita coisa precisa ser carregada, portanto, pode levar 40 segundos para que a ferramenta seja iniciada. A ferramenta faz uma série de perguntas. Para alguns, basta digitar uma resposta para o prompt. Para outras pessoas, você recebe uma lista de respostas possíveis. Se receber uma lista, use as teclas de direção para cima e para baixo para selecionar uma e selecione Enter.

A primeira pergunta pede que você escolha entre vários tipos de projetos. As opções são:

• Projeto do painel de tarefas do Suplemento do Office
• Painel de tarefas do Excel, PowerPoint e/ou Word com manifesto unificado para Microsoft 365 (versão prévia)
• Projeto do painel de tarefas do suplemento do Office usando a estrutura do React
• Funções Personalizadas do Excel usando um Runtime Compartilhado
• Funções Personalizadas do Excel usando um Runtime somente JavaScript
• Painel de tarefas do suplemento do Office projeto com suporte para logon único
• Projeto do Painel de Tarefas do Suplemento do Office com suporte para logon único de Autenticação de Aplicativo Aninhado (versão prévia)
• Projeto de suplemento do Office que contém apenas o manifesto

A próxima pergunta pede que você escolha entre TypeScript e JavaScript. (Essa pergunta será ignorada se você escolher a opção somente manifesto na pergunta anterior.)

Em seguida, você será solicitado a dar um nome ao suplemento. O nome especificado será usado no manifesto do suplemento, mas você poderá alterá-lo posteriormente. Esse também é o nome da pasta do projeto.

Em seguida, você será solicitado a escolher em qual aplicativo do Office o suplemento deve ser executado. Existem seis aplicativos possíveis para escolher: Excel, OneNote, Outlook, PowerPoint, Project e Word. Você deve escolher apenas um, mas pode alterar o manifesto posteriormente para oferecer suporte aos aplicativos adicionais do Office. A exceção é o Outlook. Um manifesto compatível com o Outlook não pode oferecer suporte a nenhum outro aplicativo do Office.

Se escolher o Outlook como o aplicativo do Office, você receberá uma pergunta adicional perguntando que tipo de manifesto deseja usar. Recomendamos que você escolha o manifesto unificado para Microsoft 365 , a menos que seu suplemento inclua um recurso de extensibilidade que ainda não tenha suporte no manifesto unificado.

Depois de responder a todas as perguntas, o gerador cria o projeto e instala as dependências. Você pode ver mensagens WARN na saída npm na tela. Você pode ignorá-los. Você também pode ver mensagens informando que vulnerabilidades foram encontradas. Você pode ignorá-los por enquanto, mas eventualmente precisará corrigi-los antes que seu suplemento seja liberado para produção. Para obter mais informações, consulte Avisos e dependências no mundo Node.js e npm.

Se a criação for bem-sucedida, você verá uma mensagem Parabéns! na janela de comando, seguida por algumas próximas etapas sugeridas. (Se você estiver usando o gerador como parte de um início rápido ou tutorial, ignore as próximas etapas na janela de comando e continue com as instruções no artigo.)

yo office --skip-install

Opção somente manifesto

Essa opção cria apenas um manifesto para um suplemento. O projeto resultante não tem um suplemento Olá, Mundo, nenhum dos scripts ou qualquer uma das dependências. Use essa opção nos cenários a seguir.

• Você deseja usar ferramentas diferentes daquelas que um projeto gerador Yeoman instala e configura por padrão. Por exemplo, você deseja usar um empacotador, transpilador, executor de tarefas ou servidor de desenvolvimento diferente.
• Você deseja usar uma estrutura de desenvolvimento de aplicativo Web, diferente do React, como o Vue.

Word, PowerPoint ou Excel com opção de manifesto unificado

O manifesto unificado para Microsoft 365 está em versão prévia para os suplementos do Excel, PowerPoint e Word. Ela não deve ser usada para suplementos de produção, mas você pode selecionar essa opção no Yo Office para criar um suplemento para um (ou todos os três) desses aplicativos do Office. Você será solicitado a escolher qual aplicativo do Office. Você também pode escolher Todos para criar um suplemento que possa ser instalado em todos os três aplicativos do Office. O projeto criado usa TypeScript.

Usar parâmetros de linha de comando

Você também pode adicionar parâmetros ao yo office comando. As duas opções mais comuns são:

• yo office --details: Isso produzirá uma breve ajuda sobre todos os outros parâmetros de linha de comando.
• yo office --skip-install: Isso impedirá que o gerador instale as dependências.

Para obter uma referência detalhada sobre os parâmetros de linha de comando, consulte o leiame do gerador no gerador Yeoman para Suplementos do Office.

Solução de problemas

Se você encontrar problemas ao usar a ferramenta, a primeira etapa deve ser reinstalá-la para garantir que você tenha a versão mais recente. (Consulte Pré-requisitos para obter detalhes.) Se isso não corrigir o problema, pesquise os problemas do repositório GitHub da ferramenta para ver se alguém encontrou o mesmo problema e encontrou uma solução. Se ninguém tiver, crie um novo problema.

Próximas etapas

Agora que você aprendeu como criar um projeto de suplemento, saiba como desenvolvê-lo, testá-lo e publicá-lo. Comece com o ciclo de vida de desenvolvimento do suplemento do Office.