Skip to content

[rig-package] Expose an IRigConfig interface and use it in consuming projects' APIs. #4212

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

Merged
merged 1 commit into from
Jun 19, 2023

Conversation

iclanton
Copy link
Member

Summary

Similar to Terminal vs ITerminal, this PR is creating an IRigConfig interface to be used in APIs to avoid issues with mismatched versions of @rushstack/rig-package.

How it was tested

Built.

Impacted documentation

The IRigConfig interface needs to be added to the API docs.

Copy link
Contributor

@dmichon-msft dmichon-msft left a comment

Choose a reason for hiding this comment

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

Only thing I might change is to differentiate the docs on the RigConfig class vs. the IRigConfig interface, since the latter is only for instances and the former has the loader API.

@iclanton iclanton disabled auto-merge June 19, 2023 22:10
@iclanton iclanton enabled auto-merge June 19, 2023 22:14
@iclanton
Copy link
Member Author

Ehh I'm not really concerned about that in the docs. It should be pretty obvious, and people can keep using the RigConfig type if they want.

@iclanton iclanton merged commit 96c6817 into microsoft:main Jun 19, 2023
@iclanton iclanton deleted the IRigConfig branch June 19, 2023 22:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants