PLC-lang/rusty

Create utility workspace with macros for all internal naming conventions

Open

#913 opened on Jul 18, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (71 forks)auto 404
good first issuelow-priorityrefactor

Repository metrics

Stars
 (351 stars)
PR merge metrics
 (PR metrics pending)

Description

We have several naming conventions that are defined across the project (e.g. internally generated types). Since we split the project into workspaces we keep having problems for finding a single place to define functions/macros for these naming conventions, so they are visible to anybody.

I suggest creating its own crate for utility functions called 'util' and we start with offering macros for all kinds of naming-convention-macros:

https://github.com/PLC-lang/rusty/blob/9b89598bee70b126eec077cdae1c2631c1e8ce01/src/index.rs#L1489-L1492

https://github.com/PLC-lang/rusty/blob/9b89598bee70b126eec077cdae1c2631c1e8ce01/src/typesystem.rs#L1273-L1277

https://github.com/PLC-lang/rusty/blob/9b89598bee70b126eec077cdae1c2631c1e8ce01/src/ast/pre_processor.rs#L162

https://github.com/PLC-lang/rusty/blob/9b89598bee70b126eec077cdae1c2631c1e8ce01/src/ast/pre_processor.rs#L189

https://github.com/PLC-lang/rusty/blob/9b89598bee70b126eec077cdae1c2631c1e8ce01/src/resolver/generics.rs#L207

https://github.com/PLC-lang/rusty/blob/9b89598bee70b126eec077cdae1c2631c1e8ce01/src/resolver/generics.rs#L439

Contributor guide

Research direction
Review the linked code snippets to identify common naming convention patterns, then create a new 'util' crate with macros to define these conventions in one place. Consider how to expose them across workspaces.
Tech stack
rust
Domain
backend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustCargo workspaces
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50