https://github.com/MaxOffice/MOVBA

A PowerShell module to manage VBA macro libraries.
https://github.com/MaxOffice/MOVBA

Last synced: 8 days ago
JSON representation

A PowerShell module to manage VBA macro libraries.

• Host: GitHub
• URL: https://github.com/MaxOffice/MOVBA
• Owner: MaxOffice
• License: mit
• Created: 2022-01-21T13:21:05.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-08T06:33:27.000Z (9 months ago)
• Last Synced: 2024-05-23T00:31:35.282Z (7 months ago)
• Language: PowerShell
• Size: 28.3 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - MaxOffice/MOVBA - A PowerShell module to manage VBA macro libraries. (PowerShell)

README

        
# MOVBA

A PowerShell module to manage VBA macro libraries.

![MOVBA Logo](/MOVBA.png)

## Concepts

In the context of this project, a VBA macro _library_ is a collection of useful

functionality implemented using VBA macros. A single library contains macros 

for one Microsoft Office application only. 

Within a library, macros are further arranged into _packages_. Each package implements a particular functionality. A package can expose its functionality via functions that can be called from other macros, or via an interactive user interface.

Packages in a library can be combined to form a Microsoft Office document or add-in. Users can choose all packages, or selective packages, when they build a document or add-in from the library.

## Libraries

A library is a directory with the following structure:

```

  \

  |

  --out\

  |

  --packages\

  |

  library.json

```

The `out\` subdirectory contains add-ins or documents created by combining packages in the library.

The `packages` subdirectory contains packages.

The `library.json` file contains metadata about the library, including the name of the library and the Microsoft Office application which is the target of all macros contained in the library.

The `Get-MVLibrary`, `New-MVLibrary` and `Build-MVLibrary` cmdlets in this module are used to manage libraries.

## Packages

A package is a directory with the following structure:

```

  \

  |

  --Tests\

  |

  --CustomUI\

  |   |

  |   customUI.xml

  |

  

```

A package must have a name that is unique in the library. Package names are treated case-insensitively in this module.

The package directory contains VBA files, such as VBA Modules (.bas files), VBA Class Modules (.cls files), and UserForms (.frm and .frx files). When a document or an add-in is built from the library, and a package is included, all these files are imported into the resulting document or add-in.

The `tests\` subdirectory should contain a document created using the Microsoft Office application that is the target of the parent library. This document should have test cases for checking the functionality implemented by the package.

The `CustomUI\` subdirectory contains a file called `customUI14.xml`, written using the Microsoft Office [RibbonX](https://docs.microsoft.com/en-us/office/vba/library-reference/concepts/customize-the-office-fluent-ribbon-by-using-an-open-xml-formats-file) specification. When a document or an add-in is built from the library, and a package is included, its `customUI14.xml` file is merged with that of other packages and imported into the resulting document or add-in.

The `Get-MVPackage`, `New-MVPackage` and `Remove-MVPackage` cmdlets in this module are used to manage packages.