-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #48 from RhoInc/settings-schema
Settings schema
- Loading branch information
Showing
13 changed files
with
614 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| var pkg = require('../package'), | ||
| schema = require('../settings-schema'), | ||
| properties = schema.properties, | ||
| markdown = [], | ||
| fs = require('fs'), | ||
| webchartsSettingsFlag = 0, | ||
| webchartsSettings = fs.readFileSync('./src/defaultSettings.js', 'utf8') | ||
| .split('\n') | ||
| .filter(line => { | ||
| if (line.indexOf('const webchartsSettings') > -1) | ||
| webchartsSettingsFlag = 1; | ||
|
|
||
| if (webchartsSettingsFlag === 1 && /};/.test(line)) | ||
| webchartsSettingsFlag = 0; | ||
|
|
||
| return webchartsSettingsFlag; | ||
| }); | ||
| webchartsSettings.splice(0,1,'{\r'); | ||
| webchartsSettings.push('}'); | ||
|
|
||
| schema.overview | ||
| .split('\n') | ||
| .forEach(paragraph => { | ||
| markdown.push(paragraph); | ||
| markdown.push(''); | ||
| }); | ||
| markdown.push(`# Renderer-specific settings`); | ||
| markdown.push(`The sections below describe each ${pkg.name} setting as of version ${schema.version}.`); | ||
| markdown.push(``); | ||
|
|
||
| //Build configuration markdown array. | ||
| var keys = Object.keys(properties); | ||
| keys.forEach((property,i) => { | ||
| var setting = properties[property]; | ||
| markdown.push(`## settings.${property}`); | ||
| markdown.push(`\`${setting.type}\``); | ||
| markdown.push(``); | ||
| markdown.push(`${setting.description}`); | ||
| if (setting.type !== 'object') | ||
| markdown.push(``); | ||
|
|
||
| //Primitive types | ||
| if (['object', 'array'].indexOf(setting.type) === -1) | ||
| markdown.push(`**default:** ${ | ||
| setting.default | ||
| ? ('`"' + setting.default + '"`') | ||
| : 'none'}`); | ||
| //Arrays | ||
| else if (setting.type === 'array') { | ||
| //of primitive types | ||
| if (setting.type === 'array' && ['object', 'array'].indexOf(setting.items.type) === -1) | ||
| markdown.push(`**default:** ${ | ||
| setting.defaultArray | ||
| ? `[${setting.defaultArray.map(item => `"${item}"`).join(', ')}]` | ||
| : 'none'}`); | ||
| //of objects | ||
| else if (setting.items.type === 'object') { | ||
|
|
||
| if (setting.default) { | ||
| markdown.push(`**default:**`); | ||
| markdown.push(`\`\`\``); | ||
| markdown.push(`${JSON.stringify(setting.default, null, 2)}`); | ||
| markdown.push(`\`\`\``); | ||
| markdown.push(``); | ||
| } else | ||
| markdown.push(`**default:** none`); | ||
|
|
||
| var subProperties = setting.items.properties; | ||
| Object.keys(subProperties).forEach(subProperty => { | ||
| var subSetting = subProperties[subProperty]; | ||
| markdown.push(``); | ||
| markdown.push(`### settings.${property}[].${subProperty}`); | ||
| markdown.push(`\`${subSetting.type}\``); | ||
| markdown.push(``); | ||
| markdown.push(`${subSetting.title}`); | ||
| }); | ||
| } | ||
| } | ||
| //Objects | ||
| else if (setting.type === 'object') { | ||
| var subKeys = Object.keys(setting.properties); | ||
| subKeys.forEach((subProperty,i) => { | ||
| var subSetting = setting.properties[subProperty]; | ||
| markdown.push(``); | ||
| markdown.push(`## settings.${property}.${subProperty}`); | ||
| markdown.push(`\`${subSetting.type}\``); | ||
| markdown.push(``); | ||
| markdown.push(`${subSetting.title}`); | ||
| markdown.push(``); | ||
| markdown.push(`**default:** ${ | ||
| subSetting.default | ||
| ? ('`"' + subSetting.default + '"`') | ||
| : 'none'}`); | ||
| }); | ||
| } | ||
|
|
||
| if (i < keys.length - 1) { | ||
| markdown.push(``); | ||
| markdown.push(``); | ||
| markdown.push(``); | ||
| } | ||
| }); | ||
|
|
||
| markdown.push(``); | ||
| markdown.push(`# Webcharts-specific settings`); | ||
| markdown.push(`The object below contains each Webcharts setting as of version ${schema.version}.`); | ||
| markdown.push(``); | ||
| markdown.push('```'); | ||
| markdown.push(webchartsSettings.join('')); | ||
| markdown.push('```'); | ||
|
|
||
| fs.writeFile( | ||
| './scripts/configuration.md', | ||
| markdown.join('\n'), | ||
| (err) => { | ||
| if (err) | ||
| console.log(err); | ||
| console.log('The configuration markdown file was built!'); | ||
| }); |
Oops, something went wrong.