Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

asset(image-supervive): Add SUPERVIVE image template #109

Merged
merged 3 commits into from
Nov 18, 2024

Conversation

infinia-yzl
Copy link
Owner

@infinia-yzl infinia-yzl commented Nov 18, 2024

Fixes: #108

Description

Adds SUPERVIVE images by Theorycraft Games (https://playsupervive.com).

Screenshots

image image

Checklist:

  • My changes generate no new warnings or errors
  • I have verified that these changes don't negatively impact performance
  • Also optimized for mobile layouts
  • I have optimized the image(s) for performance (compression, size, etc.)
  • I have verified that the image(s) display correctly in the project context

Additional context

Includes misc changes & funding.yml.

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a new funding source for community sponsorship through GitHub.
    • Added two new image sets, "Webdev" and "Supervive," expanding contribution opportunities.
    • Enhanced internal navigation with Next.js Link components for improved routing.
    • Added a new featured image set, "image-supervive," with various character tags.
    • Launched a new package, "image-supervive," featuring multiple images and roles for enhanced content.
  • Bug Fixes

    • Ensured proper file formatting by adding a newline character in project configuration files.

Copy link

vercel bot commented Nov 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
opentierboy ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 4:53am

Copy link

coderabbitai bot commented Nov 18, 2024

Walkthrough

The pull request introduces several updates across multiple files. A new funding source for the project is added to .github/FUNDING.yml. The CONTRIBUTING.md file is updated with new image sets, while app/layout.tsx transitions internal navigation from anchor tags to Next.js Link components. The FEATURED_SETS in app/page.tsx is updated to include a new entry for "image-supervive". Additionally, new packages and configurations for "image-supervive" are added in imageset.config.json, imageset.custom.json, and package.json.

Changes

File Change Summary
.github/FUNDING.yml Added funding source: github: infinia-yzl
.idea/misc.xml Added newline character at the end of the file
CONTRIBUTING.md Added new image sets: "Webdev" and "Supervive" with respective links
app/layout.tsx Replaced <a> tags with Next.js Link components for internal navigation
app/page.tsx Updated FEATURED_SETS to include "image-supervive" with associated tags
imageset.config.json Added new package image-supervive with displayName, images, and tags
imageset.custom.json Added new package entry for image-supervive with displayName and backgroundImage
package.json Added new dependency "image-supervive": "^1.0.2"

Assessment against linked issues

Objective Addressed Explanation
Add SUPERVIVE by Theorycraft Games (#108)
Ensure all images are compressed Compression status not verified.
Ensure all images are tagged
Publish on npm with passing statuses

Possibly related PRs

  • feat(tests): Implement tests with Playwright #90: The changes in the imageset.config.json file related to the addition of the image-supervive package are relevant to the main PR, which also introduces a new funding source related to the image-supervive project.

🐇 In fields of code, I hop and play,
New images bloom, brightening the way.
With links that leap and funding to cheer,
Our project grows, bringing joy near!
So let’s celebrate, with a joyful dance,
For every change, gives us a chance! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
imageset.custom.json (1)

25-27: Consider adding a googleFont property for consistency

Other game entries like "THE FINALS" and "WUTHERING WAVES" specify a custom googleFont. Consider whether "SUPERVIVE" should also have a specific font to maintain visual consistency with its branding.

CONTRIBUTING.md (1)

34-35: Improve accessibility by properly formatting URLs.

The bare URLs should be formatted as markdown links for better accessibility and consistency with markdown best practices.

Apply this change:

-- Webdev (image-webdev): https://github.com/infinia-yzl/image-webdev
-- Supervive (image-supervive): https://github.com/infinia-yzl/image-supervive
+- Webdev (image-webdev): [https://github.com/infinia-yzl/image-webdev](https://github.com/infinia-yzl/image-webdev)
+- Supervive (image-supervive): [https://github.com/infinia-yzl/image-supervive](https://github.com/infinia-yzl/image-supervive)
🧰 Tools
🪛 Markdownlint

34-34: null
Bare URL used

(MD034, no-bare-urls)


35-35: null
Bare URL used

(MD034, no-bare-urls)

imageset.config.json (1)

2151-2186: Consider adding version and rarity tags for future updates.

While the current tag structure is good, consider future-proofing by:

  1. Adding version tags (e.g., "v1_0_0") to track character releases
  2. Including rarity/tier tags if characters have different ranks or tiers
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d5c4e29 and 0bef79f.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (8)
  • .github/FUNDING.yml (1 hunks)
  • .idea/misc.xml (1 hunks)
  • CONTRIBUTING.md (1 hunks)
  • app/layout.tsx (4 hunks)
  • app/page.tsx (1 hunks)
  • imageset.config.json (1 hunks)
  • imageset.custom.json (1 hunks)
  • package.json (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • .github/FUNDING.yml
  • .idea/misc.xml
🧰 Additional context used
🪛 Markdownlint
CONTRIBUTING.md

34-34: null
Bare URL used

(MD034, no-bare-urls)


35-35: null
Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (12)
imageset.custom.json (1)

25-27: Verify the background image asset exists

The new entry references a background image at /splash/supervive-keyart.webp. Let's verify this asset exists and is properly optimized.

✅ Verification successful

Background image asset verified and optimized

The referenced image /splash/supervive-keyart.webp exists in the correct location and is well-optimized at 66KB, which is a reasonable size for a webp splash image.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence and optimization of the SUPERVIVE background image

# Check if the image file exists in the public/splash directory
fd "supervive-keyart.webp" public/splash

# If found, check the file size to ensure it's optimized
if [ $? -eq 0 ]; then
  find public/splash -name "supervive-keyart.webp" -exec ls -lh {} \;
fi

Length of output: 249

package.json (2)

48-48: LGTM! Dependency addition follows established pattern

The new dependency image-supervive follows the same pattern as other image sets in the project (e.g., image-overwatch, image-reachthefinals).


48-48: Verify the package version

Let's ensure we're using the most appropriate version of the package.

✅ Verification successful

Package version is appropriate

The current version 1.0.2 is the latest available version of image-supervive. The package was recently published (November 18, 2024) and has minimal dependencies (@inquirer/prompts). The version being used in the project is up-to-date.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check npm registry for latest version and release info

# Get latest version and release info
npm view image-supervive versions --json

# Check install size and dependencies
npm view image-supervive size
npm view image-supervive dependencies --json

# Check weekly downloads for stability indication
npm view image-supervive downloads --json

Length of output: 237


Script:

#!/bin/bash
# Let's check when these versions were published and any potential issues
npm view image-supervive time --json

# Also check the package.json in the repository to see if this dependency is used
rg -l "image-supervive" --type json

Length of output: 350


Script:

#!/bin/bash
# Let's check how this package is being used in the config files
cat imageset.config.json imageset.custom.json

# And check if there are any scripts in package.json using this package
cat package.json | jq '.scripts'

Length of output: 50019

app/page.tsx (1)

14-14: LGTM! Verify tag consistency with image configurations.

The new FEATURED_SETS entry follows the established pattern and integrates well with the existing code structure.

Let's verify that the tags match the configured images:

✅ Verification successful

All tags in FEATURED_SETS are properly configured and used in image metadata

The verification shows that:

  • All tags (hunter, fighter, initiator, frontliner, protector, controller) are properly defined in the imageset.config.json configuration
  • Each tag has proper metadata (title, description, category)
  • The tags are actively used in image metadata across multiple character entries
  • The configuration is consistent between imageset.config.json and imageset.custom.json
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the tags in FEATURED_SETS match the image configurations

# Check if the package and its tags are properly configured in imageset.config.json
jq '.packages."image-supervive"' imageset.config.json

# Check if the custom configuration exists
jq '.packages."image-supervive"' imageset.custom.json

# Verify if all the tags have corresponding images
for tag in "hunter" "fighter" "initiator" "frontliner" "protector" "controller"; do
  echo "Checking images for tag: $tag"
  find . -path "*/image-supervive/*" -type f -name "*${tag}*.png" -o -name "*${tag}*.jpg" -o -name "*${tag}*.jpeg"
done

Length of output: 5438

CONTRIBUTING.md (1)

34-35: LGTM! Verifying repository links.

The new image sets are properly documented following the existing pattern.

Let's verify the accessibility of the new repository links:

✅ Verification successful

Repository links are accessible and public

Both new repositories exist and are publicly accessible:

  • image-webdev: Public repository with description
  • image-supervive: Public repository (though missing description)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the new repository URLs are accessible
# Expected: Both repositories should exist and be public

for repo in "image-webdev" "image-supervive"; do
  echo "Checking $repo..."
  gh repo view "infinia-yzl/$repo" --json name,isPrivate,description
done

Length of output: 583

🧰 Tools
🪛 Markdownlint

34-34: null
Bare URL used

(MD034, no-bare-urls)


35-35: null
Bare URL used

(MD034, no-bare-urls)

app/layout.tsx (4)

5-5: LGTM: Next.js Link import added correctly

The import is properly placed and necessary for the Link component usage throughout the file.


158-170: LGTM: Header navigation properly migrated to Next.js Link components

The migration from anchor tags to Next.js Link components is well-implemented:

  • Proper nesting of Link components
  • Correct usage of Button's asChild prop
  • Preserved styling and accessibility attributes

197-199: LGTM: Footer navigation properly migrated to Next.js Link components

The migration is well-implemented with proper consideration for:

  • Internal routes using Next.js Link components
  • External email link remaining as anchor tag
  • Preserved styling and layout structure

Also applies to: 230-231


158-170: Verify navigation paths for new SUPERVIVE content

Since this PR adds SUPERVIVE image templates, let's verify that all necessary navigation paths are in place.

Also applies to: 197-199, 230-231

✅ Verification successful

Let me verify the navigation paths by checking the actual content and routes.


Navigation paths are properly configured and aligned with content

The verification confirms that:

  • All navigation paths in the layout (/, /about, /blog) have corresponding routes in the app directory
  • SUPERVIVE content is properly integrated in the homepage (app/page.tsx) as one of the featured image sets
  • The navigation structure supports both the existing content and the new SUPERVIVE templates
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify navigation paths for SUPERVIVE content

# Check for any SUPERVIVE-related route definitions
echo "Checking for SUPERVIVE route definitions..."
rg -l "supervive" app/

# Check for any potential broken internal links
echo "Checking for potential broken internal links..."
fd -e tsx -e ts | xargs rg -l "href=\"/"

Length of output: 454


Script:

#!/bin/bash
# Check the content of page.tsx for SUPERVIVE-related routes
echo "Content of app/page.tsx:"
cat app/page.tsx

# Check if all linked routes exist
echo -e "\nVerifying routes mentioned in layout.tsx:"
for route in "/" "/about" "/blog"; do
    if fd "^${route#/}$|^${route#/}/" app/; then
        echo "✓ Route $route exists"
    else
        echo "✗ Route $route not found"
    fi
done

Length of output: 3581

imageset.config.json (3)

2003-2004: LGTM: Package addition follows established patterns.

The new "image-supervive" package is correctly structured and follows the same organization pattern as other game-related packages.


2005-2150: LGTM: Well-structured image entries with consistent tagging.

The image entries follow a consistent pattern with:

  • Clear 3-letter filename codes
  • Descriptive labels in uppercase
  • Appropriate role-based tags
  • Proper event tagging for the open beta launch

2188-2188: LGTM: Background image follows naming convention.

The background image path follows the established pattern of using keyart for splash backgrounds.

@infinia-yzl infinia-yzl merged commit 3c056b4 into main Nov 18, 2024
7 checks passed
@infinia-yzl infinia-yzl deleted the opentierboy-108 branch November 18, 2024 06:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Image Addition] Add SUPERVIVE by Theorycraft Games
1 participant