fm-tool

A command line tool to manage your federation manager project.

Note: This tool uses 2 default URLs which can be overwritten with environment variables.

FEDERATION_MANAGER_URL - where to look for project and packages. The default repository API is https://federation-manager.dsolver.ca/api
PLANTUML_URL - the domain for plantuml. The default is http://www.plantuml.com

Commands

npx fm-tool scaffold <project id> - fetches the project config and scaffolds the project in the current directory. This does not create exposed modules, only scaffolds the packages within and sets up a default webpack and the federation config as it would have been generated on the manager UI.

npx fm-tool scaffold-package <project id> <package id> - fetches the project config and scaffolds a specific package in the current directory.

npx fm-tool analyze <project id> <dir> - analyzes the project at a particular directory. The assumption is that the subdirectories in that directory correspond to packages in the project. The analyzer will scan and update the package.json of identified package folders with the federationManager identifications. The output is a link to a plantuml diagram (svg) showing the dependencies between exposed modules and the modules that consume them.

npx fm-tool fetch-dts <dir> <package id (optional)> - creates Typescript Declaration files based on the remotes that this package uses. If there are no existing DTs, it will stub it out.

npx fm-tool update-dts <package id (optional)> - generates Typescript Declaration files based on what is exposed. This uses the Typescript included in fm-tool rather than the one in your project, so please be aware of potential differences in Typescript versions.