1.0.4 • Published 4 years ago
shopify-data-clean v1.0.4
settings_data.json Cleanup Tool
Purpose
When settings_data.json
files are too large it can cause performance issues with the Theme Editor.
This tool allows for:
- Removing keys with an empty string as a value. e.g.
""
. - Removing keys that contain a particular string. This is useful for deleting settings that have been left behind by an application that has been uninstalled.
Installation
To install this as a global NPM package run:
npm i shopify-data-clean -g
Using the tool
Run the following command within your base theme directory:
shopify-data-clean clean key={string}
Parameter | Description |
---|---|
clean | Optional. Remove keys with an empty string as their value. If this results in any empty objects, they will also be deleted. |
key={string} | Optional. Replace {string} with a key or substring of a key that you would like to remove from the file. |
The tool assumes you have a config/settings_data.json
file present.
Output
The tool will output a file within the config
directory called settings_data_cleaned.json
.
This tool isn't officially supported by Shopify and is currently in Beta. We recommend backing up any important data before attempting to use this tool.