llvm/llvm-project

add newline between include and namespace

Open

#42,112 opened on Jul 25, 2019

View on GitHub
 (6 comments) (1 reaction) (1 assignee)C++ (10,782 forks)batch import
bugzillaclang-formatenhancementgood first issue

Repository metrics

Stars
 (26,378 stars)
PR merge metrics
 (Avg merge 1d 2h) (1,000 merged PRs in 30d)

Description
Bugzilla Link 42767
Version unspecified
OS Windows NT

Extended Description

We have options to remove duplicate white-space lines, however, it would also be good for readability to be able to require at least one empty line:

  • before and after and #include block
  • before and after a namespace
//
// License
//
#include <memory>
#include <string>
namespace {

}

convert to:

//
// License
//
                            <<-- added empty line
#include <memory>
#include <string>
                            <<-- added empty line
namespace Bar {

class Foo {

};

} // Bar

Contributor guide

Research direction
Examine clang format's handling of empty lines between include directives and namespace blocks. Investigate existing options like 'MaxEmptyLinesToKeep' and 'SortIncludes' to understand how to introduce new configuration options that enforce at least one empty line before and after includes and namespace blocks.
Tech stack
cpp
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 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
C++GitLLVM development environment
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40