Merge pull request #120 from Sykander/develop

Release 2.0.1

Author: Sykander

.eslintignore

@@ -1,2 +1,11 @@
 node_modules
-test/typings.js
+.env
+.DS_Store
+.nyc_output
+logs
+docs
+types
+reports
+
+playground
+package-lock.json

.eslintrc

@@ -0,0 +1,75 @@
+{
+	"parserOptions": {
+		"ecmaVersion": 2020
+	},
+	"env": {
+		"es6": true,
+		"node": true,
+		"mocha": true
+	},
+	"plugins": ["prettier", "jsdoc"],
+	"extends": ["eslint:recommended", "prettier", "plugin:jsdoc/recommended"],
+	"globals": {
+		"Atomics": "readonly",
+		"SharedArrayBuffer": "readonly"
+	},
+	"rules": {
+		"no-var": "error",
+		"no-await-in-loop": "error",
+		"no-console": "error",
+		"array-callback-return": ["error", { "allowImplicit": true }],
+		"complexity": ["error", 20],
+		"comma-dangle": "off",
+		"max-classes-per-file": ["error", 1],
+		"no-alert": "error",
+		"curly": "error",
+		"comma-spacing": ["error", { "before": false, "after": true }],
+		"prefer-arrow-callback": ["error", { "allowUnboundThis": false }],
+		"space-before-function-paren": [
+			"error",
+			{
+				"anonymous": "never",
+				"named": "never",
+				"asyncArrow": "always"
+			}
+		],
+		"semi": ["error", "always"],
+		"newline-per-chained-call": ["error", { "ignoreChainWithDepth": 2 }],
+		"eol-last": ["error", "always"],
+		"newline-before-return": "error",
+		"array-element-newline": ["error", "consistent"],
+		"global-require": "error",
+		"max-depth": ["error", 4],
+		"jsdoc/check-tag-names": ["error", { "definedTags": ["category"] }],
+		"jsdoc/newline-after-description": ["error", "never"],
+		"jsdoc/require-param-description": "off",
+		"jsdoc/require-param-type": "error",
+		"jsdoc/require-returns-description": "off",
+		"jsdoc/require-returns": [
+			"error",
+			{ "exemptedBy": ["async"], "forceReturnsWithAsync": false }
+		],
+		"jsdoc/no-undefined-types": "off",
+		"jsdoc/check-syntax": "error",
+		"jsdoc/check-indentation": "error",
+		"jsdoc/check-alignment": "error",
+		"prettier/prettier": "error"
+	},
+	"settings": {
+		"jsdoc": {
+			"tagNamePreference": {
+				"returns": "return",
+				"yields": "yield"
+			},
+			"preferredTypes": {
+				"object": "Object",
+				"array": "Array",
+				"boolean": "Boolean",
+				"string": "String",
+				"number": "Number",
+				"bigint": "BigInt",
+				"symbol": "Symbol"
+			}
+		}
+	}
+}

.eslintrc.json

@@ -2,5 +2,4 @@ node_modules
 .env
 .DS_Store
 .nyc_output
-logs
-test/typings.js
+logs

.gitignore

@@ -0,0 +1,9 @@
+{
+	"branches": 80,
+	"lines": 99,
+	"functions": 99,
+	"statements": 99,
+	"check-coverage": true,
+	"reporter": "html",
+	"report-dir": "docs/reports/coverage"
+}

.nycrc

@@ -1,2 +1,11 @@
 node_modules
-test/typings.js
+.env
+.DS_Store
+.nyc_output
+logs
+docs
+types
+reports
+
+playground
+package-lock.json

.nycrc.json

@@ -0,0 +1,10 @@
+{
+	"trailingComma": "none",
+	"useTabs": true,
+	"tabWidth": 4,
+	"semi": true,
+	"singleQuote": true,
+	"arrowParens": "avoid",
+	"bracketSpacing": true,
+	"quoteProps": "as-needed"
+}

.prettierignore

@@ -0,0 +1,55 @@
+# Contributing
+
+Development is open to contribution, check the project board "Development" for tickets.
+
+## Scripts
+
+| Script | Description |
+|--|--|
+| build | Builds the project docs, reports and types |
+| build:docs | Builds the project docs |
+| build:reports | Builds the project reports |
+| build:types | Builds the project types |
+| docs | Generates the docs and reports and then serves them locally |
+| docs:generate | Generates the docs and reports |
+| docs:show | Launches a http server to serve up the docs locally |
+| lint | Lints the project and returns a report |
+| lint:check | Returns a report on lint issues in the project |
+| lint:fix | Fixes lint issues in the project and returns a report on the ones which couldn't be fixed |
+| lint:report | Generates lint-summary.json in the reports folder |
+| test | Runs all tests and returns a report on which pass/fail |
+| test:unit-tests | Runs only unit tests and returns a report on which pass/fail |
+| test:code-style | Runs only code checks and returns a report on which pass/fail |
+| test:build-types | Attempt to build the project type declarations |
+| test:coverage | Generates coverage-summary.json in reports and confirms whether the coverage criteria is met |
+
+### Examples
+
+Run all lint tests
+``` sh
+ $ npm run lint
+```
+
+Serve docs locally
+``` sh
+ $ npm run docs
+```
+
+## Commit Rules
+
+* All commits should pass the lint check commands
+* Commit messages should follow below format
+
+```
+Ticket Title
+- What you did
+- What else you did
+```
+
+## Ticket Rules
+
+* All code must pass the lint check
+* All code should pass all tests
+* All bugfixes should have a new test
+* All code should be fully documented using JsDoc
+* All PRs must be code reviewed