quarkusio/quarkus

fix and document console-aliases.txt

Open

#33,528 创建于 2023年5月22日

在 GitHub 查看
 (4 评论) (0 反应) (0 负责人)Java (12,967 star) (2,464 fork)batch import
area/devmodegood first issuekind/bug

描述

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

贡献者指南

技术栈
java
领域
clidocumentation
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
JavaQuarkus CLIBasic understanding of alias files
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
45
研究方向
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.