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

"pesy project assist" feature [Brainstorm] #155

Open
jordwalke opened this issue Aug 6, 2020 · 1 comment
Open

"pesy project assist" feature [Brainstorm] #155

jordwalke opened this issue Aug 6, 2020 · 1 comment
Labels
good first issue Good for newcomers

Comments

@jordwalke
Copy link
Member

jordwalke commented Aug 6, 2020

Pesy would be a great utility for detecting and reporting common issues with your project setup.
This Issue is to accumulate common issues that pesy is well positioned to detect and warn about.
We don't have enough requirements gathered to actually implement something like this feature but let's discuss the possibilities.
Basically, any time someone is confused by something with native projects, and they ask about it in the Discord support, is there some way that pesy can automatically detect the scenario and preemptively warn about it?

Workflow

  • pesy detects something with your project. Sometimes it can do so when running esy pesy and sometimes when running esy (if pesy is part of their build command).
  • Warnings could be shown once per project config.
    -- An issue is detected and a warning is shown when running esy pesy or esy.
    -- The output is printed with the same warning/error format as refmterr.
  • pesy snooze could snooze all warnings for your project.
    -- The warning is not shown again if nothing changes about your project.
    -- If you change your package.json, or file directory structure, then the warning could be shown again.
  • pesy snoozethat could just snooze the most recently shown warning (recording just that one in your package.json config)
  • pesy silence/pesy silencethat could be like snooze but disable warnings for the project permanently including for new checkouts (it could store them in the package.json or something).

Ideas for issues to detect

  • Your esy cache includes artifacts generated by different versions of gcc, or a version that is different than the one in your esy build environment.
  • Your build config refers to modules for which there are no .re files etc when it can easily be detected.
  • Your package.json includes things in dependencies that should probably be listed as devDependencies.

(Please reply if you have any ideas about common pitfalls we could automatically detect)

@jordwalke jordwalke added the good first issue Good for newcomers label Aug 6, 2020
@jordwalke
Copy link
Member Author

If we spec this out more thoroughly it would make a great first task for new contributors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant