search

partiql / partiql-lang-kotlin

PartiQL libraries and tools in Kotlin.
https://partiql.org/
Apache License 2.0
536 stars 60 forks source link

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

Closed alancai98 closed 3 months ago

alancai98 commented 3 months ago

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.

github-actions[bot] commented 3 months ago

Conformance comparison report

Base (d059c81b7706ec1b85cca799eaa48c523806cb66) 54bba3293140fe2908b3175c4149c9a2dbfa9a50 +/-
% Passing 92.54% 92.54% 0.00%
:white_check_mark: Passing 5384 5384 0
:x: Failing 434 434 0
:large_orange_diamond: Ignored 0 0 0
Total Tests 5818 5818 0

Number passing in both: 5384

Number failing in both: 434

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

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

codecov-commenter commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files ```diff @@ 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](https://app.codecov.io/gh/partiql/partiql-lang-kotlin/pull/1413/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=partiql) | Coverage Δ | | |---|---|---| | [CLI](https://app.codecov.io/gh/partiql/partiql-lang-kotlin/pull/1413/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=partiql) | `11.82% <ø> (ø)` | | | [EXAMPLES](https://app.codecov.io/gh/partiql/partiql-lang-kotlin/pull/1413/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=partiql) | `80.07% <ø> (ø)` | | | [LANG](https://app.codecov.io/gh/partiql/partiql-lang-kotlin/pull/1413/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=partiql) | `81.06% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=partiql#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.