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

Implement all requirements for the journey "First contact (PoC)" #322

Closed
51 of 56 tasks
BioPhoton opened this issue Nov 26, 2023 · 1 comment
Closed
51 of 56 tasks

Implement all requirements for the journey "First contact (PoC)" #322

BioPhoton opened this issue Nov 26, 2023 · 1 comment
Assignees
Labels
🧩 cli 🛍️ epic Group of issues 📖 Project documentation improvements or additions to the project documentation

Comments

@BioPhoton
Copy link
Collaborator

BioPhoton commented Nov 26, 2023

First contact - Implementing a PoC

I want to install the CLI and produce an output without any problems.

This make me do the following things:

  • Go to a product site (NPM or GitHub site).
  • Read the documentation.
    • Looking for a quickstart guide or a Getting started in README. 🔥
    • There should be a concise yet compact section that fits in one page.

Practical part

  • Install the package.
  • Set up the CLI locally. 🔥
    • There should be a preset config file.
    • There should be an option to use default plugins (ideally a prompt).
  • Run the CLI.
    • There should be a CLI logger that tells me what is happening.
    • There should be a progress bar/spinner to let me know something is happening.
  • A report is generated.
    • There should be a report in terminal (stdout) by default. 🔥

Theory

After I get an output, I want to understand the full content of the report and its entities.


Preconditions

Feedback 1:

  • make collect the default command
    • first try you run npx code-pushup and the default command is autorun
    • this requires upload credentials this is a blocker
    • error message was not helpful
  • graceful failure warn instead of error
  • if no plugins warning instead of error

Feedback 2:

  • eslint not linked in readme get start
  • setup form wiki to eslint readme
  • reduce eslint setup code snippets => new defaults
  • eslint readme wiki: mention why we extend real -> cpu in lint setup (because better DX)
  • eslint readme wiki: snippet and source code and duplicates
  • minimatch is dept to avoid
  • script died because heaperror
  • rerunning should respect alreaedy updated folders

Todos

Future Todos:

  • Npx command to setup default config #739
    • Add comment to default Code PushUp confings with link to docs
  • Plugin setup is guided by CLI
  • nx plugin
    • eslint readme wiki: mention why we extend real -> cpu in lint setup (because better DX)
    • eslint readme wiki: snippet and source code and duplicates
    • minimatch is dept to avoid
    • script died because heaperror
    • rerunning should respect alreaedy updated folders
@BioPhoton BioPhoton added 📖 Project documentation improvements or additions to the project documentation 🧩 cli 🛍️ epic Group of issues labels Nov 26, 2023
@BioPhoton
Copy link
Collaborator Author

BioPhoton commented Jan 26, 2024

Feedback:

  • first try you run npx code-pushup and the default command is autorun
    • this requires upload credentials this is a blocker
    • error message was not helpful
    • graceful failure warn instead of error
  • only plugin is eslint and that is hard
    • if no plugins warning instead of error
  • docs are outdated
  • when no config is there is says path invalid... it should say not found??

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧩 cli 🛍️ epic Group of issues 📖 Project documentation improvements or additions to the project documentation
Projects
None yet
Development

No branches or pull requests

1 participant