Back to all reviewers

consistent platform identifiers

electron/electron
Based on 2 comments
Yaml

When naming platform identifiers, choose one naming convention and use it consistently throughout the codebase. Prefer established ecosystem standards when available, such as Node.js `process.platform` values (`win32`, `darwin`, `linux`) over custom variations.

Naming Conventions Yaml

Reviewer Prompt

When naming platform identifiers, choose one naming convention and use it consistently throughout the codebase. Prefer established ecosystem standards when available, such as Node.js process.platform values (win32, darwin, linux) over custom variations.

Avoid mixing different names for the same platform concept (e.g., windows, win, win32 all referring to Windows). This creates confusion and requires unnecessary translation logic.

Example of the problem:

# Inconsistent - multiple names for Windows platform
artifact-platform: 'windows'  # in one place
build-key: 'win32'            # in another place  
target: 'win'                 # in yet another place

Example of the solution:

# Consistent - using Node.js process.platform convention
artifact-platform: 'win32'   # everywhere
build-key: 'win32'           
target: 'win32'              

This eliminates the need for conditional transformations like inputs.artifact-platform == 'windows' && 'win32' || inputs.artifact-platform and makes the codebase more predictable and maintainable.

2
Comments Analyzed
Yaml
Primary Language
Naming Conventions
Category

Source Discussions