Skip to content

Conversation

borjapazr
Copy link

@borjapazr borjapazr commented Apr 29, 2023

This Pull Request introduces a change to the theme configuration setup to remove the use of italics for specific operators. These operators include the type assignment colon (:), the value assignment equal sign (=), and logical operators (e.g., &&, ||, !, etc.).

The purpose of this change is to improve the readability and consistency of the code, as some users find italics difficult to read or distracting. Additionally, removing italics from these operators aligns with common style guides and conventions, allowing for a more uniform experience across various projects.

The modifications include updates to the theme's JSON file, specifically in the tokenColors array where each operator's styling is defined. The fontStyle property for these operators has been updated to exclude the "italic" value.

Summary of changes:

  • Update theme configuration file to remove italics from type assignment colon
  • Remove italics from value assignment equal sign
  • Eliminate italics from logical operators

This Pull Request may be considered somewhat opinionated, as the choice of using italics for specific operators is often a matter of personal preference. However, I believe that this change can provide a net positive impact on the readability and consistency of the code for the majority of our team members. To help illustrate the differences and potential benefits, I have included before and after screenshots to showcase the updated theme configuration:

Before

CleanShot 2023-04-29 at 02 23 43@2x


After

CleanShot 2023-04-29 at 02 24 43@2x

Thanks in advance!

@VoidPhantom
Copy link

I would like to second this proposal and also point out that one specific readability issue with italics is that they make the pipe symbol (|) resemble a forward slash (/), thus making the appearance of || and | operators more confusing.

@borjapazr
Copy link
Author

Hello @CodelyTV team! Have you been able to review this PR? 😊

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.

2 participants