web-extensions-settings-manager

Settings manager

Хранение и управление параметрами необходимыми для работы плагина

Системные требования

• Node.JS версии 14 и выше
• yarn первой версии, последний стабильный релиз

Как использовать

const settings = new SettingsManager({
  defaultSettingKey: 'default-setting-value',
})

Миграции

Вы можете изменять или удалять значенения их локального хранилища плагина.

Миграция на изменение данных:

const settings = new SettingsManager(
    {
        defaultSettingKey: 'default-setting-value',
    },
    [
        (currentOptions, _defaults) => {
            // Проверять наличие поле обязательно, в противном случае инициализация настроек упадет
            if (currentOptions.defaultSettingKey) {
                currentOptions.defaultSettingKey = 'new-value';
            }
        },
    ],
);

Миграция на удаление данных:

const settings = new SettingsManager(
    {
        defaultSettingKey: 'default-setting-value',
        thisKeyMustBeDetete: 'oops',
    },
    [
        (currentOptions, _defaults) => {
            // Проверять наличие поле обязательно, в противном случае инициализация настроек упадет
            if (currentOptions.thisKeyMustBeDetete) {
                delete currentOptions.thisKeyMustBeDetete;
            }
        },
    ],
);

Документация

1. Перейдите в папку /docs
2. Откройте index.html

Разработка

Для связи пакета с проектом можно использовать стандартный инструмент yarn link или пакет yalc.

Документация yalc: https://github.com/wclr/yalc#usage

1. yarn build Сборка production билда

---

2. yarn watch Отсдеживание изменений кода и их сборка

---

3. yarn lint Запуск eslint

---

4. yarn prettier Запуск prettier

---

5. yarn test Запуск unit тестов

Релиз

1. yarn publish Сборка и публикация пакета

Если релиз происходит локально то перед командой yarn publish выполняется команда prepublishOnly. Важно! Если используется yarn версии 2 и выше то prepublishOnly работать не будет.

Credits

A big thanks to:

• webext-options-sync - For the migrations idea