generated from Seekra/repository-template
Allow only sections as first-level settings #117
@@ -53,10 +53,6 @@ limitations under the License.
|
|||||||
* @typedef {BoolSettingConfig | NumberSettingConfig | StringSettingConfig | SelectionSettingConfig | SectionSettingConfig} SettingConfigEntry
|
* @typedef {BoolSettingConfig | NumberSettingConfig | StringSettingConfig | SelectionSettingConfig | SectionSettingConfig} SettingConfigEntry
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
|
||||||
* @typedef {Object} SettingsConfig
|
|
||||||
* @property {SettingConfigEntry[]} contents
|
|
||||||
*/
|
|
||||||
/**
|
/**
|
||||||
* @typedef {{ type: 'bool', name: string, i18n: string, description?: string, default: boolean }} BoolSettingConfig
|
* @typedef {{ type: 'bool', name: string, i18n: string, description?: string, default: boolean }} BoolSettingConfig
|
||||||
* @typedef {{ type: 'number', name: string, i18n: string, description?: string, default: number }} NumberSettingConfig
|
* @typedef {{ type: 'number', name: string, i18n: string, description?: string, default: number }} NumberSettingConfig
|
||||||
@@ -64,5 +60,6 @@ limitations under the License.
|
|||||||
* @typedef {{ type: 'selection', name: string, i18n: string, description?: string, default: string | string[], allowMultiple?: boolean, options: SelectionOption[] }} SelectionSettingConfig
|
* @typedef {{ type: 'selection', name: string, i18n: string, description?: string, default: string | string[], allowMultiple?: boolean, options: SelectionOption[] }} SelectionSettingConfig
|
||||||
* @typedef {{ type: 'section', name: string, i18n?: string, description?: string, content: SettingConfigEntry[] }} SectionSettingConfig
|
* @typedef {{ type: 'section', name: string, i18n?: string, description?: string, content: SettingConfigEntry[] }} SectionSettingConfig
|
||||||
* @typedef {BoolSettingConfig | NumberSettingConfig | StringSettingConfig | SelectionSettingConfig | SectionSettingConfig} SettingConfigEntry
|
* @typedef {BoolSettingConfig | NumberSettingConfig | StringSettingConfig | SelectionSettingConfig | SectionSettingConfig} SettingConfigEntry
|
||||||
* @typedef {{ contents: SettingConfigEntry[] }} SettingsConfig
|
* @typedef {{ contents: SettingConfigEntry[] }} FirstLevelSettingConfigEntry
|
||||||
|
* @typedef {{ contents: FirstLevelSettingConfigEntry[] }} SettingsConfig
|
||||||
*/
|
*/
|
||||||
@@ -33,7 +33,6 @@ describe('validateSettingsConfig', () => {
|
|||||||
{ raw: {
|
{ raw: {
|
||||||
contents: [
|
contents: [
|
||||||
{
|
{
|
||||||
type: 'section',
|
|
||||||
name: 'general',
|
name: 'general',
|
||||||
i18n: 'settings.settings.general',
|
i18n: 'settings.settings.general',
|
||||||
content: [
|
content: [
|
||||||
@@ -49,7 +48,6 @@ describe('validateSettingsConfig', () => {
|
|||||||
{ raw: {
|
{ raw: {
|
||||||
contents: [
|
contents: [
|
||||||
{
|
{
|
||||||
type: 'section',
|
|
||||||
name: 'general',
|
name: 'general',
|
||||||
i18n: 'settings.settings.general',
|
i18n: 'settings.settings.general',
|
||||||
content: [
|
content: [
|
||||||
@@ -61,7 +59,6 @@ describe('validateSettingsConfig', () => {
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: 'section',
|
|
||||||
name: 'copyOfGeneral',
|
name: 'copyOfGeneral',
|
||||||
i18n: 'settings.settings.copyOfGeneral',
|
i18n: 'settings.settings.copyOfGeneral',
|
||||||
content: [
|
content: [
|
||||||
@@ -77,7 +74,6 @@ describe('validateSettingsConfig', () => {
|
|||||||
{ raw: {
|
{ raw: {
|
||||||
contents: [
|
contents: [
|
||||||
{
|
{
|
||||||
type: 'section',
|
|
||||||
name: 'general',
|
name: 'general',
|
||||||
i18n: 'settings.settings.general',
|
i18n: 'settings.settings.general',
|
||||||
content: [
|
content: [
|
||||||
@@ -89,7 +85,6 @@ describe('validateSettingsConfig', () => {
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: 'section',
|
|
||||||
name: 'copyOfGeneral',
|
name: 'copyOfGeneral',
|
||||||
i18n: 'settings.settings.copyOfGeneral',
|
i18n: 'settings.settings.copyOfGeneral',
|
||||||
content: [
|
content: [
|
||||||
@@ -102,7 +97,6 @@ describe('validateSettingsConfig', () => {
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: 'section',
|
|
||||||
name: 'aSection',
|
name: 'aSection',
|
||||||
i18n: 'settings.settings.aSection',
|
i18n: 'settings.settings.aSection',
|
||||||
content: [
|
content: [
|
||||||
@@ -141,7 +135,6 @@ describe('validateSettingsConfig', () => {
|
|||||||
{ raw: {
|
{ raw: {
|
||||||
contents: [
|
contents: [
|
||||||
{
|
{
|
||||||
type: 'section',
|
|
||||||
name: 'general',
|
name: 'general',
|
||||||
i18n: 'settings.settings.general',
|
i18n: 'settings.settings.general',
|
||||||
content: [
|
content: [
|
||||||
@@ -153,7 +146,6 @@ describe('validateSettingsConfig', () => {
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: 'section',
|
|
||||||
name: 'copyOfGeneral',
|
name: 'copyOfGeneral',
|
||||||
i18n: 'settings.settings.copyOfGeneral',
|
i18n: 'settings.settings.copyOfGeneral',
|
||||||
content: [
|
content: [
|
||||||
@@ -166,7 +158,6 @@ describe('validateSettingsConfig', () => {
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: 'section',
|
|
||||||
name: 'aSection',
|
name: 'aSection',
|
||||||
i18n: 'settings.settings.aSection',
|
i18n: 'settings.settings.aSection',
|
||||||
content: [
|
content: [
|
||||||
@@ -203,6 +194,74 @@ describe('validateSettingsConfig', () => {
|
|||||||
},
|
},
|
||||||
]
|
]
|
||||||
}, expected: true },
|
}, expected: true },
|
||||||
|
{ raw: {
|
||||||
|
contents: [
|
||||||
|
{
|
||||||
|
type: 'bool',
|
||||||
|
name: 'aStandaloneBooleanSetting',
|
||||||
|
i18n: 'settings.settings.aStandaloneBooleanSetting',
|
||||||
|
default: true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'general',
|
||||||
|
i18n: 'settings.settings.general',
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'bool',
|
||||||
|
name: 'Enable feature 42',
|
||||||
|
i18n: 'settings.settings.general.enableFeature42'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'copyOfGeneral',
|
||||||
|
i18n: 'settings.settings.copyOfGeneral',
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'bool',
|
||||||
|
name: 'Enable feature 42',
|
||||||
|
default: false,
|
||||||
|
i18n: 'settings.settings.general.enableFeature42'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'aSection',
|
||||||
|
i18n: 'settings.settings.aSection',
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'bool',
|
||||||
|
name: 'Enable feature 43',
|
||||||
|
i18n: 'settings.settings.aSection.enableFeature43'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'selection',
|
||||||
|
name: 'language',
|
||||||
|
i18n: 'settings.settings.aSection.language.label',
|
||||||
|
default: 'en',
|
||||||
|
allowMultiple: false,
|
||||||
|
options: [
|
||||||
|
{ name: 'en', i18n: 'settings.settings.aSection.language.options.en' },
|
||||||
|
{ name: 'de', i18n: 'settings.settings.aSection.language.options.de' },
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'section',
|
||||||
|
name: 'section2',
|
||||||
|
i18n: 'settings.settings.aSection.section2.label',
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'string',
|
||||||
|
name: 'string',
|
||||||
|
i18n: 'settings.settings.aSection.sections.string',
|
||||||
|
default: 'str'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
]
|
||||||
|
},
|
||||||
|
]
|
||||||
|
}, expected: false },
|
||||||
{ raw: {
|
{ raw: {
|
||||||
contents: [
|
contents: [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -83,6 +83,19 @@ export const validateEntry = function validateEntry (entry, path) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export const validateFirstLevelSection = function validateFirstLevelSection (section, path) {
|
||||||
|
assertString(section.name);
|
||||||
|
assertString(section.i18n);
|
||||||
|
|
||||||
|
if (!Array.isArray(section.content)) {
|
||||||
|
throw new Error(`[settings] "${path}.content" must be an array`);
|
||||||
|
};
|
||||||
|
|
||||||
|
section.content.forEach((entry, i) =>
|
||||||
|
validateEntry(entry, `${path}.content[${i}]`)
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Validates a raw settings config object.
|
* Validates a raw settings config object.
|
||||||
* @param {unknown} raw
|
* @param {unknown} raw
|
||||||
@@ -97,7 +110,7 @@ export function validateSettingsConfig(raw) {
|
|||||||
throw new Error('[settings] "contents" must be an array');
|
throw new Error('[settings] "contents" must be an array');
|
||||||
}
|
}
|
||||||
raw.contents.forEach((entry, i) =>
|
raw.contents.forEach((entry, i) =>
|
||||||
validateEntry(entry, `contents[${i}]`)
|
validateFirstLevelSection(entry, `contents[${i}]`)
|
||||||
);
|
);
|
||||||
return { valid: true, config: raw };
|
return { valid: true, config: raw };
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
|
|||||||
Reference in New Issue
Block a user