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

Add warning to not implement sprout-generated visitor interfaces #1413

Merged
merged 1 commit into from
Apr 4, 2024

Conversation

alancai98
Copy link
Member

Relevant Issues

Description

Similar to #1406 but just adds the warning to not implement the sprout-generated visitor interfaces. This will currently be applied for the AstVisitor and PlanVisitor.

// AstVisitor.kt
/**
 * WARNING: This interface should not be implemented or extended by code outside of this library.
 * Please extend [AstBaseVisitor].
 */
public interface AstVisitor<R, C> {
	// rest of code
}
// PlanVisitor.kt
/**
 * WARNING: This interface should not be implemented or extended by code outside of this library.
 * Please extend [PlanBaseVisitor].
 */
public interface PlanVisitor<R, C> {
	// rest of code
}

Other Information

License Information

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@alancai98 alancai98 self-assigned this Apr 4, 2024
@alancai98 alancai98 requested a review from rchowell April 4, 2024 22:33
Copy link

github-actions bot commented Apr 4, 2024

Conformance comparison report

Base (d059c81) 54bba32 +/-
% Passing 92.54% 92.54% 0.00%
✅ Passing 5384 5384 0
❌ Failing 434 434 0
🔶 Ignored 0 0 0
Total Tests 5818 5818 0

Number passing in both: 5384

Number failing in both: 434

Number passing in Base (d059c81) but now fail: 0

Number failing in Base (d059c81) but now pass: 0

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.16%. Comparing base (d059c81) to head (6f667e9).

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #1413   +/-   ##
=========================================
  Coverage     73.16%   73.16%           
  Complexity     2393     2393           
=========================================
  Files           247      247           
  Lines         17627    17627           
  Branches       3178     3178           
=========================================
  Hits          12896    12896           
  Misses         3854     3854           
  Partials        877      877           
Flag Coverage Δ
CLI 11.82% <ø> (ø)
EXAMPLES 80.07% <ø> (ø)
LANG 81.06% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@alancai98 alancai98 merged commit 679af95 into main Apr 4, 2024
10 checks passed
@alancai98 alancai98 deleted the add-interface-warning branch April 4, 2024 23:10
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.

[sprout] Add warning/@OptIn option for sprout-generated interfaces
3 participants