Skip to content
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.

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

feat: create CLI POCs #48

Merged
merged 12 commits into from
Oct 14, 2024
Merged

feat: create CLI POCs #48

merged 12 commits into from
Oct 14, 2024

Conversation

F-Kublin
Copy link
Collaborator

No description provided.

biome.json Outdated Show resolved Hide resolved
biome.json Outdated Show resolved Hide resolved
biome.json Outdated Show resolved Hide resolved
packages/cli/package.json Outdated Show resolved Hide resolved
packages/cli/package.json Outdated Show resolved Hide resolved
Copy link
Collaborator

@angjez angjez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to see an example valid for this project, so an example of the output the cli would produce when connected with the target logic
I'd also be very happy to see an example usage with flags, because it will be easier for me to know what to expect when re-implementing core
So the examples could verify things like:

  • conditional output
  • usage with flags
  • outputting tables
  • performance of both - given the same output to produce
    It might turn out that pastel deals with something better than commander and vice versa

So for example:

  1. Output 1:
  • variant 1: license-auditor succeeded in Xms ✅ 2137 packages contain valid licenses
  • variant 2: license-auditor failed in Xms 🔴 2130 packages passed, 7 packages failed + print packages which failed and their license
    Everything of course 100% mocked, just to see how the output of the coded app would look and how both libs treat conditional output
  1. Output 2 - how it would work with --verbose flag
  • auditing package X
  • license found in <package.json/license file/readme>: <found license>
  • print a table with the complete output: package, license, failed/passed
  • print the dependency tree

See how it looks with commander, see how it looks with pastel

I'm asking for this because the provided PoC contains documentation examples unspecific to this package. So it's not a PoC, it's just library setup done according to the docs. So to know which package to select I'd like to compare what both would output for a theoretical run when the logic is connected.
And with a PoC as such when we pick 1 option or the other the PoC can become a base for the coded package

packages/cli/tsconfig.json Outdated Show resolved Hide resolved
@F-Kublin F-Kublin merged commit 81cbcb3 into release-v2.0.0 Oct 14, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants