sketch-module-settings v0.0.4

Sketch Module Settings

A sketch module to manage plugin settings. Based off Mathieu Dutour's User Preferences Module.

Installation

npm

npm --save-dev sketch-module-settings

yarn

yarn add --dev sketch-module-settings

Usage

Getting Globals and Locals

import settingsManager from 'sketch-module-user-settings'

// Combined Global and Local Settings
const globalDefaults = { /* some_global_settings */ }
const localDefaults = { /* some_local_settings */ }
const settings = settingsManager.getSettings(context, globalDefaults, 'pathToLocalsSettingFile', localDefaults)

// Globals Only
const defaults = { /* some_global_settings */ }
const settings = settingsManager.getGlobalSettings(context, defaults)

// Locals Only
const settings = settingsManager.getLocalSettings(context, 'pathToLocalsSettingFile')

Setting Globals and Locals

import settingsManager from 'sketch-module-user-settings'

// Combined Local and Global Settings
const localDefaults = { /* some_local_settings */ }
const newSettings = { /* some_new_settings */ }
settingsManager.setSettings(context, newSettings, 'pathToLocalsSettingFile', localDefaults)

// Globals Only
const newSettings = { /* some_new_settings */ }
settingsManager.setGlobalSettings(context, newSettings)

// Locals Only
const newSettings = { /* some_new_settings */ }
settingsManager.setLocalSettings(context, 'pathToLocalsSettingFile', newSettings)