Merge pull request #157 from TheSharks/feat/v2

Feat/v2

.eslintignore

@@ -7,3 +7,4 @@ ramda.path.js
 *.log
 *.md
 *.txt
+dist/*

.eslintrc.js

@@ -0,0 +1,21 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  extends: 'standard-with-typescript',
+  parserOptions: {
+    project: './tsconfig.json',
+    tsconfigRootDir: __dirname,
+    ecmaVersion: 2018,
+    sourceType: 'module'
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  plugins: [
+    'eslint-plugin-tsdoc'
+  ],
+  rules: {
+    'tsdoc/syntax': 'warn',
+    '@typescript-eslint/strict-boolean-expressions': ['error', {
+      allowNullableObject: true,
+      allowNullableString: true
+    }]
+  }
+}

.github/CODE_OF_CONDUCT.md

@@ -1,46 +1,134 @@
-# Contributor Covenant Code of Conduct 
-
-## Our Pledge 
-
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. 
-
-## Our Standards 
-
-Examples of behavior that contributes to creating a positive environment include: 
-
-* Using welcoming and inclusive language 
-* Being respectful of differing viewpoints and experiences 
-* Gracefully accepting constructive criticism 
-* Focusing on what is best for the community 
-* Showing empathy towards other community members 
-
-Examples of unacceptable behavior by participants include: 
-
-* The use of sexualized language or imagery and unwelcome sexual attention or advances 
-* Trolling, insulting/derogatory comments, and personal or political attacks 
-* Public or private harassment 
-* Publishing others' private information, such as a physical or electronic address, without explicit permission 
-* Other conduct which could reasonably be considered inappropriate in a professional setting 
-
-## Our Responsibilities 
-
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. 
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. 
-
-## Scope 
-
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. 
-
-## Enforcement 
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. 
-
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. 
-
-## Attribution 
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] 
-
-[homepage]: http://contributor-covenant.org 
-[version]: http://contributor-covenant.org/version/1/4/ 
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by 
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

.github/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 ### Thank you for displaying interest in contributing to JagTag-JS!
 
-For contributing, it's recommended to first clone the repository with **git clone https://github.com/TheSharks/JagTag-JS.git**.
+For contributing, it's recommended to first clone the repository with **`git clone https://github.com/TheSharks/JagTag-JS.git`**.
 
 Before you implement changes however, please consider the following.
 
@@ -14,20 +14,8 @@ You're free to implement changes that you believe will benefit the project in an
   - Pass the unit tests and have such written if necessary (See the **test** folder, more below), and
   - Be documented if it concerns the end user in some way.
 
-- Your documentation changes must...
-  - Be grammatically correct, and
-  - Not add extraneous material such as screenshots.
-
 ## Testing
 
-Make sure the development dependencies are installed. If you installed in production mode, run **npm i** again in order to get the devdeps. Then run **npm test** before you submit your PR. All tests must pass for the PR to be considered valid.
-
-**Note:** **npm run test-dev** and **npm run test-coverage** can be used for testing with watch mode enabled.
-
-## Documentation changes
-
-The documentation can be updated at any time without additional dependencies. However, it is strongly advised to check your changes in a preview before submitting them.
-
-To do so, you must install some additional dependencies. Windows users can use the provided **deps.bat** file for easy installation. Linux users can simply install the dependencies by running **python3.5 -m pip install --upgrade -r requirements.txt**. Both variants require that Python 3.5 is installed.
+Make sure the development dependencies are installed. If you installed in production mode, run **`npm i`** again in order to get the devdeps. Then run **`npm test`** before you submit your PR. All tests must pass for the PR to be considered valid.
 
-When the dependencies are installed, run **npm run start-docs** and browse to **http://localhost:8000** to preview your changes.
+**Note:** **`npm run test:watch`** and **`npm run test:coverage:watch`** can be used for testing with watch mode enabled.

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+ko_fi: dougley
+github: dougley

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 5
+
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly