FuelLabs/sway

Enforce type annotations for constants

Open

#5,758 opened on Mar 20, 2024

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Rust (5,421 forks)batch import
ODHack12bugcompiler: frontendgood first issueteam:compiler

Repository metrics

Stars
 (61,702 stars)
PR merge metrics
 (Avg merge 5d 4h) (19 merged PRs in 30d)

Description

We should ensure all const declarations have explicitly named types and provide a helpful error message when they do not.

const OFFSET_TOKEN_ADDRESS = 32; // forbidden
const OFFSET_TOKEN_ADDRESS: u64 = 32; // allowed

Contributor guide

Research direction
Start by examining the Sway compiler's parser and type checking modules, particularly how variable declarations are processed. Look for existing patterns that enforce type annotations on other constructs (e.g., function parameters). The error message should be generated in the diagnostic module. Check the issue comments for any suggested implementation approaches or files to modify.
Tech stack
rust
Domain
toolingdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Familiarity with RustUnderstanding of Sway syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55