chore: add better-scripts to improve DX

Zhengqbbb / cz-git

cz-git | czg 🛠️ DX first and more engineered, lightweight, customizable, standard output format Commitizen adapter and CLI

https://cz-git.qbb.sh

MIT License

1.12k stars 41 forks source link

chore: add better-scripts to improve DX #54

Closed iamyoki closed 2 years ago

iamyoki commented 2 years ago

Related ISSUE

Closes #53

Input follow ISSUE URL address

Type Of Change

[ ] 🐞 Bug fix (non-breaking change which fixes an issue)
[x] ✨ New feature (non-breaking change which adds functionality)
[ ] 📝 Document (This change requires a documentation update)
[ ] 🎨 Theme style (Theme style beautification)
[ ] ⚠ Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] 🔨 Workflow (Workflow changes)

Clear Describe

A clear and concise description of what update for target.

iShot_2022-08-10_09 47 20

Description

Please enter detailed relevant motivation, background and implementation ... descriptive information.

Test Case

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test case.

Zhengqbbb commented 2 years ago

This tool is cool and fast to use ～ Thx

My opinion

Add the ls subcommand: better-scripts.js list [name] | ls [name] Show all scripts in table
alias configuration rename I noticed that you used alias as a name, but you can keep the real meaning of alias here as features like: pnpm scripts run lint = pnpm script :l or other aliases usage not only as name
Compact mode should not use table The list has been displayed in a table, and I understand that Compact should be simpler to display the necessary information (like list)
Project dependencies can also be reduced Too many dependencies should not be introduced. After all, it should be a lightweight tool placed in the project root dependency and used globally. Too many subsidiary dependencies are likely to cause 👻 ghost dependencies

Anyway, the above is my point of view, it can be ignored for reference only, I use it, Thx~

iamyoki commented 2 years ago

@Zhengqbbb Your opinions above are valuable, thx alt.

Good advice, I'll add ls later today.
Actually, alias was designed intentionally for prompt display purpose only, it shouldn't be used as a command index, the only index for command is "name" (key in config object), keeping it simple might be better.
Good advice, I'll write it down on my little book book.
Good advice, it will be optimized in the future, might need some helps from you.

add a weixin? yokiijay

Zhengqbbb commented 2 years ago

@iamyoki you can find me on discord Thx u work~