Skip to content

Refactoring for a Modular and Extensible Architecture (v1.1.0) #1

Description

@AxelRhul

Description

Currently, VulnWatcher is primarily designed to work with Discord. To extend its functionality and make it more versatile, a refactoring of the architecture is needed. The goal is to create a modular structure that allows easy addition of new notification platforms (email, webhooks, etc.) and integration of future features.

Objective

Modularize the code: Separate the different parts of the bot (vulnerability analysis, notifications, data storage, configuration downloading) into independent and reusable modules.

Tasks

  • core module :

    • Move vulnerability analysis logic to src/core/vulnerabilityScanner.js
  • download module :

    • Move the download of the packages register files (composer.lock and package-lock.json) to src/download/packageFileDownloader.js
    • change configs/ folder to packagesFiles/ folder
  • notification module :

    • Move notification system to src/notification/discordNotifier.js
  • global configration :

    • move config.json and sent_vulns.json to config/ folder
  • documentation :

    • Update the whole general documentation to make the code more clear

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions