Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changesets

Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)

We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
23 changes: 23 additions & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"$schema": "https://unpkg.com/@changesets/config@2.2.0/schema.json",
"access": "restricted",
"baseBranch": "main",
"changelog": [
"@changesets/changelog-github",
{
"repo": "<__GITHUB_USERNAME__>/<__GITHUB_REPOSITORY_NAME__>"
}
],
"commit": false,
"fixed": [],
"ignore": [],
"linked": [],
"privatePackages": {
"version": true,
"tag": true
},
"root": {
"packageDir": "."
},
"updateInternalDependencies": "patch"
}
3 changes: 3 additions & 0 deletions .czrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"path": "cz-conventional-changelog"
}
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Editor configuration, see http://editorconfig.org
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
max_line_length = off
trim_trailing_whitespace = false
6 changes: 6 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Global ignore file incase if a child package doesn't include one.

/dist
/build
/node_modules
/coverage
32 changes: 32 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/**
* MIT License
*
* Copyright (c) 2024, Brion Mario
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/

module.exports = {
env: {
es6: true,
node: true,
},
extends: ['turbo', 'plugin:@brionmario/internal', 'plugin:@brionmario/prettier'],
plugins: ['@brionmario'],
};
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: 🐞 Bug
description: File a bug/issue
title: "[BUG] <title>"
labels: ["Bug", "Needs Triage"]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
1. With this config...
1. Run '...'
1. See error...
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: Ubuntu 20.04
- **Node**: 13.14.0
- **npm**: 7.6.3
value: |
- OS:
- Node:
- npm:
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: 📚 Documentation Improvement
description: Suggest improvements to the documentation
title: "[DOCS] <title>"
labels: ["Documentation", "Needs Triage"]
body:
- type: textarea
attributes:
label: Current Documentation
description: Describe the current documentation and what you think needs improvement.
validations:
required: true
- type: textarea
attributes:
label: Suggested Changes
description: Provide details about the changes you'd like to see in the documentation.
validations:
required: true
- type: textarea
attributes:
label: Additional Comments
description: Any additional comments or context about the documentation improvement.
validations:
required: false
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: 🚀 Feature Request
description: Suggest a new feature or enhancement
title: "[FEATURE] <title>"
labels: ["Feature Request", "Needs Triage"]
body:
- type: textarea
attributes:
label: Description
description: A clear and concise description of the feature you're requesting.
validations:
required: true
- type: textarea
attributes:
label: Use Case
description: Explain how this feature would benefit users or improve the project.
validations:
required: false
- type: textarea
attributes:
label: Alternatives Considered
description: Have you considered any alternative solutions or features?
validations:
required: false
- type: textarea
attributes:
label: Additional Context
description: Add any other context or screenshots about the feature request here.
validations:
required: false
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: ❓ Question
description: Ask a question about the project
title: "[QUESTION] <title>"
labels: ["Question", "Needs Triage"]
body:
- type: textarea
attributes:
label: Your Question
description: Ask your question here. Be clear and provide context if necessary.
validations:
required: true
- type: textarea
attributes:
label: Additional Details
description: Any additional details or context you want to provide.
validations:
required: false
37 changes: 37 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## Purpose

<!-- Briefly describe the purpose and scope of this pull request. -->

## Changes Made

<!-- Describe the changes you have made in this pull request. Provide context for reviewers to understand the changes. -->

## Related Issues

<!-- If this pull request is related to any GitHub issues mention them here. Add `N/A` if there's nothing to mention. -->
- Fixes `<issue_url>`

## Related Pull Requests

<!-- If this pull request is related to any other pull requests, mention them here. Add `N/A` if there's nothing to mention. -->

- `<pull_request_url_1>`
- `<pull_request_url_2>`

## Screenshots (if applicable)

<!-- If your changes involve visual modifications, provide screenshots or GIFs to showcase the changes. Add `N/A` if there's nothing to mention. -->

## Checklist

<!-- Mark the items that are applicable by replacing [ ] with [x]. -->

- [ ] I have tested these changes thoroughly.
- [ ] I have updated the documentation to reflect these changes.
- [ ] I have followed the coding style guidelines of the project.
- [ ] I have added suitable comments to the code, especially in complex areas.
- [ ] I have reviewed my own code to ensure there are no obvious errors.

## Additional Notes

<!-- Any additional notes or information that may be helpful for reviewers or future reference. Add `N/A` if there's nothing to mention. -->
66 changes: 66 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# This workflow will build main branch when a PR is merged.

name: 🧱 Builder

on:
push:
branches:
- main
workflow_dispatch:

env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}

jobs:
build:
name: 👷 Build
if: ${{ github.ref == 'refs/heads/main' }}
strategy:
matrix:
node-version: [ lts/* ]
# Try to check for build compatibility on common platforms.
os: [ ubuntu-latest, macOS-latest, windows-latest ]
runs-on: ${{ matrix.os }}
steps:
- name: ⬇️ Checkout
id: checkout
uses: actions/checkout@v2.3.3

- name: 🟢 Setup node
id: setup-node
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}

- name: 🥡 Setup pnpm
id: setup-pnpm
uses: pnpm/action-setup@v2.1.0
with:
version: latest
run_install: false

- name: 🎈 Get pnpm store directory
id: get-pnpm-cache-dir
run: |
echo "::set-output name=pnpm_cache_dir::$(pnpm store path)"

- name: 🔆 Cache pnpm modules
uses: actions/cache@v3
id: pnpm-cache
with:
path: ${{ steps.get-pnpm-cache-dir.outputs.pnpm_cache_dir }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-

- name: 🧩 Install Dependencies
id: install-dependencies
run: pnpm install

- name: 🏗️ Build
id: build
run: pnpm build

- name: ⏳ Lint All Files
id: lint
run: pnpm lint
Loading