mongoose 7.3.1 → 7.3.2

package/.eslintrc.js

@@ -11,7 +11,9 @@ module.exports = {
     'test/files/*',
     'benchmarks',
     '*.min.js',
-    '**/docs/js/native.js'
+    '**/docs/js/native.js',
+    '!.*',
+    'node_modules'
   ],
   overrides: [
     {

package/.markdownlint-cli2.cjs

@@ -0,0 +1,69 @@
+'use strict';
+// this file is named ".cjs" instead of ".js" because markdownlint-cli2 only looks for ".cjs" or ".mjs"
+
+// use aliases instead of "MD000" naming
+
+module.exports = {
+  ignores: [
+    // the following are ignored because they are just redirects
+    'History.md',
+    'SECURITY.md',
+    'migrating_to_5.md', // this does not affect "docs/migrating_to_5.md"
+
+    // ignored for now, but should be changes later
+    '.github/PULL_REQUEST_TEMPLATE.md',
+
+    // ignore changelog because it uses different heading style than other documents and older versions use different formatting
+    'CHANGELOG.md',
+
+    // exclude node_modules because it isnt excluded by default
+    'node_modules'
+  ]
+};
+
+module.exports.config = {
+  // disable default rules
+  default: false,
+
+  // alt-text for images
+  accessibility: true,
+  // consistent blank lines
+  blank_lines: true,
+  // consistent unordered lists
+  bullet: { style: 'asterisk' },
+  // consistent and read-able code
+  code: true,
+  // consistent emphasis characters
+  emphasis: { style: 'asterisk' },
+  // ensure consistent header usage
+  headers: { style: 'atx' },
+  // ensure consistent "hr" usage
+  hr: { style: '---' },
+  // disable disalloing html tags, because
+  // mongoose currently uses html tags directly for heading ID's and style
+  html: false,
+  // consistent indentation
+  indentation: true,
+  // consistent links and good links
+  links: true,
+  // enabled by "links"
+  // mongoose currently does not wrap plain links in "<>"
+  'no-bare-urls': false,
+  // consistent ordered lists
+  ol: true,
+  // consistent whitespace usage
+  whitespace: true
+
+  // atx: undefined, // covered by "headers"
+  // atx_closed: undefined, // covered by "headers"
+  // blockquote: true, // covered by "whitespace"
+  // hard_tab: undefined, // covered by "whitespace"
+  // headings: undefined, // covered by "headers"
+  // images: true, // covered by "accessibility" and "links"
+  // language: undefined, // covered by "code"
+  // line_length: undefined, // mongoose currently uses a mix of max-line-length and relying on editor auto-wrap
+  // spaces: undefined, // covered by "atx", "atx_closed", "headers"
+  // spelling: undefined, // mongoose currently only uses short-form language specifiers and so does not need this
+  // ul: undefined, // covered by "whitespace" and "bullet"
+  // url: undefined, // covered by "links"
+};

package/README.md

@@ -17,11 +17,11 @@ Mongoose 7.0.0 was released on February 27, 2023. You can find more details on [
 
 ## Support
 
-  - [Stack Overflow](http://stackoverflow.com/questions/tagged/mongoose)
-  - [Bug Reports](https://github.com/Automattic/mongoose/issues/)
-  - [Mongoose Slack Channel](http://slack.mongoosejs.io/)
-  - [Help Forum](http://groups.google.com/group/mongoose-orm)
-  - [MongoDB Support](https://www.mongodb.com/docs/manual/support/)
+* [Stack Overflow](http://stackoverflow.com/questions/tagged/mongoose)
+* [Bug Reports](https://github.com/Automattic/mongoose/issues/)
+* [Mongoose Slack Channel](http://slack.mongoosejs.io/)
+* [Help Forum](http://groups.google.com/group/mongoose-orm)
+* [MongoDB Support](https://www.mongodb.com/docs/manual/support/)
 
 ## Plugins
 
@@ -43,7 +43,7 @@ View all 400+ [contributors](https://github.com/Automattic/mongoose/graphs/contr
 First install [Node.js](http://nodejs.org/) and [MongoDB](https://www.mongodb.org/downloads). Then:
 
 ```sh
-$ npm install mongoose
+npm install mongoose
 ```
 
 Mongoose 6.8.0 also includes alpha support for [Deno](https://deno.land/).
@@ -72,7 +72,7 @@ mongoose.connect('mongodb://127.0.0.1:27017/test')
 
 You can then run the above script using the following.
 
-```
+```sh
 deno run --allow-net --allow-read --allow-sys --allow-env mongoose-test.js
 ```
 
@@ -96,7 +96,7 @@ await mongoose.connect('mongodb://127.0.0.1/my_database');
 
 Once connected, the `open` event is fired on the `Connection` instance. If you're using `mongoose.connect`, the `Connection` is `mongoose.connection`. Otherwise, `mongoose.createConnection` return value is a `Connection`.
 
-**Note:** _If the local connection fails then try using 127.0.0.1 instead of localhost. Sometimes issues may arise when the local hostname has been changed._
+**Note:** *If the local connection fails then try using 127.0.0.1 instead of localhost. Sometimes issues may arise when the local hostname has been changed.*
 
 **Important!** Mongoose buffers all the commands until it's connected to the database. This means that you don't have to wait until it connects to MongoDB in order to define models, run queries, etc.
 
@@ -168,13 +168,13 @@ Or just do it all at once
 const MyModel = mongoose.model('ModelName', mySchema);
 ```
 
-The first argument is the _singular_ name of the collection your model is for. **Mongoose automatically looks for the _plural_ version of your model name.** For example, if you use
+The first argument is the *singular* name of the collection your model is for. **Mongoose automatically looks for the *plural* version of your model name.** For example, if you use
 
 ```js
 const MyModel = mongoose.model('Ticket', mySchema);
 ```
 
-Then `MyModel` will use the __tickets__ collection, not the __ticket__ collection. For more details read the [model docs](https://mongoosejs.com/docs/api/mongoose.html#mongoose_Mongoose-model).
+Then `MyModel` will use the **tickets** collection, not the **ticket** collection. For more details read the [model docs](https://mongoosejs.com/docs/api/mongoose.html#mongoose_Mongoose-model).
 
 Once we have our model, we can then instantiate it, and save it:
 
@@ -221,7 +221,7 @@ await m.save(); // does not work b/c the default connection object was never con
 
 In the first example snippet, we defined a key in the Schema that looks like:
 
-```
+```txt
 comments: [Comment]
 ```
 
@@ -250,7 +250,6 @@ await post.save();
 
 Embedded documents enjoy all the same features as your models. Defaults, validators, middleware.
 
-
 ### Middleware
 
 See the [docs](http://mongoosejs.com/docs/middleware.html) page.
@@ -331,26 +330,26 @@ and [acquit](https://github.com/vkarpov15/acquit).
 
 ## Related Projects
 
-#### MongoDB Runners
+### MongoDB Runners
 
-- [run-rs](https://www.npmjs.com/package/run-rs)
-- [mongodb-memory-server](https://www.npmjs.com/package/mongodb-memory-server)
-- [mongodb-topology-manager](https://www.npmjs.com/package/mongodb-topology-manager)
+* [run-rs](https://www.npmjs.com/package/run-rs)
+* [mongodb-memory-server](https://www.npmjs.com/package/mongodb-memory-server)
+* [mongodb-topology-manager](https://www.npmjs.com/package/mongodb-topology-manager)
 
-#### Unofficial CLIs
+### Unofficial CLIs
 
-- [mongoosejs-cli](https://www.npmjs.com/package/mongoosejs-cli)
+* [mongoosejs-cli](https://www.npmjs.com/package/mongoosejs-cli)
 
-#### Data Seeding
+### Data Seeding
 
-- [dookie](https://www.npmjs.com/package/dookie)
-- [seedgoose](https://www.npmjs.com/package/seedgoose)
-- [mongoose-data-seed](https://www.npmjs.com/package/mongoose-data-seed)
+* [dookie](https://www.npmjs.com/package/dookie)
+* [seedgoose](https://www.npmjs.com/package/seedgoose)
+* [mongoose-data-seed](https://www.npmjs.com/package/mongoose-data-seed)
 
-#### Express Session Stores
+### Express Session Stores
 
-- [connect-mongodb-session](https://www.npmjs.com/package/connect-mongodb-session)
-- [connect-mongo](https://www.npmjs.com/package/connect-mongo)
+* [connect-mongodb-session](https://www.npmjs.com/package/connect-mongodb-session)
+* [connect-mongo](https://www.npmjs.com/package/connect-mongo)
 
 ## License