Merge branch 'docs/createDocs' into beta

Author: hasezoey

.github/CONTRIBUTING.md

@@ -43,14 +43,13 @@ Must be one of the following:
 * **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
 * **revert**: Revert an commit
 * **dependencies**: Update field `dependencies` (/ `devDependencies`)
-* **release**: An Release Commit
+* **release**: A Release Commit
 
 look into [releaserc](../.releaserc.js) for corresponding versions
 
 ### Scope
 
-The scope could be anything specifying place of the commit change. For example `$location`,
-`$browser`, `$compile`, `$rootScope`, `ngHref`, `ngClick`, `ngView`, etc...
+The scope should be the file that got modified, if multiple files then use no scope.
 
 You can use `*` when the change affects more than a single scope.
 
@@ -102,3 +101,13 @@ If the interface/type/enum is an "standalone" then it should be named appropriat
 
 Source file names should be `PascalCase` if the main export is an class (example: `MongoBinary`, and not `Mongo-Binary`)
 Source file names should be `camelCase` if there is no "definitive main export" (example: `resolveConfig` & `utils`)
+
+## Documentation
+
+If being new to markdown / docusaurus / Infima styling, look at the following sources:
+
+* [Markdown Basics](https://guides.github.com/features/mastering-markdown/)
+* [Docusaurus](https://v2.docusaurus.io/docs/)
+* [Infima](https://facebookincubator.github.io/infima/) (is currently not up, needs to be run locally)
+
+There is also an File in this project to view basic elements in the projects styles: [Test Page Source](../docs/test.md) [Test Page Website]() <!--TODO: replace with actual website-->

.github/workflows/tests.yml

@@ -21,10 +21,13 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         if: github.event.inputs.git-ref == ''
+        with:
+          fetch-depth: 0 # always fetch everything to be sure for codecov
       - uses: actions/checkout@v2
         if: github.event.inputs.git-ref != ''
         with:
           ref: ${{ github.event.inputs.git-ref }}
+          fetch-depth: 5 # because this is an manual trigger, only fetch the latest 5
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v1
         with:

.github/workflows/website.yml

@@ -0,0 +1,29 @@
+name: Deploy Github Pages
+
+on:
+  push:
+    branches:
+      - 'master'
+      - '!gh-pages'
+    paths: # only run this deploy if an file in the following directories are changed
+      - 'docs/**'
+      - 'website/**'
+
+jobs:
+  website:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js 14
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14.x
+      - name: Install & Build
+        run: bash ./ghPagesPre.sh
+      - name: Deploy to Github Pages
+        uses: JamesIves/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages
+          FOLDER: . # the root, because the provided script already moves files

CHANGELOG.md

@@ -130,7 +130,7 @@
 * **MongoBinaryDownloadUrl:** add case for Linux Mint 20 ([01a6bc6](https://github.com/nodkz/mongodb-memory-server/commit/01a6bc63f0e13a4528ee39ccae64390a8de48582))
 * **MongoBinaryDownloadUrl:** detect "linuxmint" and "linux mint" as linux mint ([fda4f72](https://github.com/nodkz/mongodb-memory-server/commit/fda4f7224d156680ac68c743c5a5a963070171dd)), closes [#403](https://github.com/nodkz/mongodb-memory-server/issues/403)
 * **MongoBinaryDownloadUrl:** fix win32 download generation ([d62b489](https://github.com/nodkz/mongodb-memory-server/commit/d62b4891a01fe40b5f00c21ee02f08b24a55d80c)), closes [#399](https://github.com/nodkz/mongodb-memory-server/issues/399)
-* **MongoBinaryDownloadUrl:** getArchiveName: throw error if platform is unkown ([9fc358b](https://github.com/nodkz/mongodb-memory-server/commit/9fc358b9b2997333b2121eabff16e91e543f3897))
+* **MongoBinaryDownloadUrl:** getArchiveName: throw error if platform is unknown ([9fc358b](https://github.com/nodkz/mongodb-memory-server/commit/9fc358b9b2997333b2121eabff16e91e543f3897))
 * **MongoInstance:** handle code "12" on windows ([718aed7](https://github.com/nodkz/mongodb-memory-server/commit/718aed7281c25c7198ea068a87b06924d77de8ba)), closes [#411](https://github.com/nodkz/mongodb-memory-server/issues/411)
 
 

README.md

@@ -52,6 +52,8 @@ Works perfectly [with Travis CI](https://github.com/nodkz/graphql-compose-mongoo
   - [Enable Debug Mode](#enable-debug-mode)
 - [CI](#ci)
 - [Contributing](#contributing)
+- [Join Our Discord Server](#join-our-discord-server)
+- [Documentation](#documentation)
 - [Credits](#credits)
 - [Maintainers](#maintainers)
 - [Contributors](#contributors)
@@ -576,6 +578,15 @@ script:
 
 Contributing Guidelines are setup in [CONTRIBUTING](./.github/CONTRIBUTING.md)
 
+## Join Our Discord Server
+
+To ask questions or just talk with us, [join our Discord Server](https://discord.gg/BpGjTTD).
+
+## Documentation
+
+- [Documentation](https://nodkz.github.io/mongodb-memory-server/docs/api/index-api)
+- [Quick start guide](https://nodkz.github.io/mongodb-memory-server/docs/guides/quick-start-guide/)
+
 ## Credits
 
 Inspired by alternative runners for [mongodb-prebuilt](https://github.com/winfinit/mongodb-prebuilt):

docs/api/index.md

@@ -0,0 +1,6 @@
+---
+id: index-api
+title: 'Welcome to the API'
+---
+
+In `API` will be documented what functions & values do, even internal `protected` / `private` ones

docs/api/mongobinary.md

@@ -0,0 +1,39 @@
+---
+id: mongo-binary
+title: 'MongoBinary'
+---
+
+API Documentation of `MongoBinary`-Class
+
+## Functions
+
+:::note
+This class is not actually meant to be constructed, it only consists of static functions & values
+:::
+
+### getSystemPath
+
+Typings: `static async getSystemPath(systemBinary: string): Promise<string | undefined>`
+
+Try to stat the given `systemBinary` path, and return it if successfull, otherwise `undefined`
+
+### getDownloadPath
+
+Typings: `static async getDownloadPath(options: Required<MongoBinaryOpts>): Promise<string>`
+
+Get an binary from cache or download it
+
+### getPath
+
+Typings: `static async getPath(opts: MongoBinaryOpts = {}): Promise<string>`
+
+Get an working binary and returns the path to it<br/>
+(Calls [`getDownloadPath`](#getdownloadpath))
+
+## Values
+
+### cache
+
+Typings: `static cache: Map<string, string>`
+
+Global Cache for binaries

docs/api/mongoinstance.md

@@ -0,0 +1,155 @@
+---
+id: mongo-instance
+title: 'MongoInstance'
+---
+
+API Documentation of `MongoInstance`-Class
+
+## Functions
+
+### new
+
+Typings: `constructor(opts: Partial<MongodOpts>)`
+
+Create an new Instance without starting it
+
+:::tip
+When directly starting the instance, [`run`](#static-run) should be used
+:::
+
+### debug
+
+Typings: `private debug(msg: string): void`
+
+Format input with debug-message template
+
+### static-run
+
+Typings: `static async run(opts: Partial<MongodOpts>): Promise<MongoInstance>`
+
+Create an new Instance and start it (while being an Promise)
+
+### prepareCommandArgs
+
+Typings: `prepareCommandArgs(): string[]`
+
+Constructs the Command Arguments
+
+### run
+
+Typings: `async run(): Promise<this>`
+
+Start the `mongod` process
+
+### kill
+
+Typings: `async kill(): Promise<MongoInstance>`
+
+Stop the `mongod` process
+
+:::caution
+Will not Error if instance is not running
+:::
+
+### _launchMongod
+
+<span class="badge badge--warning">Internal</span>
+
+Typings: `_launchMongod(mongoBin: string): ChildProcess`
+
+Actually spawn the `mongod` process with `ChildProcess`, used by [`run`](#run)
+
+### _launchKiller
+
+<span class="badge badge--warning">Internal</span>
+
+Typings: `_launchKiller(parentPid: number, childPid: number): ChildProcess`
+
+Spawn an killer process that keeps watch over the `mongod` process
+
+### errorHandler
+
+<span class="badge badge--warning">Internal</span>
+
+Typings: `errorHandler(err: string): void`
+
+Error handler for the `mongod` process
+
+### closeHandler
+
+<span class="badge badge--warning">Internal</span>
+
+Typings: `closeHandler(code: number): void`
+
+Close handler for the `mongod` process
+
+### stderrHandler
+
+<span class="badge badge--warning">Internal</span>
+
+Typings: `stderrHandler(message: string | Buffer): void`
+
+STDERR handler for the `mongod` process
+
+### stdoutHandler
+
+<span class="badge badge--warning">Internal</span>
+
+Typings: `stdoutHandler(message: string | Buffer): void`
+
+STDOUT handler for the `mongod` process<br/>
+Matches process output against known formats and raise events
+
+## Values
+
+### instanceOpts
+
+Typings: `instanceOpts: MongoInstanceOpts`
+
+Stores the Instance Options
+
+### binaryOpts
+
+Typings: `readonly binaryOpts: Readonly<MongoBinaryOpts>`
+
+Stores the Binary Options
+
+### spawnOpts
+
+Typings: `readonly spawnOpts: Readonly<SpawnOptions>`
+
+Stores the Spawn Options
+
+### childProcess
+
+<span class="badge badge--warning">Internal</span>
+
+Typings: `childProcess?: ChildProcess`
+
+Stores the active process reference for the `mongod` process
+
+### killerProcess
+
+<span class="badge badge--warning">Internal</span>
+
+Typings: `killerProcess?: ChildProcess`
+
+Stores the active process reference for the killer process
+
+### isInstancePrimary
+
+Typings: `isInstancePrimary: boolean`
+
+Stores that the process is an Primary (ReplSet)
+
+### isInstanceReady
+
+Typings: `isInstanceReady: boolean`
+
+Stores that the process is fully started
+
+### isReplSet
+
+Typings: `isReplSet: boolean`
+
+Stores that the process is in an ReplSet