Criar um arquivo de índice de registro manualmente

Aviso

Recurso experimental

Esse recurso é experimental. O MongoDB não é compatível com snippets. Este recurso pode ser alterado ou removido a qualquer momento sem aviso prévio.

Bugs não são esperados, no entanto, se você encontrar um, abra um problema no Github repositório do para este projeto.

Esta página discute como criar manualmente um arquivo de índice de registro. Para gerar o arquivo de índice de registro usando um script, consulte Criar um arquivo de índice de registro.

Para criar o arquivo de índice de registro:

Copie o seguinte modelo TypeScript e salve-o como make-index.ts :

import bson from 'bson';
import zlib from 'zlib';
interface ErrorMatcher {
   // Add additional information to shell errors matching one of the regular.
   // expressions. The message can point to a snippet helping solve that error.
   matches: RegExp[];
   message: string;
}
interface SnippetDescription {
   // The *npm* package name. Users do not interact with this.
   name: string;
   // The snippet name. This is what users interact with.
   snippetName: string;
   // An optional install specifier that can be used to point npm towards
   // packages that are not uploaded to the registry. For example,
   // this could be an URL to a git repository or a tarball.
   installSpec?: string;
   // A version field. Users do not interact with this, as currently, `snippet`
   // always installs the latest versions of snippets.
   version: string;
   description: string;
   readme: string;
   // License should be a SPDX license identifier.
   license: string;
   errorMatchers?: ErrorMatcher[];
}
interface SnippetIndexFile {
   // This must be 1 currently.
   indexFileVersion: 1;
   index: SnippetDescription[];
   metadata: { homepage: string };
}
const indexFileContents: SnippetIndexFile = {
   indexFileVersion: 1,
   index: [ /* ... */ ],
   metadata: { homepage: 'https://example.com' }
};
// Serialize, compress and store the index file:
fs.writeFileSync('index.bson.br',
   zlib.brotliCompressSync(
   bson.serialize(indexFileContents)));

Edite make-index.ts conforme necessário para seu pacote de trecho. Use os comentários como guia para preencher as informações necessárias.
Execute ts-node make-index.ts para criar o index.bson.br file.
Carregue index.bson.br em seu repositório do Github.
Atualize snippetIndexSourceURLs para incluir uma URL que faça referência a seu index.bson.br.

Voltar

Manipuladores de erros

Referência