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

[heft] Heft Plugin API should provide one-stop-shopping for common functionality #5092

Open
dmichon-msft opened this issue Jan 31, 2025 · 0 comments

Comments

@dmichon-msft
Copy link
Contributor

dmichon-msft commented Jan 31, 2025

Summary

Heft plugin authors should be able to access commonly used functionality using only the arguments provided to the instantiation of their Plugin via the Heft runtime.

Details

Specific functionality gaps include:

  • JSON Schema validation (prevent taking a direct dependency on @rushstack/node-core-library)
  • Definition of a riggable ConfigurationFile (prevent taking a direct dependency on @rushstack/heft-config-file)

For comparison, we already provide command line parameter configuration entirely via a combination of the heft-plugin manifest and the HeftSession object.
Similarly, Terminal capabilities are provided without need to import @rushstack/terminal (for any runtime code).

Doing so synergizes with bundling of @rushstack/heft into a single file and allows for reuse of library code without additional imports.

Standard questions

Please answer these questions to help us investigate your issue more quickly:

Question Answer
@rushstack/heft version? @0.68.13
Operating system? Linux
Would you consider contributing a PR? Yes
@github-project-automation github-project-automation bot moved this to Needs triage in Bug Triage Jan 31, 2025
@iclanton iclanton moved this from Needs triage to Low priority in Bug Triage Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Low priority
Development

No branches or pull requests

1 participant