Skip to content
This repository was archived by the owner on Apr 4, 2025. It is now read-only.
This repository was archived by the owner on Apr 4, 2025. It is now read-only.

[FEATURE] CLI Interface #2

@Rawlsy-py

Description

@Rawlsy-py

Is your feature request related to a problem? Please describe.
Currently, the tool lacks a user-friendly command-line interface (CLI) for specifying formatting options. Users need a simple way to apply different formatting types to their SQL files without manually editing the code or using complex commands.

Describe the solution you'd like
I would like a CLI interface developed using Typer, which provides flags for each formatting option. The CLI should allow users to easily specify whether they want to apply uppercase conversion to SQL keywords, use leading commas, or apply other formatting types we might introduce in the future. For instance, users should be able to use commands like the following:

dbt-lint format --uppercase --leading-comma path/to/file.sql

This command would apply both uppercase conversion and leading comma formatting to the specified SQL file.

Describe alternatives you've considered
An alternative could be a configuration file where users specify their formatting preferences. However, this might not be as straightforward for one-off formatting tasks or when different files require different formatting styles.

Additional Context
The CLI interface should be intuitive and easy to use, with clear help documentation that explains each flag and its effect on the formatting. Integration with Typer will also allow for future expansion of the tool with additional commands and options.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions