Merge pull request #1 from falsepopsky/dev

chore: prepare v1 release

.changeset/bright-buckets-approve.md

@@ -0,0 +1,18 @@
+---
+'@untidy/mobygames': major
+---
+
+This package provides access to the MobyGames API, allowing you to retrieve game data through
+various endpoints with optional query parameters.
+
+- `/games`
+- `/games/:game_id`
+- `/games/:game_id/platforms`
+- `/games/:game_id/platforms/:platform_id`
+- `/games/:game_id/platforms/:platform_id/screenshots`
+- `/games/:game_id/platforms/:platform_id/covers`
+- `/games/random`
+- `/games/recent`
+- `/genres`
+- `/groups`
+- `/platforms`

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.devcontainer/devcontainer.json

@@ -1,5 +1,5 @@
 {
-  "name": "perlon monorepo template",
+  "name": "mobygames",
   "image": "mcr.microsoft.com/devcontainers/base:jammy",
   "features": {
     "ghcr.io/devcontainers/features/node:1": {
@@ -12,8 +12,11 @@
     "vscode": {
       "extensions": [
         "dbaeumer.vscode-eslint",
-        "esbenp.prettier-vscode",
         "editorconfig.editorconfig",
+        "esbenp.prettier-vscode",
+        "bradlc.vscode-tailwindcss",
+        "astro-build.astro-vscode",
+        "unifiedjs.vscode-mdx",
         "vitest.explorer",
         "github.vscode-github-actions",
         "github.vscode-pull-request-github"

.eslintrc.cjs

@@ -5,7 +5,7 @@ module.exports = {
     node: true,
   },
   plugins: ['@typescript-eslint', 'promise'],
-  extends: ['perlon'],
+  extends: ['untidy'],
   parser: '@typescript-eslint/parser',
   parserOptions: {
     tsconfigRootDir: __dirname,
@@ -20,5 +20,5 @@ module.exports = {
       tryExtensions: ['.js', '.json', '.node', '.ts'],
     },
   },
-  ignorePatterns: ['dist', '*.cjs'],
+  ignorePatterns: ['dist', '*.cjs', 'env.d.ts'],
 };

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @falsepopsky

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,113 @@
+# 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 falsepopsky@protonmail.com. 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.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing
+
+Thank you for your interest in contributing to any packages from the **untidy/mobygames** monorepo!
+Community contributions play a crucial role in improving this project.
+
+## Reporting Bugs and Issues
+
+We appreciate bug reports and feedback to enhance any packages from **untidy**. When reporting bugs
+or issues, please follow these guidelines:
+
+- Before creating a new issue, please search the existing issues to avoid duplicates.
+- Use the templates as possible.
+
+## For developers who want to contribute
+
+To contribute, you should have the following prerequisites:
+
+- Node v20.11.1
+- pnpm (use the same version as the one used in the CI/packageManager)
+
+## Pull Requests
+
+We welcome and appreciate contributions to the project. However, please note the following
+guidelines for submitting pull requests:
+
+### Accepted Pull Requests
+
+We generally accept pull requests that fall into the following categories:
+
+- New features or enhancements that add value to the project.
+- Bug fixes that address existing issues or improve the project's stability.
+- Performance improvements or optimizations.
+
+### Pull Requests Not Accepted
+
+The following types of pull requests may be closed and not accepted:
+
+- Minor text changes, such as fixing typos or grammar errors, without any significant impact on
+  functionality or clarity.
+- Dependency updates.
+- Pull requests opened without prior discussion or without an associated issue.
+
+We appreciate your understanding as we aim to maintain the focus and quality of the project.
+
+### Contribution Workflow
+
+To contribute code changes, please follow these steps:
+
+1. Fork the repository and create a new branch for your feature or bug fix.
+2. Make the necessary changes in your branch.
+3. Test your changes locally to ensure they function as expected.
+4. Provide clear and concise commit messages describing your changes.
+5. Submit a pull request to the main branch of the repository.
+6. Your pull request will be reviewed by the maintainers, and feedback or changes may be requested.
+7. Once your changes are approved, they will be merged into the main repository.
+
+Thank you for considering contributing to our project! Your contributions help improve the project's
+quality and benefit the community.
+
+## Licensing
+
+By contributing to `untidy` and its packages, you agree that your contributions will be licensed
+under the `Apache-2.0` license.
+
+## Acknowledgment
+
+We would like to express our gratitude to all the contributors who have helped improve `untidy` and
+its packages. Their dedication and support are invaluable.

.github/SECURITY.md

@@ -0,0 +1,25 @@
+# Security Policy
+
+## Supported Versions
+
+| Package             | Version | Supported          |
+| ------------------- | ------- | ------------------ |
+| `@untidy/mobygames` | ^1.0.0  | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, please follow these steps:
+
+1. Description: Provide a clear and detailed description of the vulnerability you have identified.
+2. Steps to Reproduce: Explain the steps you took to encounter the vulnerability.
+3. Affected Versions: Specify the versions of the project in which the vulnerability exists.
+4. Mitigations (if known): If you are aware of any mitigations or workarounds for the vulnerability,
+   please share them.
+
+Please refrain from reporting security vulnerabilities through public GitHub issues. Instead, use
+GitHub's security advisory feature by visiting the following link:
+
+[Report a vulnerability](https://github.com/falsepopsky/mobygames/security/advisories/new)
+
+We appreciate your responsible disclosure and cooperation in helping us maintain the security of the
+project.

.github/labeler.yaml

@@ -0,0 +1,12 @@
+"📦 @untidy/mobygames":
+  - "packages/api/src/**"
+"📚 docs":
+  - "packages/web/**"
+  - "README.md"
+  - "packages/api/README.md"
+"🧪 tests":
+  - "packages/api/tests/**"
+  - "mocks/**"
+"⚙️ configs":
+  - ".prettierrc"
+  - ".eslintrc.cjs"

.github/workflows/cd.yaml

@@ -0,0 +1,77 @@
+name: CD
+on:
+  push:
+    branches:
+      - main
+
+env:
+  PNPM_VERSION: 8.15.5
+
+jobs:
+  lint:
+    name: ⬣ Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4.1.1
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v3.0.0
+        with:
+          version: ${{ env.PNPM_VERSION }}
+
+      - name: Setup Node
+        uses: actions/setup-node@v4.0.2
+        with:
+          node-version-file: ".nvmrc"
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+      - name: Run lint
+        run: pnpm lint
+  test:
+    name: 🧪 Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4.1.1
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v3.0.0
+        with:
+          version: ${{ env.PNPM_VERSION }}
+
+      - name: Setup Node
+        uses: actions/setup-node@v4.0.2
+        with:
+          node-version-file: ".nvmrc"
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+      - name: Run tests
+        run: pnpm test
+  build:
+    name: 🏗️ Build
+    runs-on: ubuntu-latest
+    needs: [lint, test]
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4.1.1
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v3.0.0
+        with:
+          version: ${{ env.PNPM_VERSION }}
+
+      - name: Setup Node
+        uses: actions/setup-node@v4.0.2
+        with:
+          node-version-file: ".nvmrc"
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+      - name: Run build
+        run: pnpm build