Atualizar pacotes da Estrutura do SharePoint

As ferramentas de desenvolvimento do lado do cliente do SharePoint usam o gerenciador de pacotes npm para gerenciar as dependências e outros auxiliares JavaScript obrigatórios. O npm normalmente é incluído como parte da instalação do Node.js.

Quando você cria uma nova solução do lado do cliente, o gerador Yeoman para o SharePoint busca os pacotes de Estrutura do SharePoint mais recente necessários para o seu projeto do lado do cliente. À medida que você cria seu projeto, os pacotes existentes podem ficar desatualizados, já que pode haver novas versões de um ou mais pacotes disponíveis.

Com base nas notas de versão de uma versão específica ou do pacote mais recente, poderá ser necessário decidir atualizar os pacotes de estrutura do SharePoint usados em seu projeto. Os pacotes da Estrutura do SharePoint incluem ambos os pacotes do npm que você instalou no seu projeto, por exemplo: @microsoft/sp-core-library, e os pacotes do npm instalados globalmente, por exemplo: @microsoft/generator-sharepoint.

Dica

Embora não seja necessário, é recomendável atualizar os pacotes de Estrutura do SharePoint com frequência para que seja possível obter as alterações e as correções mais recentes que foram lançadas.

Encontrar pacotes desatualizados

Para localizar os pacotes desatualizados em seu projeto de cliente, incluindo a estrutura do SharePoint e outros pacotes de que seu projeto depende, execute o seguinte comando em um console no mesmo diretório do seu projeto.

npm outdated

O comando lista as informações a seguir sobre os pacotes de que seu projeto depende. Essas informações são obtidas no arquivo package.json localizado na raiz do diretório do seu projeto e no registro do npm.

  • Versão atual instalada em seu projeto
  • Versão solicitada pelo seu projeto (disponível em package.json)
  • Versão mais recente disponível

Pacotes NPM desatualizados

Para identificar os pacotes do SharePoint Framework, procure os nomes de pacote que começam com o seguinte prefixo e escopo npm:

@microsoft/sp-

Juntamente com os pacotes da Estrutura do SharePoint, talvez você também precise atualizar reação e pacotes office-ui-reação. Verifique se você leu o Roteiro de Notas & de Versão para a versão específica para inferir quais pacotes exigem atualizações.

Utilize "npm outdated" com um projeto

O SharePoint Server 2016 com o Feature Pack 2 oferece suporte a soluções da Estrutura do SharePoint. O SharePoint Server 2016 usa uma versão mais antiga da Estrutura do SharePoint que a versão disponível no SharePoint Online.

Ao estruturar novos projetos, o gerador Yeoman da Estrutura do SharePoint solicita que você escolha se a solução deve utilizar a versão mais recente da Estrutura do SharePoint e funcionar apenas com o SharePoint Online ou se deve utilizar uma versão mais antiga da Estrutura do SharePoint e trabalhar com SharePoint Server 2016 e SharePoint Online.

Quando você executa o comando npm outdated em um projeto que visa tanto o SharePoint Online quanto o SharePoint Server 2016, ele mostra as versões mais recentes dos pacotes da Estrutura do SharePoint. Entretanto, essas versões funcionam somente com o SharePoint Online. Se você atualizar sua solução para utilizar esses pacotes mais recentes, ela não funcionará mais com o SharePoint Server 2016.

Ao trabalhar com soluções da Estrutura do SharePoint compatíveis com o SharePoint hospedado no local, você sempre deverá verificar qual nível de patch tem o farm do SharePoint de destino e para qual versão da Estrutura do SharePoint oferece suporte.

Pacotes de atualização

Ao atualizar pacotes para versões mais recentes, você sempre deverá usar o gerenciador de pacotes (npm ou Yam). Você não deve editar manualmente o arquivo package.json. Se você seguir as práticas recomendadas ao utilizar um arquivo de bloqueio, suas alterações no arquivo package.json serão ignoradas.

Comece pela identificação de quais pacotes precisam de atualização e qual versão mais recente você deseja usar. Nem sempre é possível utilizar a versão mais recente de determinado pacote porque ela pode ser incompatível com outras dependências da Estrutura do SharePoint, como o TypeScript.

Para cada pacote que você deseja atualizar, execute o seguinte comando:

npm install mypackage@newversion --save

Por exemplo, se você estivesse usando o date-fns versão v2.9.0 e quisesse atualizar para a versão 2.16.1, você deveria executar:

npm install date-fns@2.16.1 --save

Atualizar o pacote usando o npm instala a versão especificada do pacote em seu projeto e atualiza o número da versão nas dependências do arquivopackage.json e no arquivo de bloqueio utilizado em seu projeto.

Depois que os pacotes forem instalados, execute o seguinte comando para limpar artefatos de compilação antigos:

gulp clean

É recomendado excluir todos os pacotes antigos excluindo a pasta node_modules e baixar (ou seja: reinstalar) todas as dependências com o package.json. atualizado. Sem essa etapa, as versões antigas podem entrar em conflito com as versões mais recentes na próxima vez que você criar o projeto.

npm install

Atualizar seu código

Dependendo das alterações significativas de API, será necessário atualizar seu código e os arquivos de configuração de projeto existentes. Em cada versão, as notas de versão destacam essas alterações significativas e as modificações necessárias para seu código existente. Você deve se certificar de atualizar seu código com essas correções.

Você sempre pode construir o projeto para ver se há erros e avisos executando o comando em um console no diretório do projeto:

gulp build

Atualizar gerador do Yeoman

Se você instalou o gerador Yeoman da Estrutura do SharePoint globalmente, pode descobrir se ele requer atualização executando o seguinte comando:

npm outdated -g

O comando lista as informações a seguir sobre os pacotes instalados globalmente em sua máquina. Essas informações são buscadas pelas versões instaladas em sua máquina e no registro npm.

  • A versão atual instalada globalmente em sua máquina
  • A versão solicitada quando você instalou
  • Versão mais recente disponível

Pacotes globais NPM desatualizados

Para identificar o pacote de gerador, busque pelo seguinte nome de pacote:

@microsoft/generator-sharepoint

Atualizar o pacote do gerador

Abra seu console favorito e execute o seguinte comando para atualizar o gerador para a versão publicada mais recente:

npm install @microsoft/generator-sharepoint@latest -g

O comando atualiza o gerador do Yeoman para SharePoint para a última versão publicada com suas dependências. É possível validá-lo executando o seguinte comando no console:

npm ls @microsoft/generator-sharepoint -g --depth=0

Confira também