Checkout Folder Layout

mmt checkout writes five folders, plus .mmt for its own tracking. They’re always created, even when empty.

mystore-dev/
├── .mmt/              MMT's tracking data for this checkout
├── templates/         Page templates and their settings
├── properties/        Store, product and category properties
├── js/                JavaScript resources
├── css/               CSS resources
└── resourcegroups/    Resource groups

A real checkout#

The Shadows repository keeps the mmt checkout of a stock Shadows store in its mmt folder, with a tag for each release (https://github.com/mivaecommerce/shadows/tree/<version>/mmt). Browse it to see what each file looks like. A shortened view:

mmt/
├── templates/
│   ├── abal.mvt                                     Page template
│   ├── abal.json                                    The page's settings
│   ├── abal-header.mvt                              Template of an item on the page
│   ├── email_abandoned_basket.mvt                   Email page template
│   └── email_abandoned_basket-toe_basket_contents.mvt
├── properties/
│   ├── cssui_button/        <code>.json and <code>.mvt for each button
│   ├── font/                <name>.json for each font
│   ├── mm_theme/            fonts.mvt
│   ├── readytheme_banner/   header_message.json
│   ├── readytheme_contentsection/
│   ├── readytheme_image/
│   ├── readytheme_lookandfeel/   settings.json
│   ├── readytheme_navigationset/
│   ├── templateorderemail/  ABANDONED_BASKET.json, BACKORDER_NOTICE.json, ...
│   └── theme/               theme.json
├── js/
│   ├── GTM-dataLayer.json   Inline resource: settings
│   └── GTM-dataLayer.mvt    Inline resource: source
├── css/
│   ├── core.json            Local resource: settings
│   └── core.css             Local resource: file contents
└── resourcegroups/
    └── head_tag.json

File names#

Files are named after the object’s file name or code. If a name has any character other than letters, numbers, -, _ and spaces, MMT names the file with the MD5 hash of the name instead, for example 5d41402abc4b2a76b9719d911017c592.json. .mmt/state.json maps the hashed name back to the object.

Templates#

Properties#

Properties are grouped by type: Theme Components, headers and footers, buttons, email templates and so on. Each type has a folder named after the type code Miva uses.

The type folders depend on which modules the store has installed. The ones that come with Miva:

The .json file is written only when the property has settings, and the .mvt only when it has a template. Email properties (templateorderemail), for example, are only .json: they hold the email’s settings, and page_code names the page in templates/ (such as email_abandoned_basket.mvt) that holds the email’s content.

Hidden settings#

Settings whose names start with . are hidden settings. Checkout leaves them out of template and property .json files unless you use --include-hidden-settings (-s).

Sync flags#

Checkout’s -t and -p options keep only templates or properties whose sync flag is on and leave the rest out of the checkout. The choice is saved with the checkout and used by later pulls.

JavaScript and CSS resources#

Each resource has a .json settings file. Inline and Local resources also have a content file:

External, Combined and Module resources have only the .json. Changing code or type in the .json has no effect; MMT doesn’t send them. mmt sri writes integrity and crossorigin into attributes.

Resource groups#

resourcegroups/<code>.json lists the group’s linked JavaScript and CSS resources.

The .mmt folder#

A file counts as modified when its contents no longer match the hash in state.json. Don’t edit these files by hand. If they’re lost or damaged, run mmt checkout --reinitialize <remote> . in the folder to rebuild them without overwriting your files.

Related#

• mmt checkout
• What MMT manages