Create and Share Snippets创建和共享代码段

Fork the Community Repository.分叉社区存储库。

If you plan to contribute to the community repository, fork the snippets project repository.如果您计划为社区存储库做出贡献，请分叉代码片段项目存储库。

You do not have to fork the community repository if you want to create a private repo, but you should manually recreate a similar directory structure as you work through the following steps.如果你想创建一个私有仓库，你不必分叉社区仓库，但在完成以下步骤时，你应该手动重新创建一个类似的目录结构。

Create a Package Directory.创建包目录。

Create a directory for your snippet package under the snippets directory in the forked repository. This directory will contain the code for your script and several metadata files.在分叉存储库的snippets目录下为snippet包创建一个目录。此目录将包含脚本的代码和几个元数据文件。

This example shows directories for two snippet packages, decrypt-cards and update-auth. The contents of the community snippets directories are omitted for clarity.

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

Create README.md.创建README.md。

Create a README.md. The README.md describes how to use your code. This file is displayed when a user enters snippet help for your snippet.创建一个README.md。README.md描述了如何使用代码。当用户为代码段输入snippet help时，将显示此文件。

Create LICENSE.创建LICENSE。

Create a LICENSE file. You will need to enter a license identifier string later, so try to chose a license from the SPDX license list.创建LICENSE文件。稍后您需要输入许可证标识符字符串，因此请尝试从SPDX许可证列表中选择一个许可证。

Create index.js.创建index.js。

Create an index.js file.创建一个index.js文件。

• This file contains the entry point to your code that is exposed in the mongosh console.此文件包含mongosh控制台中公开的代码的入口点。
• The script is written in JavaScript and defines your new functions.该脚本是用JavaScript编写的，并定义了新函数。
• The script can be in a single file or multiple files.脚本可以在单个文件或多个文件中。

• The script can call other files and local or remote npm modules. To require() a remote npm module use the construction:该脚本可以调用其他文件和本地或远程npm模块。要require()远程npm模块，请使用以下构造：

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

  For an example, see index.js in the resumetoken snippet.例如，请参阅resumethoken代码片段中的index.js。

• index.js is referenced in package.json.在package.json中引用。
• The MongoDB repository has example code.MongoDB存储库有示例代码。