수동으로 레지스트리 인덱스 파일 생성

이 페이지에서는 레지스트리 인덱스 파일을 수동으로 만드는 방법에 대해 설명합니다. 스크립트를 사용하여 레지스트리 인덱스 파일을 생성하려면 레지스트리 인덱스 파일 생성을 참조 하세요.

레지스트리 인덱스 파일을 생성하려면 다음을 수행합니다.

1. 다음 TypeScript 템플릿을 복사하여 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)));

2. 스니펫 패키지에 대해 필요에 따라 make-index.ts 를 편집합니다. 댓글을 가이드로 삼아 필수 정보를 입력하세요.

3. ts-node make-index.ts 을 실행하여 index.bson.br file 을 만듭니다.

4. index.bson.br 을(를) GitHub 리포지토리에 업로드합니다.

5. index.bson.br 을(를) 참고하는 URL을 포함하도록 snippetIndexSourceURLs 을(를) 업데이트합니다.