Status

📙 Description

The dotnet biak status command returns the current biak mode for the root .editorconfig.

💻 Usage

dotnet biak status [--debug-info]

After executing this command, you may see one of the following outputs:

• enabled - means the current .editorconfig matches the enabled biak configuration.
• disabled - means the current .editorconfig matches the disabled biak configuration.
• unsynchronised - means the current .editorconfig does not match either the enabled or disabled biak configuration.
• broken - means something is incorrectly configured in biak (for example, the .editorconfig file was not found). Use the --debug-info flag for details.

❔ Why

• Provide the necessary functionality for an IDE editor UI button that displays the current biak status and enables users to toggle it directly from the editor. This removes the need to use the CLI and simplifies the development workflow.

• Automatically detect the current biak status, eliminating the need for manual checks to determine whether biak is enabled.

• Verify that the current status is correct and up to date. For example, this is useful when biak should always stay disabled locally and remain synchronised. This is also relevant for CI/CD checks to verify that the repository .editorconfig is in the expected biak state.

🔗 Links

• Issues: #117
• Source code: click