Automattic · Nov 10, 2015 · Nov 10, 2015 · Nov 10, 2015 · Nov 10, 2015 · Nov 10, 2015
Showing 817 changed files with 128,202 additions and 90,903 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,3 +1,10 @@
 docs/
 bin/
 test/triage/
+tools/
+test/es-next/
+test/files/
+dist/
+benchmarks/
+
+search.js
diff --git a/.eslintrc b/.eslintrc
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+github: vkarpov15
+open_collective: mongoose
+tidelift: npm/mongoose
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,16 @@
+<!-- *Before creating an issue please make sure you are using the latest version of mongoose -->
+
+**Do you want to request a *feature* or report a *bug*?**
+
+**What is the current behavior?**
+
+**If the current behavior is a bug, please provide the steps to reproduce.**
+<!-- If you can, provide a standalone script / gist to reproduce your issue. -->
+
+<!-- If you are using TypeScript, please include your `tsconfig.json` -->
+
+**What is the expected behavior?**
+
+**What are the versions of Node.js, Mongoose and MongoDB you are using? Note that "latest" is not a version.**
+
+<!-- You can print `mongoose.version` to get your current version of Mongoose: https://mongoosejs.com/docs/api.html#mongoose_Mongoose-version -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,11 @@
+Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. The two fields below are mandatory.
+
+If you're making a change to documentation, do **not** modify a `.html` file directly. Instead find the corresponding `.pug` file or test case in the `test/docs` directory.
+
+**Summary**
+
+<!-- Explain the **motivation** for making this change. What problem does the pull request solve? -->
+
+**Examples**
+
+<!-- If this code fixes a bug or adds a new feature, provide an example demonstrating the change, unless you added a test. -->
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,56 @@
+name: Test
+on:
+    pull_request:
+    push:
+jobs:
+  test:
+    runs-on: ubuntu-18.04
+    strategy:
+      fail-fast: false
+      matrix:
+        node: [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
+    name: Node ${{ matrix.node }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Upgrade Node 5 npm
+        run: npm install -g npm@3
+        if: ${{ matrix.node == 5 }}
+
+      - run: npm install
+
+      - name: Setup
+        run: |
+          wget -q http://downloads.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1804-4.0.2.tgz
+          tar xf mongodb-linux-x86_64-ubuntu1804-4.0.2.tgz
+          mkdir -p ./data/db/27017 ./data/db/27000
+          printf "\n--timeout 8000" >> ./test/mocha.opts
+          ./mongodb-linux-x86_64-ubuntu1804-4.0.2/bin/mongod --fork --dbpath ./data/db/27017 --syslog --port 27017
+          sleep 2
+          mongod --version
+          mkdir ./test/typescript/node_modules
+          ln -s `pwd` ./test/typescript/node_modules/mongoose
+          echo `pwd`/mongodb-linux-x86_64-ubuntu1804-4.0.2/bin >> $GITHUB_PATH
+
+      - run: npm test
+
+  lint:
+    runs-on: ubuntu-latest
+    name: Linter
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14
+
+      - run: npm install
+
+      - name: Linter
+        run: npm run lint
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
 lib-cov
-**.swp
+*.swp
 *.sw*
 node_modules/
 *.orig
@@ -10,18 +10,36 @@ benchmarks/v8.log
 .DS_Store
 docs/*.json
 docs/source/_docs
-docs/*.html
 tags
 test/triage/*.js
 /.idea
 /inspections
 bin/mongoose.min.js
 coverage
 npm-debug.log
+data/
+.nyc_output/
+
+tools/31*
 
 # Visual Studio
 # =========
 *.suo
 *.ntvs*
 *.njsproj
 *.sln
+
+# Visual Studio Code
+.vscode
+
+*.key
+
+docs/*.html
+
+# Webpack output
+dist
+test/files/main.js
+
+package-lock.json
+
+.config*
diff --git a/.npmignore b/.npmignore
@@ -10,7 +10,30 @@ test/
 Makefile
 CNAME
 index.html
-index.jade
+index.pug
 bin/
-karma.*.js
+tools/31*
+*.key
+data/
+
+*.txt
+*.png
+
+examples/
+.github
+.vscode
+.eslintignore
+CONTRIBUTING.md
+History.*
 format_deps.js
+release-items.md
+static.js
+website.js
+
+.config*
+
+migrating_to_5.md
+renovate.json
+.travis.yml
+webpack.config.js
+webpack.base.config.js
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/.travis.yml b/.travis.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,58 +1,85 @@
 ## Contributing to Mongoose
 
-If you have a question about Mongoose (not a bug report) please post it to either [StackOverflow](http://stackoverflow.com/questions/tagged/mongoose), our [Google Group](http://groups.google.com/group/mongoose-orm), or on the #mongoosejs irc channel on freenode.
+If you have a question about Mongoose (not a bug report) please post it to either [StackOverflow](http://stackoverflow.com/questions/tagged/mongoose), or on [Gitter](https://gitter.im/Automattic/mongoose?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 ### Reporting bugs
 
-- Before opening a new issue, look for existing [issues](https://github.com/learnboost/mongoose/issues) to avoid duplication. If the issue does not yet exist, [create one](https://github.com/learnboost/mongoose/issues/new).
-  - Please describe the issue you are experiencing, along with any associated stack trace.
-  - Please post code that reproduces the issue, the version of mongoose, node version, and mongodb version.
-  - _The source of this project is written in javascript, not coffeescript, therefore your bug reports should be written in javascript_. 
-  - In general, adding a "+1" comment to an existing issue does little to help get it resolved. A better way is to submit a well documented pull request with clean code and passing tests.
+- Before opening a new issue, look for existing [issues](https://github.com/Automattic/mongoose/issues) to avoid duplication. If the issue does not yet exist, [create one](https://github.com/Automattic/mongoose/issues/new).
+  - Please post any relevant code samples, preferably a standalone script that
+  reproduces your issue. Do **not** describe your issue in prose. **Show your code.**
+  - If the bug involves an error, please post the stack trace.
+  - Please post the version of Mongoose and MongoDB that you're using.
+  - Please write bug reports in JavaScript (ES5, ES6, etc) that runs in Node.js, **not** CoffeeScript, TypeScript, JSX, etc.
 
 ### Requesting new features
 
 - Before opening a new issue, look for existing [issues](https://github.com/learnboost/mongoose/issues) to avoid duplication. If the issue does not yet exist, [create one](https://github.com/learnboost/mongoose/issues/new).
 - Please describe a use case for it
-- it would be ideal to include test cases as well
-- In general, adding a "+1" comment to an existing issue does little to help get it resolved. A better way is to submit a well documented pull request with clean code and passing tests.
+- Please include test cases if possible
 
 ### Fixing bugs / Adding features
 
 - Before starting to write code, look for existing [issues](https://github.com/learnboost/mongoose/issues). That way you avoid working on something that might not be of interest or that has been addressed already in a different branch. You can create a new issue [here](https://github.com/learnboost/mongoose/issues/new).
-  - _The source of this project is written in javascript, not coffeescript, therefore your bug reports should be written in javascript_. 
-- Fork the [repo](https://github.com/learnboost/mongoose) _or_ for small documentation changes, navigate to the source on github and click the [Edit](https://github.com/blog/844-forking-with-the-edit-button) button.
+  - _The source of this project is written in JavaScript, not CoffeeScript or TypeScript. Please write your bug reports in JavaScript that can run in vanilla Node.js_.
+- Fork the [repo](https://github.com/Automattic/mongoose) _or_ for small documentation changes, navigate to the source on github and click the [Edit](https://github.com/blog/844-forking-with-the-edit-button) button.
 - Follow the general coding style of the rest of the project:
   - 2 space tabs
   - no trailing whitespace
-  - comma first
-  - inline documentation for new methods, class members, etc
-  - 1 space between conditionals/functions, and their parenthesis and curly braces
+  - inline documentation for new methods, class members, etc.
+  - 1 space between conditionals, no space before function parenthesis
     - `if (..) {`
     - `for (..) {`
     - `while (..) {`
-    - `function (err) {`
-- Write tests and make sure they pass (tests are in the [test](https://github.com/LearnBoost/mongoose/tree/master/test) directory).
+    - `function(err) {`
+- Write tests and make sure they pass (tests are in the [test](https://github.com/Automattic/mongoose/tree/master/test) directory).
 
 ### Running the tests
 - Open a terminal and navigate to the root of the project
 - execute `npm install` to install the necessary dependencies
-- execute `make test` to run the tests (we're using [mocha](http://visionmedia.github.com/mocha/))
-  - or to execute a single test `T="-g 'some regexp that matches the test description'" make test`
-  - any mocha flags can be specified with `T="..."`
+- start a MongoDB instance on port 27017 if one isn't running already. `mongod --dbpath <path to store data>`. We typically use [MongoDB Enterprise](https://www.mongodb.com/try/download/enterprise) with the [in-memory storage engine](https://docs.mongodb.com/manual/core/inmemory/) in order to run tests faster.
+- execute `npm test` to run the tests (we're using [mocha](http://mochajs.org/))
+  - or to execute a single test `npm test -- -g 'some regexp that matches the test description'`
+  - any mocha flags can be specified with `-- <mocha flags here>`
+  - For example, you can use `npm test -- -R spec` to use the spec reporter, rather than the dot reporter (by default, the test output looks like a bunch of dots)
 
 ### Documentation
 
-To contribute to the [API documentation](http://mongoosejs.com/docs/api.html) just make your changes to the inline documentation of the appropriate [source code](https://github.com/LearnBoost/mongoose/tree/master/lib) in the master branch and submit a [pull request](https://help.github.com/articles/using-pull-requests/). You might also use the github [Edit](https://github.com/blog/844-forking-with-the-edit-button) button.
+To contribute to the [API documentation](http://mongoosejs.com/docs/api.html) just make your changes to the inline documentation of the appropriate [source code](https://github.com/Automattic/mongoose/tree/master/lib) in the master branch and submit a [pull request](https://help.github.com/articles/using-pull-requests/). You might also use the github [Edit](https://github.com/blog/844-forking-with-the-edit-button) button.
+
+To contribute to the [guide](http://mongoosejs.com/docs/guide.html) or [quick start](http://mongoosejs.com/docs/index.html) docs, make your changes to the appropriate `.pug` files in the [docs](https://github.com/Automattic/mongoose/tree/master/docs) directory of the master branch and submit a pull request. Again, the [Edit](https://github.com/blog/844-forking-with-the-edit-button) button might work for you here.
 
-To contribute to the [guide](http://mongoosejs.com/docs/guide.html) or [quick start](http://mongoosejs.com/docs/index.html) docs, make your changes to the appropriate `.jade` files in the [docs](https://github.com/LearnBoost/mongoose/tree/master/docs) directory of the master branch and submit a pull request. Again, the [Edit](https://github.com/blog/844-forking-with-the-edit-button) button might work for you here.
+If you'd like to preview your documentation changes, first commit your changes to your local master branch, then execute:
 
-If you'd like to preview your documentation changes, first commit your changes to your local master branch, then execute `make docs` from the project root, which switches to the gh-pages branch, merges from the master branch and builds all the static pages for you. Now execute `node static.js` from the project root which will launch a local webserver where you can browse the documentation site locally. If all looks good, submit a [pull request](https://help.github.com/articles/using-pull-requests/) to the master branch with your changes.
+* `npm install`
+* `make docclean`
+* `make gendocs`
+* `node static.js`
+
+Visit `http://localhost:8088` and you should see the docs with your local changes. Make sure you `git reset --hard` before committing, because changes to `docs/*` should **not** be in PRs.
 
 ### Plugins website
 
-The [plugins](http://plugins.mongoosejs.com/) site is also an [open source project](https://github.com/aheckmann/mongooseplugins) that you can get involved with. Feel free to fork and improve it as well!
+The [plugins](http://plugins.mongoosejs.io/) site is also an [open source project](https://github.com/vkarpov15/mongooseplugins) that you can get involved with. Feel free to fork and improve it as well!
+
+
+## Financial contributions
+
+We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/mongoose).
+Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
+
+
+## Credits
+
+
+### Contributors
+
+Thank you to all the people who have already contributed to mongoose!
+<a href="https://github.com/Automattic/mongoose/graphs/contributors"><img src="https://opencollective.com/mongoose/contributors.svg?width=890" /></a>
+
+
+### Backers
+
+Thank you to all our backers! [[Become a backer](https://opencollective.com/mongoose#backer)]
 
-### Sharing your projects
+<a href="https://opencollective.com/mongoose#backers" target="_blank"><img src="https://opencollective.com/mongoose/backers.svg?width=890"></a>
 
-All are welcome to share their creations which use mongoose on our [tumbler](http://mongoosejs.tumblr.com/). Just fill out the [simple submission form](http://mongoosejs.tumblr.com/submit).