Command to get informations about the EditorConfig usage in the targets #50

Manually merged

BaumiCoder merged 33 commits from feature/38-status-command into main 2026-06-04 12:38:31 +02:00

Conversation 0 Commits 33 Files changed 24 +1345 -88

BaumiCoder commented 2026-06-04 08:23:27 +02:00

Owner

Copy link

Resolves #38

User perspective

This Pull Request adds the command status to ecformat. It gives information about what .editorconfig files are relevant for the given targets. Furthermore, it lists what EditorConfig properties (incl. values) apply to all the target files. For more details see the CLI help for example with ecformat help status.

(Beside this a small adjustment for #8: All relevant .editorconfig files for the target files are considered. This also include .editorconfig files in parent directories of the target directories.)

Developer perspective

In the context of changes for this issue, I also found a bug in test cases, which I addressed with 232fa4edc7 as it was also relevant for the tests for these changes. Furthermore, clippy have not failed yet on warnings in the CI and the pre-commit (on push)! Detect due to the warnings addressed with a452dc66ea. Fixed the clippy behavior in CI and pre-commit with 4d4609cc1c.

Resolves #38 ### User perspective This Pull Request adds the command `status` to ecformat. It gives information about what `.editorconfig` files are relevant for the given targets. Furthermore, it lists what EditorConfig properties (incl. values) apply to all the target files. For more details see the CLI help for example with `ecformat help status`. (Beside this a small adjustment for #8: All relevant `.editorconfig` files for the target files are considered. This also include `.editorconfig` files in parent directories of the target directories.) ### Developer perspective In the context of changes for this issue, I also found a bug in test cases, which I addressed with 232fa4edc71873c370409d0f4a530ea4541b05b0 as it was also relevant for the tests for these changes. Furthermore, clippy have not failed yet on warnings in the CI and the pre-commit (on push)! Detect due to the warnings addressed with a452dc66ea7275ac6073503c828648279ec7d365. Fixed the clippy behavior in CI and pre-commit with 4d4609cc1c876dab8e369eab0fb487e6fcac1b0b.

BaumiCoder added this to the Version 0.2.0 milestone 2026-06-04 08:23:27 +02:00

BaumiCoder added the

Kind

Feature

label 2026-06-04 08:23:27 +02:00

BaumiCoder self-assigned this 2026-06-04 08:23:27 +02:00

BaumiCoder added 27 commits 2026-06-04 08:23:27 +02:00

Skeleton for status command 94abd1a22d

Log status of included .editorconfig files 9aa1ba02f8

Make tests more accurate regarding paths ... 232fa4edc7

Depending on the way of producing Path instances, they are not always
relative paths. Therefore, use absolute paths in for all files tests
and use them also for the starts_with assertions. Otherwise,
the assertion simply cannot find the relative path in an absolute path
which can lead to miss a bug.

Avoid to miss relevant .editorconfig files ... 5263ffc6e7

For a given target directory not only the .editorconfig files in it
are relevant for the files in it. The .editorconfig files from parent
directories can also be relevant.
This change effect the status command and the spelling_language check.
For both it seems more logical to me, that all .editorconfig files
of the considered files are in the scope.

Do not write status info via logging ... 7c46125ed8

Writting the status info via logging has the disadvantages,
that a higher verbosity is required to get any output and is not
suitable in case of using ecformat as lib crate.
Therefore, using a struct to return the status info, which provides
functions to get the text representation of the status for printing.

Add details of considered files to status command 1826a214e7

Bug fixes for comments d201df3d36

Add first Unit Tests for status module 78e039be93

Control status verbosity by CLI options 08e90c7165

Respect EditorConfigArgs for the status command cd9a9f02a0

Move function for repo path to test utils ... 2bd3d8ce51

To allow usage also in other tests

Add first Integration Test for status command 3c376f4725

Workaround for spelling_language in status command ... dacf5088d7

Same as in SpellingLanguageHandler::build

Set spelling_language with EditorConfig ... b5bad8c0b3

Although, the language for the VSCodium extension LTeX+ is set already,
a general setting for the spelling language is may helpful when using
other editors to contribute to ecformat.

Assert spelling_language in status Test 985bdb57cd

Assert license files in Tests for status command 6060b18142

Assert tests resources in Tests for status command 93f4cc3cb9

Refactoring: Make ConsideredFile::path idiomatic ... 77bec6d6f2

- Rename from get_path() to path() as the prefix is not common in Rust.
- Change the return type from &PathBuf to &Path as
  this can be used more flexible.

Refactoring: Extract function 331ab5e52d

Refactoring: Extract functions ... ff25517207

To reduce the vebose proceding of all properties

Refactoring: Extract constant 6d1a91544c

Add Unit Tests for new functions in status module 113df47e57

Refactoring: Extract function 63f9cb4ded

Refactoring: Decrease verbosity of test cases ... cd6dd3d5f9

There is only one string property and one integer (only) property.
Therefore, the full enums in the test cases for them are not necessary
to see what property it is and the primitve type is enough.
This reduces how verbose the respective test code is.

Add further test cases for get_properties_counts 0ffab8472d

Fix spelling in comments b88b6f2882

Mention the status command in the README 119585b9d3

BaumiCoder added 6 commits 2026-06-04 10:39:45 +02:00

Make texts more consistent ... a0e6a189ac

The CLI help has a section to "disable" EditorConfig properties.
Therefore, talking about enabled properties is more consistent.

Fix gramma in comments 7c3d8b400e

Rename module to resolve name clash with function ... 6da4d00be3

Rename the status module to resolve the name clash
with the status function in the src/lib.rs.
This allows to use both in the same module, such as in src/lib.rs or
tests/status.rs.

Fix docs.rs warnings ... ba75ce4b38

Remove "redundant explicit link target",
"because label contains path that resolves to same destination"
(cites from the docs.rs warning).

CI & pre-commit: Fail on clippy warnings ... 4d4609cc1c

The warnings the in status_types Unit Tests are not visible in VSCodium
(due to some error). They are listed with cargo clippy if the test
targets are included. However, the automatic runs of clippy do not
fail on warnings! Adding a CLI to make them failing as expected.

Allow too_many_arguments for parametrized tests ... a452dc66ea

Allowing this clippy warning in all test code would be also fine.
However, the only way to do this seems to use compiler flafs for the
profile.test, but this feature is not stable in cargo yet, see issue:
https://github.com/rust-lang/cargo/issues/10271

BaumiCoder referenced this pull request from a commit 2026-06-04 12:38:30 +02:00

Merge branch 'feature/38-status-command'

BaumiCoder manually merged commit a3cd8362d5 into main 2026-06-04 12:38:31 +02:00

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

Compat/Breaking

Breaking change that won't be backward compatible

  

EditorConfig

0.17.2

Issues to support version 0.17.2 of the EditorConfig specification

  

Kind

Bug

Something is not working

  

Kind

Chore

Some tasks maintainig tasks

  

Kind

Documentation

Documentation changes

  

Kind

Enhancement

Improve existing functionality

  

Kind

Feature

New functionality

  

Kind

Testing

Issue or pull request related to testing

  

Packaging

About packaging the project for some platform

  

Priority

Critical

The priority is critical

  

Priority

High

The priority is high

  

Priority

Low

The priority is low

  

Priority

Medium

The priority is medium

  

Reviewed

Confirmed

Issue has been confirmed

  

Reviewed

Duplicate

This issue or pull request already exists

  

Reviewed

Invalid

Invalid issue

  

Reviewed

Won't Fix

This issue won't be fixed

  

Status

Abandoned

Somebody has started to work on this but abandoned work

  

Status

Blocked

Something is blocking this issue or pull request

  

Status

Need More Info

Feedback is required to reproduce issue or to continue work

  

WIP

Work in progress (Assignee is working on this issue)

No labels

Compat/Breaking

EditorConfig

0.17.2

Kind

Bug

Kind

Chore

Kind

Documentation

Kind

Enhancement

Kind

Feature

Kind

Testing

Packaging

Priority

Critical

Priority

High

Priority

Low

Priority

Medium

Reviewed

Confirmed

Reviewed

Duplicate

Reviewed

Invalid

Reviewed

Won't Fix

Status

Abandoned

Status

Blocked

Status

Need More Info

WIP

Milestone

Clear milestone

No items

No milestone

Version 0.2.0

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

BaumiCoder

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

BaumiCoder/ecformat!50

No description provided.