@shopify/manifests

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.md) [![npm version](https://badge.fury.io/js/%40shopify%2Fmanifests.svg)](https://badge.fury.io/js/%40shopify%2Fmanifests.svg)

Usage no npm install needed!

<script type="module">
  import shopifyManifests from 'https://cdn.skypack.dev/@shopify/manifests';
</script>

README

@shopify/manifests

License: MIT npm version

Utilities for manipulating manifests generated by @shopify/webpack-asset-metadata-plugin, and @shopify/sewing-kit.

Installation

$ yarn add @shopify/manifests

Commands

consolidate command

Finds assets.json / sewing-kit-manifest.json files inside a build directory, and combines them into a single JSON file.

Options

--root (required)

Directory to scan for manifest files (e.g., public/bundles / build/client).

--destination (required)

Path of the combined manifest file (e.g., public/bundles/sewing-kit-manifest.json)

--manifestGlob

Glob pattern to search for within 'root'.

--removeLegacyData

If enabled, removes the assets array from consolidated manifests. This reduces unused bulk in @shopify/sewing-kit-koa deployments.

--zip

If enabled, gzips the consolidated output. A '.gz' extension will be automatically applied to destination.

Usage

For full details of each option and its defaults, use:

yarn run manifests consolidate --help

An example command:

yarn run manifests consolidate --root public/bundles --destination public/bundles/sewing-kit-manifest.json --removeLegacyData