Merge pull request #16 from jankapunkt/feature-config-and-docs

Extended config and docs

.github/FUNDING.yml

@@ -0,0 +1,14 @@
+# These are supported funding model platforms
+
+github:
+   - jankapunkt
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom:
+   - https://paypal.me/kuesterjan

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,65 @@
+<!-- --------------------------------------------------------------------------- 
+
+🎉 THANK YOU FOR YOUR CONTRIBUTION! 🎉
+
+We highly appreciate your time and effort to this project!
+
+
+⚠ PLEASE READ THIS FIRST ⚠
+
+1. If this is a fix for a security vulnerability you discovered please don't 
+just open this PR until we have privately discussed the vulnerability. Disclosing 
+it without contacting us can lead to severe implications for many applications 
+that run on this project.
+
+2. Make sure you have read the contribution guidelines for this project in
+order to raise the chance of getting your PR accepted. This saves you valuable 
+time and effort.
+
+3. The following structure is a basic guideline. If a section does not apply you
+can remove it.
+---------------------------------------------------------------------------- -->
+
+## Summary
+<!-- ---------------------------------------------------------------------------
+⚠ Provide one or two paragraphs
+---------------------------------------------------------------------------- -->
+
+
+
+## Linked issue(s)
+<!-- ---------------------------------------------------------------------------
+⚠ If there is no issue for this PR we won't review it
+---------------------------------------------------------------------------- -->
+
+
+
+## Involved parts of the project
+<!-- ---------------------------------------------------------------------------
+⚠ Which parts of the code is affected and which OAuth2 workflows are involved
+---------------------------------------------------------------------------- -->
+
+
+
+## Added tests?
+<!-- ---------------------------------------------------------------------------
+⚠ Did you add tests that cover your changes?
+---------------------------------------------------------------------------- -->
+
+
+
+## Webspeech API standard
+<!-- ---------------------------------------------------------------------------
+⚠ This section is important in order to review compliance with the standard(s).
+Please refer to the standard if your PR affects any functionality or is 
+otherwise related to the standard(s) in any way
+---------------------------------------------------------------------------- -->
+
+
+
+## Reproduction
+<!-- ---------------------------------------------------------------------------
+⚠ How can we reproduce your changes in an app? This is especially important
+when new features are added
+---------------------------------------------------------------------------- -->
+

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL Semantic Analysis"
+
+on:
+  push:
+    branches:
+      - master
+  pull_request: # all PR
+  schedule:
+    - cron: '0 2 * * *' # every night at 2am
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: true
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    # - name: Autobuild
+    #  uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/publish.yml

@@ -0,0 +1,59 @@
+name: Publish packages
+
+on:
+  push:
+    branches:
+      - master
+      - release-*
+  pull_request:
+    branches:
+      - master
+      - release-*
+
+jobs:
+  docs:
+    name: Build docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - name: setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - run: npm ci
+      - run: npm run docs
+
+  build:
+    name: Build bundle and publish
+    runs-on: ubuntu-latest
+    needs: [docs]
+    steps:
+      - name: Checkout ${{ matrix.node }}
+        uses: actions/checkout@v3
+
+      - name: Setup node ${{ matrix.node }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: Cache dependencies ${{ matrix.node }}
+        uses: actions/cache@v3
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ matrix.node }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-${{ matrix.node }}
+      - run: | 
+          npm ci
+          npm run build
+          npm publish --dry-run

.github/workflows/testsuite.yml

@@ -27,7 +27,7 @@ jobs:
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-
-      - run: npm install
+      - run: npm ci
       - run: npm run lint
 
   unittest:
@@ -36,7 +36,7 @@ jobs:
     needs: [lintjs]
     strategy:
       matrix:
-        node: [14, 16, 18]
+        node: [16, 18, 20]
     steps:
       - name: Checkout ${{ matrix.node }}
         uses: actions/checkout@v3
@@ -53,15 +53,5 @@ jobs:
           key: ${{ runner.os }}-node-${{ matrix.node }}-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-${{ matrix.node }}
-      - run: npm i
+      - run: npm ci
       - run: npm run test:coverage
-
-      # with the following action we enforce PRs to have a high coverage
-      # and ensure, changes are tested well enough so that coverage won't fail
-      - name: check coverage
-        uses: devmasx/[email protected]
-        with:
-          type: lcov
-          result_path: coverage/lcov.info
-          min_coverage: 90
-          token: ${{github.token}}

.gitignore

@@ -80,7 +80,6 @@ typings/
 
 # Nuxt.js build / generate output
 .nuxt
-dist
 
 # Gatsby files
 .cache/

.mocharc.yml

@@ -0,0 +1,8 @@
+recursive: true
+reporter: "spec"
+retries: 0
+slow: 20
+timeout: 2000
+ui: "bdd"
+# for more options see here https://github.com/mochajs/mocha/blob/master/example/config/.mocharc.yml
+require: '@babel/register'

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+**1.0.0**
+- published my awesome package
+-