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

Feature: add new output tokens {consoleBrand}, {consoleName}, {consoleAbbrName} #1202

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

Djabal
Copy link

@Djabal Djabal commented Jul 6, 2024

No description provided.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

👋 Welcome

Thank you for your first pull request, @Djabal! If you haven't yet, please familiarize yourself with igir's contribution guidelines.

Some GitHub Actions CI workflows may not automatically run for you due to GitHub's security best practices, so a maintainer may need to manually approve the workflows to run. As a result, it is important to make sure tests pass locally before submitting a pull request to help ensure a fast review. Thank you!

Comment generated by the GitHub First Interaction workflow.

@Djabal
Copy link
Author

Djabal commented Jul 6, 2024

Hi,
A proposition to add new tokens console oriented.
Long time I haven't code anything, let me know if anything seems wrong.

Copy link

github-actions bot commented Jul 6, 2024

🧪 Branch testing instructions

This pull request can be tested locally with the following command:

npm exec --yes -- "github:Djabal/igir#patch-1" [commands..] [options]

Comment generated by the Node.js Branch Exec workflow.

Copy link
Owner

@emmercm emmercm left a comment

Choose a reason for hiding this comment

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

Hi @Djabal, thank you for the contribution!

src/types/gameConsole.ts Outdated Show resolved Hide resolved
src/types/gameConsole.ts Outdated Show resolved Hide resolved
// @see https://wiki.no-intro.org/index.php?title=Systems
consoleBrand?: string,
consoleName?: string,
consoleAbbrName?: string,
Copy link
Owner

Choose a reason for hiding this comment

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

Do you know what No-Intro's intended use of the abbreviation is? This is the first time I've seen it. I see less value in it than in the other tokens, so I'm inclined to not add it.

Copy link
Author

Choose a reason for hiding this comment

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

Hi @emmercm,

Thanks of Igir. Glad I can help with littles contributions.

In my opinion it's a simple way to have an human-readable ID. Easy to manipulate and to read, short, without space, without capital letter.

Many of these abbreviations are in the every-day speech (n64, snes, ps2, ...).

Many projects have their owns lists :

Or use them without saying it :

  • goodsets : goodn64, goodgg, goodspc, etc.
  • adam : roms/GW, roms/PCE, roms/GG
  • retrodeck
  • onion

Other :

For me the main problem is to choose the goods abbreviations :

  • easy way : it to choose to use No-Intro and Redump lists as there's no convention and no rules that you could extract from existing abbreviations.
  • hard way : choose the bests abbreviations in all existing lists.
  • weird way : don't care about all that and compute an id consistent with the console brand and name.

The easy way is for me the best as it reuses existing lists.

We can rename consoleAbbrName to consoleShortName or consoleID.

And it's make sense if it's required for all GameConsole too.

Copy link

codecov bot commented Jul 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.18%. Comparing base (ec8d897) to head (7a86d6c).
Report is 15 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1202      +/-   ##
==========================================
+ Coverage   93.16%   93.18%   +0.01%     
==========================================
  Files         105      105              
  Lines        6486     6486              
  Branches     1538     1537       -1     
==========================================
+ Hits         6043     6044       +1     
- Misses        420      441      +21     
+ Partials       23        1      -22     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Djabal and others added 3 commits July 31, 2024 13:59
consoleBrand is now required for all GameConsole

Co-authored-by: Christian Emmer <10749361+emmercm@users.noreply.github.com>
consoleName now required for all GameConsole

Co-authored-by: Christian Emmer <10749361+emmercm@users.noreply.github.com>
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.

None yet

2 participants