nodejs/node

[C++ Lint Rule] #define indentation is Inconsistent

Open

#28.605 aberto em 9 de jul. de 2019

Ver no GitHub
 (4 comments) (1 reaction) (0 assignees)JavaScript (35.535 forks)batch import
c++help wantedstale

Métricas do repositório

Stars
 (117.218 stars)
Métricas de merge de PR
 (Mesclagem média 18d 17h) (219 fundiu PRs em 30d)

Description

I was recently going through the source code, trying to familiarize myself with the codebase, and I noticed that there's no consistent rule for how #defines are indented.

For example, in node_main.cc, there's no indentation at all in this #ifdef block.

However, in other places, like node.h, there's a space between the # and the define to indicate a kind of indentation.

There also seems to be inconsistency with how many spaces/tabs should go after the #define variable name and the value, as seen here.

Can we come up with a rule for this and add it to the C++ Style Guide? Maybe even add a rule to the linter?

To get started with the rules we can to define, some questions are:

  1. Should #defines inside of braces be indented?
  2. When should #ifdef X be used vs. if defined(X)?
  3. What should the indentation pattern be for #define/#ifdef/#if defined/#ifndef?

Guia do colaborador

Direção de pesquisa
Revise o guia de estilo C++ existente e proponha uma regra de indentação consistente para as diretivas de pré processador #define, considerando os exemplos em node main.cc e node.h.
Pilha de tecnologia
ccpp
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
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
GitC++
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70