quarkusio/quarkus

fix and document console-aliases.txt

Open

#33528 opened on May 22, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Java (12,967 stars) (2,464 forks)batch import
area/devmodegood first issuekind/bug

Description

Describe the bug

console-aliases.txt is in the code and used in #23497 PR but I found a few issues:

  1. console-aliases.txt is not documented anywhere. we should fix that :)
  2. the file gets rewritten somehow automatically meaning if you have two quarkus dev running things goes bad. (lines deleted)
  3. spaces are inconsistently handled. you must quote spaces, so alias ll=config set quarkus.log.console.format="max\ %d{HH:mm:ss,SSS}\ %-5p\ [%c{3.}]\ (%t)\ %s%e%n" works but when I add it I end up with rewritten file:
alias ll=config set quarkus.log.console.format="max\ %d{HH:mm:ss,SSS}\ %-5p\ [%c{3.}]\ (%t)\ %s%e%n"
quarkus.log.console.format=max\ %d{HH:mm:ss,SSS}\ %-5p\ [%c{3.}]\ (%t)\ %s%e%n
  1. lines without alias is ignored, nothing printed to console that file is problematic
  2. the file is created even if alias list is empty
  3. alias --help gives no info.
  4. alias not listed in help
  5. finally - local project aliases would be nice...i.e. not all aliases makes sense for everyone.

Expected behavior

No response

Actual behavior

No response

How to Reproduce?

No response

Output of uname -a or ver

No response

Output of java -version

No response

GraalVM version (if different from Java)

No response

Quarkus version or git rev

No response

Build tool (ie. output of mvnw --version or gradlew --version)

No response

Additional information

No response

Contributor guide

Tech stack
java
Domain
clidocumentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaQuarkus CLIBasic understanding of alias files
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
First, review PR #23497 to understand the intended usage of console aliases.txt. Then, explore the Quarkus source code to locate where the file is generated and managed. Address each issue (1-8) by fixing code bugs, adding documentation, and possibly enhancing alias handling. Consider implementing local project aliases as a feature. Check the comments on the issue for any additional insights.