Workspace

Table of contents

  1. Introduction
  2. What each folder is
    1. Names Docker takes
    2. A product in a folder of another name

Introduction

The commands in this section work on the workspace as a whole, every folder at its root at once, rather than on one product or one feature.

Command What it does
workspace:status Shows the products, features and product lines, and how each product uses each feature
workspace:sync Updates every checkout and clones what the marketplace offers that the workspace lacks

What each folder is

A folder’s name says nothing. Every command reads what a folder holds.

A folder is When it holds Its name is
A feature A pyproject.toml with [tool.splent.contract] Its package, the folder under src/<namespace>/
A product A pyproject.toml whose [tool.splent] lists features or names an spl Its [project].name
A product line A metadata.toml with an [spl] table Its [spl].name
The toolchain A pyproject.toml named splent_framework or splent_cli That name

So a repository called uvlhub holds the product uvlhub_splent, and one called OFELIA may hold the feature ofelia. A product refers to a feature by its namespace and package, as in acme/ofelia@v1.0.0, whatever folder its checkout is in.

A feature’s short name drops splent_feature_ when it has it, so splent_feature_accounts is accounts and ofelia stays ofelia. A short name the CLI does not find among the features in reach is read as SPLENT’s own, so accounts means splent_feature_accounts.

Names Docker takes

Containers, images and Compose projects follow Docker’s rules: lower case letters, digits, _, - and .. A product’s name is turned into one, so a product called POPEYE runs in the container popeye_web and the image popeye:latest. A name that already follows the rules is kept as it is.

A product in a folder of another name

SPLENT_APP names the product and SPLENT_APP_DIR the folder it is in. product:select writes both. The development compose passes the folder to the product’s container, and the scripts and the editable install read it there, so a product can be cloned into any folder. The production image copies the product into a folder called like it, so it needs neither.


Table of contents


Back to top

splent. Distributed by an LGPL license v3. Contact us: drorganvidez@us.es