compose

README

Composition Tool Specification

The composition tool is a command-line tool that helps developers manage dependencies for their projects. It allows developers to specify the dependencies for a project in a "plasma-compose.yaml" file, and then fetches and installs those dependencies in a structured and organized way.

The tool works by recursively fetching and processing the "plasma-compose.yaml" files for each package and its dependencies, and then merging the resulting filesystems into a single filesystem.

CLI

The composition tool is invoked from the command line with the following syntax: launchr compose [options] Where options are:

• -w, --working-dir : The directory where temporary files should be stored during the composition process. Default is the .compose/packages
• -s, --skip-not-versioned : Skip not versioned files from source directory (git only)
• --conflicts-verbosity: Log files conflicts in format "[curent-package] - path to file > Selectef from [domain, other package or current-package]"

example usage - launchr compose -w=./folder/something -s=1 or -s=true --conflicts-verbosity

plasma-compose.yaml File Format

The "plasma-compose.yaml" file is a text file that specifies the dependencies for a package, along with any necessary metadata and sources for those dependencies. The file format includes the following elements:

• name: The name of the package.
• version: The version number of the package.
• source: The source for the package, including the type of source (Git, HTTP), URL or file path, merge strategy and other metadata.
• dependencies: A list of required dependencies.

Example:

name: myproject
version: 1.0.0
dependencies:
- name: compose-example
  source:
    type: git
    ref: master
    tag: 0.0.1
    url: https://github.com/example/compose-example.git
    strategy:
      - name: remove-extra-local-files
        path: path/to/remove-extra-local-files

Fetching and Installing Dependencies

The composition tool fetches and installs dependencies for a package by recursively processing the "plasma-compose.yaml" files for each package and its dependencies. The tool follows these general steps:

1. Fetch the package source code from the specified source location.
2. Extract the package contents to a temporary directory.
3. Process the "plasma-compose.yaml" file for the package, fetching and installing any necessary dependencies recursively.
4. Merge the package filesystem into the final platform filesystem.
5. Repeat steps 1-4 for each package and its dependencies.

During this process, the composition tool keeps track of the dependencies for each package.

Documentation

Overview

Package compose implements a launchr plugin to do platform composition

Index

• type Plugin
  • func (p *Plugin) CobraAddCommands(rootCmd *cobra.Command) error
  • func (p *Plugin) OnAppInit(app launchr.App) error
  • func (p *Plugin) PluginInfo() launchr.PluginInfo

Types

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

Plugin implements launchr.Plugin to provide compose functionality.

func (*Plugin) CobraAddCommands

func (p *Plugin) CobraAddCommands(rootCmd *cobra.Command) error

CobraAddCommands implements launchr.CobraPlugin interface to provide compose functionality.

func (*Plugin) OnAppInit

func (p *Plugin) OnAppInit(app launchr.App) error

OnAppInit implements launchr.Plugin interface.

func (*Plugin) PluginInfo

func (p *Plugin) PluginInfo() launchr.PluginInfo

PluginInfo implements launchr.Plugin interface.