@graupl/graupl 1.0.0-beta.1 → 1.0.0-beta.11

package/.github/CONTRIBUTING.md

@@ -1,86 +0,0 @@
-# Contributing to graupl
-
-Whether you want to add a feature or simply report a bug or issue, please have a quick read through these guidelines before contributing.
-
-## Developed with Github
-
-We use github to host code, to track issues and feature requests, as well as accept pull requests. All other forms of communication with maintainers is not considered "official".
-
-## [Github Flow](https://guides.github.com/introduction/flow/index.html) is the Way to Go
-
-All code changes happen through pull requests.
-
-Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
-
-1. Fork the repo and create your branch from 4.x.
-2. Link your pull request to any relavent open issues.
-3. If you've added or changed functionality update the documentation.
-4. Make sure your code functions.
-5. Update existing tests or write a new test to ensure your code will _continue_ to function regardless of future changes.
-6. Make sure your code lints.
-7. Issue the pull request!
-
-## Any contribution you make will be under the ISC License
-
-In short, when you submit code changes, your submissions are understood to be under the same ISC License that covers the project. Feel free to contact the maintainers if that's a concern.
-
-## Report bugs using Github's [issues](https://github.com/Graupl/graupl/issues)
-
-We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/Graupl/graupl/issues/new).
-
-## Write bug reports with detail, background, and sample code
-
-**Great Bug Reports** tend to have:
-
-- A quick summary and/or background
-- Steps to reproduce
-  - Be specific!
-  - Give sample code if you can
-- What you expected would happen
-- What actually happens
-- Notes
-  - why you think this might be happening
-  - stuff you tried that didn't work
-
-Everybody loves a thorough bug report!
-
-## Keep Your Code Consistent
-
-- Run `npm install` to ensure you have all the tools needed.
-- Keep all functional code inside of the `src/` directory.
-- Keep all test code inside of the `tests/` directory.
-- Use the coding standards provided.
-
-This project follows a set of coding standards combining [StandardJS](https://standardjs.com/), [Prettier](https://prettier.io/), and [JSDoc](https://jsdoc.app/) for JavaScript and [Standard SCSS](https://github.com/stylelint-scss/stylelint-config-standard-scss#readme), [Sass Guidelines](https://github.com/bjankord/stylelint-config-sass-guidelines#readme), Prettier, and [SMACSS](https://smacss.com/) for Sass.
-
-To check your code, you can use [ESLint](https://eslint.org/)/[Stylelint](https://stylelint.io/)/Prettier with the provided script:
-
-```shell
-npm run lint
-```
-
-Code that does not follow the linting standards _will not_ be merged.
-
-## Commit Guidelines
-
-This project uses the conventional commit standard, which means your commits should follow a basic template of:
-
-> \<type>[optional scope]: \<description>
->
-> [optional body]
->
-> [optional footer(s)]
-
-For more detailed information about available types, scopes, breaking changes, etc. please see the [official documentation](https://www.conventionalcommits.org/en/v1.0.0/).
-
-This project also provides a command to assist you in formatting commit messages using [commitizen](https://commitizen.github.io/cz-cli/):
-
-```shell
-npm run commit
-```
-
-Commits that do not follow this format _will not_ be merged.
-
-## References
-
-This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,30 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: 'Bug: [Brief Description]'
-labels: bug
-assignees: ''
-
----
-
-## Summary
-<!-- What is the issue you are experiencing? -->
-
-## Steps to reproduce
-<!--
-What are the steps to reproduce this issue?
-
-1. Go to "..."
-2. Click on "...."
-3. Scroll down to "...."
-4. See error
--->
-
-## Expected Behaviour
-<!-- What is the expected behaviour? -->
-
-## Screenshots
-<!-- If applicable, add screenshots to help explain your problem. -->
-
-## Additional context
-<!-- Is there anything else that would give context about the problem? -->

package/.github/ISSUE_TEMPLATE/documentation.md

@@ -1,20 +0,0 @@
----
-name: Documentation Issue
-about: Create an issue to help fix or improve documentation
-title: 'Docs: [Brief Description]'
-labels: documentation
-assignees: ''
-
----
-
-## Summary
-<!-- What is the issue you are experiencing? Is something unclear or wrong? A typo perhaps? -->
-
-## Solution
-<!-- Describe the solution you'd like to see. -->
-
-## Alternatives
-<!-- Describe alternatives you've considered. -->
-
-## Additional context
-<!-- Is there anything else that would give context about the problem? -->

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: 'Feat: [Brief Description]'
-labels: enhancement
-assignees: ''
-
----
-
-## Summary
-<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
-
-## Solution
-<!-- Describe the solution you'd like to see. -->
-
-## Alternatives
-<!-- Describe alternatives you've considered. -->
-
-## Additional context
-<!-- Is there anything else that would give context about the problem? -->

package/.github/SECURITY.md

@@ -1,26 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 1.x     | ✔                  |
-
-## Reporting a Vulnerability
-
-If you discover a vulnerability within this project, please [open an issue](https://github.com/Graupl/graupl/issues/new) and label it with the `security` tag. The issue board is checked at least 2-3 times a week, so you should expect a response to your issue within a few days.
-
-If a PR is submitted along with the issue to resolve the vulnerability, you can expect it to be reviewed within the same time frame as issue responses. If a PR is not submitted, the time it takes to develop a fix will differ depending on the severity of the vulnerability.
-
-## Vulnerabilities in dependencies
-
-Given that graupl does not have any production dependencies, any vulnerable dev dependencies will be updated when/if possible- though a new release of graupl may not be pushed out right away.
-
-A higher priority will be given to dev dependencies that are directly responsible for compiling the project:
-
-- [sass](https://sass-lang.com),
-- [postcss](https://postcss.org),
-- [vite](https://github.com/vitejs/vite), and
-- all related plugins
-
-If a vulnerability is found and resolved within one of these dependencies, a new release will be made.

package/.github/dependabot.yml

@@ -1,17 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "npm" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "daily"
-    labels:
-      - "dependencies"
-    reviewers:
-      - "NickDJM"
-    commit-message:
-      prefix: "build"

package/.github/pull_request_template.md

@@ -1,5 +0,0 @@
-## Description
-<!-- Why are you making this pull request? -->
-
-## Related Issues
-<!-- Please provide links to any related issues. -->

package/.github/workflows/codeql-analysis.yml

@@ -1,71 +0,0 @@
-# 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"
-
-on:
-  push:
-    branches: [ '*.x' ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ '*.x' ]
-  schedule:
-    - cron: '23 0 * * 5'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      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@v4
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
-      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@v3
-
-    # ℹ️ 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@v3

package/.github/workflows/docs.yml

@@ -1,59 +0,0 @@
-name: Deploy VitePress site to Pages
-
-on:
-  push:
-    branches: [1.x]
-
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
-concurrency:
-  group: pages
-  cancel-in-progress: false
-
-jobs:
-  # Build job
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0 # Not needed if lastUpdated is not enabled
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-      - name: Setup Pages
-        uses: actions/configure-pages@v3
-      - name: Install dependencies
-        run: npm install
-      - name: Build with VitePress
-        run: |
-          npm run docs:build
-          touch docs/.vitepress/dist/.nojekyll
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v2
-        with:
-          path: docs/.vitepress/dist
-
-  # Deployment job
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    needs: build
-    runs-on: ubuntu-latest
-    name: Deploy
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2

package/.github/workflows/test.yml

@@ -1,27 +0,0 @@
-name: Tests
-on:
-  push:
-    branches: [ '*.x' ]
-  pull_request:
-    branches: [ '*.x' ]
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Install modules
-        run: npm install
-      - name: Run build
-        run: npm run build
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Install modules
-        run: npm install
-      - name: Run eslint
-        run: npm run eslint
-      - name: Run stylelint
-        run: npm run stylelint
-      - name: Run prettier
-        run: npm run prettier -- --check

package/.husky/commit-msg

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-npx --no-install commitlint --edit $1

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-
-echo committing as $(git config user.name)
-npx lint-staged

package/.prettierignore

@@ -1,12 +0,0 @@
-# Mac file
-.DS_Store
-
-# Auto-generated directories.
-node_modules
-dist
-
-# Lock files.
-package-lock.json
-
-# Do not ignore config files.
-!.*.js

package/.stylelintignore

@@ -1,9 +0,0 @@
-# Mac file
-.DS_Store
-
-# Auto-generated directories.
-node_modules
-dist
-
-# Lock files.
-package-lock.json

package/.versionrc.cjs

@@ -1,61 +0,0 @@
-const config = {
-  types: [
-    {
-      type: "feat",
-      section: "Features",
-      hidden: false,
-    },
-    {
-      type: "fix",
-      section: "Bug Fixes",
-      hidden: false,
-    },
-    {
-      type: "perf",
-      section: "Performance Improvements",
-      hidden: false,
-    },
-    {
-      type: "revert",
-      section: "Reverts",
-      hidden: false,
-    },
-    {
-      type: "docs",
-      section: "Documentation",
-      hidden: false,
-    },
-    {
-      type: "style",
-      section: "Styles",
-      hidden: true,
-    },
-    {
-      type: "chore",
-      section: "Miscellaneous Chores",
-      hidden: true,
-    },
-    {
-      type: "refactor",
-      section: "Code Refactoring",
-      hidden: false,
-    },
-    {
-      type: "test",
-      section: "Tests",
-      hidden: true,
-    },
-    {
-      type: "build",
-      section: "Build System",
-      hidden: false,
-    },
-    {
-      type: "ci",
-      section: "Continuous Integration",
-      hidden: false,
-    },
-  ],
-};
-
-module.exports = config;