PLC-lang/rusty

Create utility workspace with macros for all internal naming conventions

Aberta

#913 aberto em 18 de jul. de 2023

Ver no GitHub
 (1 comentário) (0 reação) (0 responsável)Rust (71 forks)auto 404
good first issuelow-priorityrefactor

Métricas do repositório

Stars
 (351 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Revise os trechos de código vinculados para identificar padrões comuns de convenção de nomenclatura e, em seguida, crie um novo crate 'util' com macros para definir essas convenções em um único lugar. Considere como expô las entre os workspaces.
Pilha de tecnologia
rust
Domain
backend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
RustCargo workspaces
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50