Skip to content

feat(cli): modify config short flag to -c #383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2024
Merged

feat(cli): modify config short flag to -c #383

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ members = ["cli"]
resolver = "2"

[workspace.package]
version = "0.1.12"
version = "0.2.0"
authors = ["KeisukeYamashita <[email protected]>"]
license = "MIT OR Apache-2.0"
documentation = "https://keisukeyamashita.github.io/commitlint-rs"
Expand All @@ -12,4 +12,4 @@ categories = ["command-line-utilities"]
readme = "README.md"
repository = "https://github.com/KeisukeYamashita/commitlint-rs"
exclude = ["/web"]
edition = "2021"
edition = "2021"
2 changes: 1 addition & 1 deletion cli/src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use crate::rule::Rules;
const DEFAULT_CONFIG_ROOT: &str = ".";

/// Default commitlintrc configuration files
/// If the user didn't specify a configuration file with -g or --config argument,
/// If the user didn't specify a configuration file with -c or --config argument,
/// we will try to find one of these files in the current directory.
const DEFAULT_CONFIG_FILE: [&str; 4] = [
".commitlintrc",
Expand Down
6 changes: 3 additions & 3 deletions web/src/content/docs/config/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ Note that it is searched in the order written above and the first one found is l

### Using the flag

Configuration file can be specified by using the `--config` flag or the short `-g` flag.
Configuration file can be specified by using the `--config` flag or the short `-c` flag.

```console
# Using --config flag
$ commitlint --config path/to/.commitlintrc.yml

# Using -g flag
$ commitlint -g path/to/.commitlintrc.yml
# Using -c flag
$ commitlint -c path/to/.commitlintrc.yml
```

If you specify a file and the file is not found, Commitlint will throw an error.
Expand Down
Loading