Merge pull request #14 from AthennaIO/develop

Move to ESM

.editorconfig

@@ -10,4 +10,4 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 
 [*.md]
-trim_trailing_whitespace = false
+trim_trailing_whitespace = false

.github/COMMIT_CONVENTION.md

@@ -1,16 +1,13 @@
 ## Git Commit Message Convention
 
-Using conventional commit messages, we can automate the process of generating the CHANGELOG file. All commits messages
-will automatically be validated against the following regex.
+Using conventional commit messages, we can automate the process of generating the CHANGELOG file. All commits messages will automatically be validated against the following regex.
 
 ``` js
 /^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|ci|chore|types|build|improvement)((.+))?: .{1,50}/
 ```
 
 ## Commit Message Format
-
-A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **
-subject**:
+A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
 
 > The **scope** is optional
 
@@ -27,7 +24,6 @@ Prefix makes it easier to append a path to a group of routes
 5. The optional **footer** can be added after the body, followed by a blank line.
 
 ## Types
-
 Only one type can be used at a time and only following types are allowed.
 
 - feat
@@ -43,21 +39,15 @@ Only one type can be used at a time and only following types are allowed.
 - types
 - build
 
-If a type is `feat` or `fix`, then the commit will appear in the CHANGELOG.md file. However if there is any BREAKING
-CHANGE, the commit will always appear in the changelog.
+If a type is `feat` or `fix`, then the commit will appear in the CHANGELOG.md file. However if there is any BREAKING CHANGE, the commit will always appear in the changelog.
 
 ### Revert
-
-If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit.
-In the body it should say: `This reverts commit <hash>`., where the hash is the SHA of the commit being reverted.
+If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>`., where the hash is the SHA of the commit being reverted.
 
 ## Scope
-
-The scope could be anything specifying place of the commit change. For example: `router`, `view`, `querybuilder`
-, `database`, `model` and so on.
+The scope could be anything specifying place of the commit change. For example: `router`, `view`, `querybuilder`, `database`, `model` and so on.
 
 ## Subject
-
 The subject contains succinct description of the change:
 
 - use the imperative, present tense: "change" not "changed" nor "changes".
@@ -66,13 +56,12 @@ The subject contains succinct description of the change:
 
 ## Body
 
-Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". The body should
-include the motivation for the change and contrast this with previous behavior.
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
 
 ## Footer
 
-The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues
-that this commit **Closes**.
+The footer should contain any information about **Breaking Changes** and is also the place to
+reference GitHub issues that this commit **Closes**.
 
-**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit
-message is then used for this.
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.

.github/FUNDING.yml

@@ -1 +1 @@
-open_collective: athenna
+open_collective: athennaio

.github/ISSUE_TEMPLATE.md

@@ -1,22 +1,5 @@
-<!-- CLICK "Preview" FOR INSTRUCTIONS IN A MORE READABLE FORMAT -->
+## 👉 [Please follow one of these issue templates](https://github.com/AthennaIO/Artisan/issues/new/choose) 👈
 
-## Prerequisites
+<!-- Love Athenna? Please consider supporting our collective: 👉  https://opencollective.com/athenna/donate -->
 
-- Ensure the issue isn't already reported.
-- Ensure you are reporting the bug in the correct repository.
-
-*Delete the above section and the instructions in the sections below before submitting*
-
-## Description
-
-If this is a feature request, explain why it should be added. Specific use-cases and problems that it solve are best.
-
-For bug reports, please provide as much *relevant* info as possible.
-
-## Package version
-
-<!-- YOUR ANSWER -->
-
-## Error Message & Stack Trace
-
-## Relevant Information
+Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates.

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,96 @@
+name: Bug Report 🪲
+description: Create a bug report to help us improve.
+title: '[Bug]: '
+labels: ['bug']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # Please follow these steps first:
+  - type: markdown
+    attributes:
+      value: |
+        ## Troubleshoot
+        If Athenna is not behaving the way you expect, we'd ask you to look at the [documentation](https://athenna.io/docs/getting-started) and search the issue tracker for evidence supporting your expectation. Please make reasonable efforts to troubleshoot and rule out issues with your code, the configuration, or any 3rd party libraries you might be using.
+  - type: markdown
+    attributes:
+      value: |
+        ## Ask for help through appropriate channels
+        If you feel unsure about the cause of the problem, consider asking for help on for example [StackOverflow](https://stackoverflow.com/questions/ask) or our [Discord](https://discord.gg/mZyBkA936X) before posting a bug report. The issue tracker is not a help forum.
+  - type: markdown
+    attributes:
+      value: |
+        ## Make a minimal reproduction
+        To file the report, you will need a GitHub repository with a minimal (but complete) example and simple/clear steps on how to reproduce the bug.
+
+        The simpler you can make it, the more likely we are to successfully verify and fix the bug.
+  - type: markdown
+    attributes:
+      value: |
+        :bangbang:   Bug reports without a minimal reproduction will be rejected. :bangbang:
+
+        ---
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: |
+        The version you are using.
+        Is it the [latest](https://github.com/AthennaIO/Artisan/releases)? Test and see if the bug has already been fixed.
+      placeholder: ex. 1.0.0
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to reproduce
+      description: Please link to a repository with a minimal reproduction and describe accurately how we can reproduce/verify the bug.
+      placeholder: |
+        Example steps (replace with your own):
+        1. Clone my repository at: https://github.com/<myuser>/example
+        2. npm run install
+        3. npm run start (You should see the error come up)
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: A description of what you expect to happen.
+      placeholder: I expect to see X or Y
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Actual behavior
+      description: A clear and concise description of the unexpected behavior.
+      placeholder: A bug happened!
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Anything else that might be relevant
+    validations:
+      required: false
+  - type: textarea
+    id: envinfo
+    attributes:
+      label: Environment
+      description: |
+        Please paste the output of running `npx envinfo --system --binaries`.
+        This will be automatically formatted as a code block, so no need for backticks.
+      placeholder: |
+        System:
+          OS: macOS 12.3.1
+          CPU: (8) arm64 Apple M1 Pro
+          Memory: 130.23 MB / 16.00 GB
+          Shell: 5.8 - /opt/homebrew/bin/zsh
+        Binaries:
+          Node: 16.13.1 - ~/.nvm/versions/node/v16.13.1/bin/node
+          npm: 8.1.2 - ~/.nvm/versions/node/v16.13.1/bin/npm
+      render: Shell
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,30 @@
+name: Feature Proposal 🚀
+description: Submit a proposal for a new feature.
+title: '[Feature]: '
+labels: ['feature']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ### Thank you for taking the time to suggest a new feature!
+  - type: textarea
+    id: description
+    attributes:
+      label: '🚀 Feature Proposal'
+      description: A clear and concise description of what the feature is.
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Motivation
+      description: Outline your motivation for the proposal. How will it make @athenna/artisan better?
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Example
+      description: Describe how this feature would be used.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,27 @@
+name: 'Questions / Help 💬'
+description: If you have questions, please check Discord or StackOverflow.
+title: '[Please read the message below]'
+labels: ['question']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Questions and Help 💬
+
+        This issue tracker is reserved for bug reports and feature proposals.
+
+        For anything else, such as questions or getting help, please see:
+
+        - [The Athenna help page](https://athenna.io/help)
+        - [Our `#help` channel in Discord](https://discord.gg/j6FKKQQrW9)
+        - The [AthennaIO](https://stackoverflow.com/questions/tagged/AthennaIO) tag on [StackOverflow](https://stackoverflow.com/questions/ask)
+  - type: checkboxes
+    id: no-post
+    attributes:
+      label: |
+        Please do not submit this issue.
+      description: |
+        :bangbang:   This issue will be closed. :bangbang:
+      options:
+        - label: I understand
+          required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,8 +2,9 @@
 
 ## Proposed changes
 
-Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.
-If it fixes a bug or resolves a feature request, be sure to link to that issue.
+Describe the big picture of your changes here to communicate to the 
+maintainers why we should accept this pull request. If it fixes a bug 
+or resolves a feature request, be sure to link to that issue.
 
 ## Types of changes
 
@@ -17,9 +18,10 @@ _Put an `x` in the boxes that apply_
 
 ## Checklist
 
-_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of
-them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before
-merging your code._
+_Put an `x` in the boxes that apply. You can also fill these out after 
+creating the PR. If you're unsure about any of them, don't hesitate to ask. 
+We're here to help! This is simply a reminder of what we are going to look 
+for before merging your code._
 
 - [ ] I have read the [CONTRIBUTING](https://github.com/AthennaIO/Artisan/blob/master/CONTRIBUTING.md) documentation
 - [ ] Lint and unit tests pass locally with my changes
@@ -28,5 +30,6 @@ merging your code._
 
 ## Further comments
 
-If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you
-did and what alternatives you considered, etc...
+If this is a relatively large or complex change, kick off the discussion by 
+explaining why you chose the solution you did and what alternatives you 
+considered, etc...

.github/SUPPORT.md

@@ -0,0 +1,3 @@
+Please note this issue tracker is not a help forum. We recommend using [StackOverflow](https://stackoverflow.com/questions/tagged/athennaio) or [Discord channel](https://discord.gg/mZyBkA936X) for questions.
+
+<!-- Love Athenna? Please consider supporting our collective: 👉  https://opencollective.com/athennaio/donate -->

.github/workflows/cd.yml

@@ -20,8 +20,6 @@ jobs:
 
       - name: Install dependencies
         run: npm install
-      - name: Transpile typescript to javascript
-        run: npm run build
       - name: Automatic GitHub Release
         uses: justincy/[email protected]
         id: release

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
       matrix:
         node-version:
           - 14.15.4
-          - 17.x
+          - 18.x
     steps:
       - uses: actions/checkout@v2
         with:
@@ -28,17 +28,15 @@ jobs:
       - name: Install dependencies
         run: npm install
       - name: Run tests
-        run: npm run test
-      - name: Test the compiler
-        run: npm run build
+        run: npm run test:coverage
 
   windows:
     runs-on: windows-latest
     strategy:
       matrix:
         node-version:
           - 14.15.4
-          - 17.x
+          - 18.x
     steps:
       - uses: actions/checkout@v2
         with:
@@ -51,6 +49,4 @@ jobs:
       - name: Install dependencies
         run: npm install
       - name: Run tests
-        run: npm run test
-      - name: Test the compiler
-        run: npm run build
+        run: npm run test:coverage

.gitignore

@@ -24,6 +24,7 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+Coverage
 *.lcov
 
 # nyc test coverage
@@ -122,17 +123,5 @@ out
 .env.testing
 .env.production
 
-# Build files
-*.js
-*.d.ts
-dist
-build
-
 # MacOS folder mapper file
 .DS_Store
-
-# Testing stubs that could fail
-./app
-./config
-./routes
-./providers