Skip to content

Make Linter Extension and API public#13902

Merged
saintentropy merged 3 commits intoDynamoDS:masterfrom
saintentropy:MakeLinterPublicAPI
Apr 24, 2023
Merged

Make Linter Extension and API public#13902
saintentropy merged 3 commits intoDynamoDS:masterfrom
saintentropy:MakeLinterPublicAPI

Conversation

@saintentropy
Copy link
Contributor

@saintentropy saintentropy commented Apr 13, 2023 •
edited
Loading

Purpose

Expose the LinterExtensionBase as a public base class so that user can create linter extensions to create rule sets for Dynamo graphs beyond the GenerativeDesign type.

Declarations

Check these if you believe they are true

  • The codebase is in a better state after this PR
  • Is documented according to the standards
  • The level of testing this PR includes is appropriate
  • User facing strings, if any, are extracted into *.resx files
  • All tests pass using the self-service CI.
  • Snapshot of UI changes, if any.
  • Changes to the API follow Semantic Versioning and are documented in the API Changes document.
  • This PR modifies some build requirements and the readme is updated
  • This PR contains no files larger than 50 MB

Release Notes

(FILL ME IN) Brief description of the fix / enhancement. Mandatory section

Reviewers

@BogdanZavu .

FYIs

@mjkkirschner @twastvedt

@BogdanZavu
Copy link
Contributor

BogdanZavu commented Apr 14, 2023 •
edited
Loading

I think there are a few more things :
internal abstract class LinterExtensionBase
internal event Action OnLinterLinkToWorkspace
internal event Action OnLinterUnlinkFromWorkspace
internal class GraphRuleEvaluationResult
internal class NodeRuleEvaluationResult
internal void OnRuleEvaluated(IRuleEvaluationResult result)
internal bool IsActive => this.linterManager?.IsExtensionActive(UniqueId) ?? false;
internal void InitializeBase(LinterManager linterManager)

@BogdanZavu
Copy link
Contributor

BogdanZavu commented Apr 21, 2023 •
edited
Loading

Thinking of the minimal exposure needed for the upcoming DA check rules I think we only need internal abstract class LinterExtensionBase from the list above so let's add that and then LGTM @saintentropy

@QilongTang
Copy link
Contributor

QilongTang commented Apr 24, 2023

@saintentropy @BogdanZavu @twastvedt We are going to release Dynamo 2.18 soon, is this one required?

@saintentropy
Copy link
Contributor Author

saintentropy commented Apr 24, 2023

@QilongTang Yes please

@saintentropy saintentropy merged commit 5f7f7ea into DynamoDS:master Apr 24, 2023
@QilongTang
Copy link
Contributor

QilongTang commented Apr 24, 2023

@saintentropy Please cherry-pick this to RC branch as well then

saintentropy added a commit to saintentropy/Dynamo that referenced this pull request Apr 24, 2023
@saintentropy
Make Linter Extension and API public (WIP) (DynamoDS#13902)
14db871 
* Make Linter base case public

* Typos

* Missing base class to public

---------

Co-authored-by: Craig Long <[email protected]>
(cherry picked from commit 5f7f7ea)
@saintentropy saintentropy removed the WIP label Apr 24, 2023
@saintentropy saintentropy changed the title Make Linter Extension and API public (WIP) Make Linter Extension and API public Apr 24, 2023
@saintentropy saintentropy mentioned this pull request Apr 24, 2023
Merged
9 tasks
QilongTang pushed a commit that referenced this pull request Apr 25, 2023
@saintentropy
Make Linter Extension and API public (WIP) (#13902) (#13933)
1932a36 
* Make Linter base case public

* Typos

* Missing base class to public

---------

Co-authored-by: Craig Long <[email protected]>
(cherry picked from commit 5f7f7ea)

Co-authored-by: Craig Long <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@BogdanZavu BogdanZavu BogdanZavu approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@saintentropy @BogdanZavu @QilongTang