创建和分享代码片段

从社区仓库分叉。

如果您计划向社区仓库贡献代码，请分叉项目仓库。

如果您想创建一个私有仓库，不需要从社区仓库分叉，但在执行以下步骤时，应手动重新创建类似的目录结构。

创建一个包目录。

在您从仓库分叉的 snippets 目录下创建一个用于代码片段包的目录。此目录将包含您的脚本代码和多个元数据文件。

此示例展示了两个代码片段包的目录，分别是 decrypt-cards 和 update-auth。出于清晰起见，省略了社区代码片段目录的详细内容。

mongo-snippets
|
├── scripts
│   ├── make-index.js
│   └── show-index.js
└── snippets
    ├── analyze-schema
    ├── decrypt-cards
    │   ├── LICENSE-Community.txt
    │   ├── README.md
    │   ├── error-matchers.js
    │   ├── index.js
    │   └── package.json
    ├── mock-collection
    ├── mongocompat
    ├── resumetoken
    ├── spawn-mongod
    └── update-auth
        ├── LICENSE
        ├── README.md
        ├── index.js
        └── package.json

创建 README.md。

创建一个 README.md。此 README.md 文件描述了如何使用您的代码。当用户输入 snippet help 以获取您的代码片段的帮助时，会显示此文件。

创建LICENSE文件。

创建一个LICENSE文件。稍后您需要输入一个许可证标识符字符串，因此请尝试从SPDX许可证列表

创建index.js文件。

创建一个index.js文件。

• 此文件包含您的代码入口，该代码在mongosh控制台中暴露。

• 脚本是用JavaScript编写的，并定义了您的新函数。

• 脚本可以是一个文件或多个文件。

• 脚本可以调用其他文件和本地或远程npm模块。要require()一个远程npm模块，请使用以下结构

  const localRequire = require('module').createRequire(__filename);)

  例如，请参阅 index.js 中的 resumetoken 段落。

• index.js 在 package.json. 中被引用。

• 在 MongoDB 代码库中有 示例代码。