-
Notifications
You must be signed in to change notification settings - Fork 46
Home
VBAToolkit is an open-source framework aiming to ease the development of quality VBA code.
It is designed to be used as a tool on the developer's machine to create and manage a VBA project (only Excel at the moment).
Its features include :
Management of configurations
Currently, its main feature is to ease the management of different configurations of a VBA project. Mainly a configuration for delivery to the end user, and a configuration for development purpose. The second one contains test modules not included in the first one.
Allowing versioning
VBA modules are stored separately in text files, consistent versioning is made possible.
Though, VBATookit does not integrate any versioning system ; using a third party software such as Git in the project directory is the way.
Team collaborative development
Excel files can be regenerated from the text source code under version management. This facilitates the merge operations and thus the team collaborative development.
Facilitating Test Driven Development
VBAToolkit integrates the open-source unit-testing VBAUnit framework to encourage and facilitate Test Driven Development, an healthy development method.
Convenient interface
A toolbar in Excel and several automatic functions provide easy access to these features.
A VBA Project managed with VBAToolKit is associated with a folder (see the project folder description). The name of this folder is the same as the project. Main subfolders and files of the project structure, assuming your project is named SampleProject are:
- Project\SampleProject_DEV.xlsm is the main Excel workbook in which you'll develop and test your VBA Modules, Classes and UserForms
- Project\SampleProject.xml contains the configuration description of the project in a convenient way to be managed with git. The configuration description is duplicated in the Project\SampleProject_DEV.xlsm Excel workbook which is easier to modify for the developer than the XML file
- Delivery\SampleProject.xlsm (you might choose .xlam if you prefer) is the file to be delivered to the users and customers of your project (including yourself if you are also a user, not only a developer). This file is generated by VBAToolKit based on the project configuration
- Template subfolder contains files to be used as templates for tests or for Excel workbook generation
A project can manage several configurations. A configuration is mainly an Excel worksheet composed of VBA components (modules, classes, UserForms). By default, a project named SampleProject has two configurations named SampleProject (the configuration to deliver) and SampleProject_DEV (the configuration for development and tests).
VBAToolKit is developed by Skwal-Soft and JPI-Conseil
This work is licensed under the Apache License, version V2.0