[clang-tidy][NFC] Add .editorconfig for .rst files

[zeyi2]

Add an .editorconfig file, this helps contributors’ editors auto‑apply these conventions and reduces regressions.

This is part of the documentation improvement discussed in #167098

[zeyi2]

I'm not sure whether this is necessary. The clang-tidy docs currently mix single- ,double-, triple-space indentation. (mainly in .. code-block:: and .. option::)

[vbvictor]

I'd personally want to have double-indentation everywhere but a lot of existing options are using triple- so we shouldn't enforce double- right now.
We could in the future after some extensive refactoring but I don't think it's a big priority.

[vbvictor]

Instead of this path, could we just place it in clang-tool-extra/docs/clang-tidy/checks/?
Will it work like that?

[zeyi2]

It will work, I'll move it to that folder :)

[zeyi2]

Instead of this path, could we just place it in clang-tool-extra/docs/clang-tidy/checks/? Will it work like that?

Also, should we apply these checks to list.rst? The 80 chars limitation may require a lot of refactoring for this file.

Update: I currently disable long line check for this file and keep other checks active.

[EugeneZelenko]

But what about C/C++/Python/CMake files?

[vbvictor]

But what about C/C++/Python/CMake files?

For C/C++ we have clang-format.
For CMake we have strategy "just make look like everywhere else" so I don't see how we can use different style of Cmake files in clang-tidy

[EugeneZelenko]

But what about C/C++/Python/CMake files?

For C/C++ we have clang-format. For CMake we have strategy "just make look like everywhere else" so I don't see how we can use different style of Cmake files in clang-tidy

insert_final_newline seems reasonable setting for all kinds of files - it's often missing in C/C++ files. max_line_length (if shown in editor as vertical line, like Visual Studio Code does) is also helpful.

[zeyi2]

Hi, I've added a new .editorconfig file for clang-tidy, it will apply checks to all the files under the folder.

[vbvictor]

We should gather opinions from other maintainers before pushing this.

One could argue that 3rd party configs should not be pushed to repo. Because if we push editorconfig, why not .vscode config, .nvim, .idea and so on.

[zeyi2]

We should gather opinions from other maintainers before pushing this.

One could argue that 3rd party configs should not be pushed to repo. Because if we push editorconfig, why not .vscode config, .nvim, .idea and so on.

Maybe open a RFC thread on the discourse forum? I'm not completely sure if continuing the discussion within the PR is ideal, since only clang-tidy reviewer are likely to see it.

---

Also, LegalizeAdulthood gave an example of an existing editorconfig inside llvm codebase: https://github.com/llvm/llvm-project/blob/main/lldb/tools/lldb-dap/.editorconfig. Maybe it is acceptable, as other modules have already adopted a similar approach?

WDYT?

[EugeneZelenko]

One could argue that 3rd party configs should not be pushed to repo. Because if we push editorconfig, why not .vscode config, .nvim, .idea and so on.

Maybe open a RFC thread on the discourse forum? I'm not completely sure if continuing the discussion within the PR is ideal, since only clang-tidy reviewer are likely to see it.

Sure, wider discussion will be helpful. We use project-wide Visual Studio Code config at work and I found it very useful. It goes beyond editor setting, but set up C++ extension (Clang-Format, Clang-Tidy), builds and debug.