config.js 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
  1. 'use strict';
  2. var FS = require('fs');
  3. var PATH = require('path');
  4. var yaml = require('js-yaml');
  5. /**
  6. * Read and/or extend/replace default config file,
  7. * prepare and optimize plugins array.
  8. *
  9. * @param {Object} [config] input config
  10. * @return {Object} output config
  11. */
  12. module.exports = function(config) {
  13. var defaults;
  14. config = typeof config == 'object' && config || {};
  15. if (config.plugins && !Array.isArray(config.plugins)) {
  16. return { error: 'Error: Invalid plugins list. Provided \'plugins\' in config should be an array.' };
  17. }
  18. if (config.full) {
  19. defaults = config;
  20. if (Array.isArray(defaults.plugins)) {
  21. defaults.plugins = preparePluginsArray(config, defaults.plugins);
  22. }
  23. } else {
  24. defaults = Object.assign({}, yaml.safeLoad(FS.readFileSync(__dirname + '/../../.svgo.yml', 'utf8')));
  25. defaults.plugins = preparePluginsArray(config, defaults.plugins || []);
  26. defaults = extendConfig(defaults, config);
  27. }
  28. if ('floatPrecision' in config && Array.isArray(defaults.plugins)) {
  29. defaults.plugins.forEach(function(plugin) {
  30. if (plugin.params && ('floatPrecision' in plugin.params)) {
  31. // Don't touch default plugin params
  32. plugin.params = Object.assign({}, plugin.params, { floatPrecision: config.floatPrecision });
  33. }
  34. });
  35. }
  36. if ('datauri' in config) {
  37. defaults.datauri = config.datauri;
  38. }
  39. if (Array.isArray(defaults.plugins)) {
  40. defaults.plugins = optimizePluginsArray(defaults.plugins);
  41. }
  42. return defaults;
  43. };
  44. /**
  45. * Require() all plugins in array.
  46. *
  47. * @param {Object} config
  48. * @param {Array} plugins input plugins array
  49. * @return {Array} input plugins array of arrays
  50. */
  51. function preparePluginsArray(config, plugins) {
  52. var plugin,
  53. key;
  54. return plugins.map(function(item) {
  55. // {}
  56. if (typeof item === 'object') {
  57. key = Object.keys(item)[0];
  58. // custom
  59. if (typeof item[key] === 'object' && item[key].fn && typeof item[key].fn === 'function') {
  60. plugin = setupCustomPlugin(key, item[key]);
  61. } else {
  62. plugin = setPluginActiveState(
  63. loadPlugin(config, key, item[key].path),
  64. item,
  65. key
  66. );
  67. plugin.name = key;
  68. }
  69. // name
  70. } else {
  71. plugin = loadPlugin(config, item);
  72. plugin.name = item;
  73. if (typeof plugin.params === 'object') {
  74. plugin.params = Object.assign({}, plugin.params);
  75. }
  76. }
  77. return plugin;
  78. });
  79. }
  80. /**
  81. * Extend plugins with the custom config object.
  82. *
  83. * @param {Array} plugins input plugins
  84. * @param {Object} config config
  85. * @return {Array} output plugins
  86. */
  87. function extendConfig(defaults, config) {
  88. var key;
  89. // plugins
  90. if (config.plugins) {
  91. config.plugins.forEach(function(item) {
  92. // {}
  93. if (typeof item === 'object') {
  94. key = Object.keys(item)[0];
  95. if (item[key] == null) {
  96. console.error(`Error: '${key}' plugin is misconfigured! Have you padded its content in YML properly?\n`);
  97. }
  98. // custom
  99. if (typeof item[key] === 'object' && item[key].fn && typeof item[key].fn === 'function') {
  100. defaults.plugins.push(setupCustomPlugin(key, item[key]));
  101. // plugin defined via path
  102. } else if (typeof item[key] === 'object' && item[key].path) {
  103. defaults.plugins.push(setPluginActiveState(loadPlugin(config, undefined, item[key].path), item, key));
  104. } else {
  105. defaults.plugins.forEach(function(plugin) {
  106. if (plugin.name === key) {
  107. plugin = setPluginActiveState(plugin, item, key);
  108. }
  109. });
  110. }
  111. }
  112. });
  113. }
  114. defaults.multipass = config.multipass;
  115. // svg2js
  116. if (config.svg2js) {
  117. defaults.svg2js = config.svg2js;
  118. }
  119. // js2svg
  120. if (config.js2svg) {
  121. defaults.js2svg = config.js2svg;
  122. }
  123. return defaults;
  124. }
  125. /**
  126. * Setup and enable a custom plugin
  127. *
  128. * @param {String} plugin name
  129. * @param {Object} custom plugin
  130. * @return {Array} enabled plugin
  131. */
  132. function setupCustomPlugin(name, plugin) {
  133. plugin.active = true;
  134. plugin.params = Object.assign({}, plugin.params || {});
  135. plugin.name = name;
  136. return plugin;
  137. }
  138. /**
  139. * Try to group sequential elements of plugins array.
  140. *
  141. * @param {Object} plugins input plugins
  142. * @return {Array} output plugins
  143. */
  144. function optimizePluginsArray(plugins) {
  145. var prev;
  146. return plugins.reduce(function(plugins, item) {
  147. if (prev && item.type == prev[0].type) {
  148. prev.push(item);
  149. } else {
  150. plugins.push(prev = [item]);
  151. }
  152. return plugins;
  153. }, []);
  154. }
  155. /**
  156. * Sets plugin to active or inactive state.
  157. *
  158. * @param {Object} plugin
  159. * @param {Object} item
  160. * @param {Object} key
  161. * @return {Object} plugin
  162. */
  163. function setPluginActiveState(plugin, item, key) {
  164. // name: {}
  165. if (typeof item[key] === 'object') {
  166. plugin.params = Object.assign({}, plugin.params || {}, item[key]);
  167. plugin.active = true;
  168. // name: false
  169. } else if (item[key] === false) {
  170. plugin.active = false;
  171. // name: true
  172. } else if (item[key] === true) {
  173. plugin.active = true;
  174. }
  175. return plugin;
  176. }
  177. /**
  178. * Loads default plugin using name or custom plugin defined via path in config.
  179. *
  180. * @param {Object} config
  181. * @param {Object} name
  182. * @param {Object} path
  183. * @return {Object} plugin
  184. */
  185. function loadPlugin(config, name, path) {
  186. var plugin;
  187. if (!path) {
  188. plugin = require('../../plugins/' + name);
  189. } else {
  190. plugin = require(PATH.resolve(config.__DIR, path));
  191. }
  192. return Object.assign({}, plugin);
  193. }