mongoose 7.0.0 → 7.0.2

package/.eslintrc.js

@@ -0,0 +1,232 @@
+'use strict';
+
+module.exports = {
+  extends: [
+    'eslint:recommended'
+  ],
+  ignorePatterns: [
+    'tools',
+    'dist',
+    'website.js',
+    'test/files/*',
+    'benchmarks',
+    '*.min.js',
+    'docs/js/native.js'
+  ],
+  overrides: [
+    {
+      files: [
+        '**/*.{ts,tsx}',
+        '**/*.md/*.ts',
+        '**/*.md/*.typescript'
+      ],
+      extends: [
+        'plugin:@typescript-eslint/eslint-recommended',
+        'plugin:@typescript-eslint/recommended'
+      ],
+      plugins: [
+        '@typescript-eslint'
+      ],
+      rules: {
+        '@typescript-eslint/triple-slash-reference': 'off',
+        '@typescript-eslint/no-non-null-assertion': 'off',
+        '@typescript-eslint/no-empty-function': 'off',
+        'spaced-comment': [
+          'error',
+          'always',
+          {
+            block: {
+              markers: [
+                '!'
+              ],
+              balanced: true
+            },
+            markers: [
+              '/'
+            ]
+          }
+        ],
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/ban-types': 'off',
+        '@typescript-eslint/no-unused-vars': 'off',
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/indent': [
+          'warn',
+          2,
+          {
+            SwitchCase: 1,
+            ignoredNodes: ['TSTypeParameterInstantiation']
+          }
+        ],
+        '@typescript-eslint/prefer-optional-chain': 'error',
+        '@typescript-eslint/brace-style': 'error',
+        '@typescript-eslint/no-dupe-class-members': 'error',
+        '@typescript-eslint/no-redeclare': 'error',
+        '@typescript-eslint/type-annotation-spacing': 'error',
+        '@typescript-eslint/object-curly-spacing': [
+          'error',
+          'always'
+        ],
+        '@typescript-eslint/semi': 'error',
+        '@typescript-eslint/space-before-function-paren': [
+          'error',
+          'never'
+        ],
+        '@typescript-eslint/space-infix-ops': 'off'
+      }
+    },
+    {
+      files: [
+        'docs/js/**/*.js'
+      ],
+      env: {
+        node: false,
+        browser: true
+      }
+    }
+    // // eslint-plugin-markdown has been disabled because of out-standing issues, see https://github.com/eslint/eslint-plugin-markdown/issues/214
+    // {
+    //   files: ['**/*.md'],
+    //   processor: 'markdown/markdown'
+    // },
+    // {
+    //   files: ['**/*.md/*.js', '**/*.md/*.javascript', '**/*.md/*.ts', '**/*.md/*.typescript'],
+    //   parserOptions: {
+    //     ecmaFeatures: {
+    //       impliedStrict: true
+    //     },
+    //     sourceType: 'module', // required to allow "import" statements
+    //     ecmaVersion: 'latest' // required to allow top-level await
+    //   },
+    //   rules: {
+    //     'no-undef': 'off',
+    //     'no-unused-expressions': 'off',
+    //     'no-unused-vars': 'off',
+    //     'no-redeclare': 'off',
+    //     '@typescript-eslint/no-redeclare': 'off'
+    //   }
+    // }
+  ],
+  plugins: [
+    'mocha-no-only'
+    // 'markdown'
+  ],
+  parserOptions: {
+    ecmaVersion: 2020
+  },
+  env: {
+    node: true,
+    es6: true
+  },
+  rules: {
+    'comma-style': 'error',
+    indent: [
+      'error',
+      2,
+      {
+        SwitchCase: 1,
+        VariableDeclarator: 2
+      }
+    ],
+    'keyword-spacing': 'error',
+    'no-whitespace-before-property': 'error',
+    'no-buffer-constructor': 'warn',
+    'no-console': 'off',
+    'no-constant-condition': 'off',
+    'no-multi-spaces': 'error',
+    'func-call-spacing': 'error',
+    'no-trailing-spaces': 'error',
+    'no-undef': 'error',
+    'no-unneeded-ternary': 'error',
+    'no-const-assign': 'error',
+    'no-useless-rename': 'error',
+    'no-dupe-keys': 'error',
+    'space-in-parens': [
+      'error',
+      'never'
+    ],
+    'spaced-comment': [
+      'error',
+      'always',
+      {
+        block: {
+          markers: [
+            '!'
+          ],
+          balanced: true
+        }
+      }
+    ],
+    'key-spacing': [
+      'error',
+      {
+        beforeColon: false,
+        afterColon: true
+      }
+    ],
+    'comma-spacing': [
+      'error',
+      {
+        before: false,
+        after: true
+      }
+    ],
+    'array-bracket-spacing': 1,
+    'arrow-spacing': [
+      'error',
+      {
+        before: true,
+        after: true
+      }
+    ],
+    'object-curly-spacing': [
+      'error',
+      'always'
+    ],
+    'comma-dangle': [
+      'error',
+      'never'
+    ],
+    'no-unreachable': 'error',
+    quotes: [
+      'error',
+      'single'
+    ],
+    'quote-props': [
+      'error',
+      'as-needed'
+    ],
+    semi: 'error',
+    'no-extra-semi': 'error',
+    'semi-spacing': 'error',
+    'no-spaced-func': 'error',
+    'no-throw-literal': 'error',
+    'space-before-blocks': 'error',
+    'space-before-function-paren': [
+      'error',
+      'never'
+    ],
+    'space-infix-ops': 'error',
+    'space-unary-ops': 'error',
+    'no-var': 'warn',
+    'prefer-const': 'warn',
+    strict: [
+      'error',
+      'global'
+    ],
+    'no-restricted-globals': [
+      'error',
+      {
+        name: 'context',
+        message: 'Don\'t use Mocha\'s global context'
+      }
+    ],
+    'no-prototype-builtins': 'off',
+    'mocha-no-only/mocha-no-only': [
+      'error'
+    ],
+    'no-empty': 'off',
+    'eol-last': 'warn',
+    'no-multiple-empty-lines': ['warn', { max: 2 }]
+  }
+};

package/README.md

@@ -13,7 +13,7 @@ Mongoose is a [MongoDB](https://www.mongodb.org/) object modeling tool designed
 
 The official documentation website is [mongoosejs.com](http://mongoosejs.com/).
 
-Mongoose 6.0.0 was released on August 24, 2021. You can find more details on [backwards breaking changes in 6.0.0 on our docs site](https://mongoosejs.com/docs/migrating_to_6.html).
+Mongoose 7.0.0 was released on February 27, 2023. You can find more details on [backwards breaking changes in 7.0.0 on our docs site](https://mongoosejs.com/docs/migrating_to_7.html).
 
 ## Support
 
@@ -61,7 +61,7 @@ import mongoose from 'mongoose';
 Or, using [Deno's `createRequire()` for CommonJS support](https://deno.land/std@0.113.0/node/README.md?source=#commonjs-modules-loading) as follows.
 
 ```javascript
-import { createRequire } from "https://deno.land/std/node/module.ts";
+import { createRequire } from 'https://deno.land/std/node/module.ts';
 const require = createRequire(import.meta.url);
 
 const mongoose = require('mongoose');
@@ -112,7 +112,7 @@ const BlogPost = new Schema({
   author: ObjectId,
   title: String,
   body: String,
-  date: Date
+  date: Date
 });
 ```
 
@@ -141,12 +141,12 @@ const Comment = new Schema({
 });
 
 // a setter
-Comment.path('name').set(function (v) {
+Comment.path('name').set(function(v) {
   return capitalize(v);
 });
 
 // middleware
-Comment.pre('save', function (next) {
+Comment.pre('save', function(next) {
   notify(this.get('email'));
   next();
 });
@@ -181,7 +181,7 @@ Once we have our model, we can then instantiate it, and save it:
 ```js
 const instance = new MyModel();
 instance.my.key = 'hello';
-instance.save(function (err) {
+instance.save(function(err) {
   //
 });
 ```
@@ -189,7 +189,7 @@ instance.save(function (err) {
 Or we can find documents from the same collection
 
 ```js
-MyModel.find({}, function (err, docs) {
+MyModel.find({}, function(err, docs) {
   // docs.forEach
 });
 ```
@@ -197,8 +197,8 @@ MyModel.find({}, function (err, docs) {
 You can also `findOne`, `findById`, `update`, etc.
 
 ```js
-const instance = await MyModel.findOne({ ... });
-console.log(instance.my.key);  // 'hello'
+const instance = await MyModel.findOne({ /* ... */ });
+console.log(instance.my.key); // 'hello'
 ```
 
 For more details check out [the docs](http://mongoosejs.com/docs/queries.html).
@@ -241,7 +241,7 @@ const post = new BlogPost();
 // create a comment
 post.comments.push({ title: 'My comment' });
 
-post.save(function (err) {
+post.save(function(err) {
   if (!err) console.log('Success!');
 });
 ```
@@ -249,10 +249,10 @@ post.save(function (err) {
 The same goes for removing them:
 
 ```js
-BlogPost.findById(myId, function (err, post) {
+BlogPost.findById(myId, function(err, post) {
   if (!err) {
     post.comments[0].remove();
-    post.save(function (err) {
+    post.save(function(err) {
       // do something
     });
   }
@@ -273,7 +273,7 @@ You can intercept method arguments via middleware.
 For example, this would allow you to broadcast changes about your Documents every time someone `set`s a path in your Document to a new value:
 
 ```js
-schema.pre('set', function (next, path, val, typel) {
+schema.pre('set', function(next, path, val, typel) {
   // `this` is the current Document
   this.emit('set', path, val);
 
@@ -285,13 +285,13 @@ schema.pre('set', function (next, path, val, typel) {
 Moreover, you can mutate the incoming `method` arguments so that subsequent middleware see different values for those arguments. To do so, just pass the new values to `next`:
 
 ```js
-.pre(method, function firstPre (next, methodArg1, methodArg2) {
+schema.pre(method, function firstPre(next, methodArg1, methodArg2) {
   // Mutate methodArg1
-  next("altered-" + methodArg1.toString(), methodArg2);
+  next('altered-' + methodArg1.toString(), methodArg2);
 });
 
 // pre declaration is chainable
-.pre(method, function secondPre (next, methodArg1, methodArg2) {
+schema.pre(method, function secondPre(next, methodArg1, methodArg2) {
   console.log(methodArg1);
   // => 'altered-originalValOfMethodArg1'