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

refactor: reorganise code structure to prepare for Snyk OSS integration [ROAD-236] #35

Merged
merged 1 commit into from
Aug 4, 2021

Conversation

michelkaporin
Copy link
Contributor

The code is grouped by product and organised in the following way:

  • itly
  • snyk
    • common
      Code that will be shared between different product and feature integrations: configuration, analytics, logging, shared view elements, etc.
    • base
      Code that provides base elements for the extension: status bar item, loading badge, welcome web view. Current monolith module is included as it's the entry point to the extension functionality.
    • snykCode
      Code related to Snyk Code product integration, including view and code providers.
    • openSource
      Code related to Snyk Open Source integration. Folder will be added later during dev work on it.

Additionally, this refactoring includes:

  • File naming brought to consistency (updated to camelCase)
  • BundlesModule refactored and extracted to corresponding SnykCode class with event subscriptions in the Progress class.
  • Redundant interfaces removed
  • Some interfaces were moved closer to the code that uses them
  • Interface naming brought to consistently (start with letter "I").

@michelkaporin michelkaporin requested review from pavel-snyk and a team July 30, 2021 07:05
@michelkaporin michelkaporin force-pushed the refactor/extract-code branch from af1c3c2 to 7582fc1 Compare August 2, 2021 09:42
Copy link
Contributor

@pavel-snyk pavel-snyk left a comment

Choose a reason for hiding this comment

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

Love to see more structure in the plugin, 👍 .

p.s. PR related to ROAD-236, right?

@michelkaporin michelkaporin changed the title refactor: reorganise code structure to prepare for Snyk OSS integration refactor: reorganise code structure to prepare for Snyk OSS integration [ROAD-236] Aug 4, 2021
@michelkaporin
Copy link
Contributor Author

@pavel-snyk thank you. ROAD-236 - that's correct, amended the heading :)

@michelkaporin michelkaporin merged commit a5007da into master Aug 4, 2021
@michelkaporin michelkaporin deleted the refactor/extract-code branch August 4, 2021 10:54
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.

2 participants