config.js 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. 'use strict';
  2. var FS = require('fs');
  3. var yaml = require('js-yaml');
  4. var EXTEND = require('whet.extend');
  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(defaults.plugins);
  22. }
  23. } else {
  24. defaults = EXTEND({}, yaml.safeLoad(FS.readFileSync(__dirname + '/../../.svgo.yml', 'utf8')));
  25. defaults.plugins = preparePluginsArray(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 = EXTEND({}, plugin.params, { floatPrecision: config.floatPrecision });
  33. }
  34. });
  35. }
  36. if (Array.isArray(defaults.plugins)) {
  37. defaults.plugins = optimizePluginsArray(defaults.plugins);
  38. }
  39. return defaults;
  40. };
  41. /**
  42. * Require() all plugins in array.
  43. *
  44. * @param {Array} plugins input plugins array
  45. * @return {Array} input plugins array of arrays
  46. */
  47. function preparePluginsArray(plugins) {
  48. var plugin,
  49. key;
  50. return plugins.map(function(item) {
  51. // {}
  52. if (typeof item === 'object') {
  53. key = Object.keys(item)[0];
  54. // custom
  55. if (typeof item[key] === 'object' && item[key].fn && typeof item[key].fn === 'function') {
  56. plugin = setupCustomPlugin(key, item[key]);
  57. } else {
  58. plugin = EXTEND({}, require('../../plugins/' + key));
  59. // name: {}
  60. if (typeof item[key] === 'object') {
  61. plugin.params = EXTEND({}, plugin.params || {}, item[key]);
  62. plugin.active = true;
  63. // name: false
  64. } else if (item[key] === false) {
  65. plugin.active = false;
  66. // name: true
  67. } else if (item[key] === true) {
  68. plugin.active = true;
  69. }
  70. plugin.name = key;
  71. }
  72. // name
  73. } else {
  74. plugin = EXTEND({}, require('../../plugins/' + item));
  75. plugin.name = item;
  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. // custom
  96. if (typeof item[key] === 'object' && item[key].fn && typeof item[key].fn === 'function') {
  97. defaults.plugins.push(setupCustomPlugin(key, item[key]));
  98. } else {
  99. defaults.plugins.forEach(function(plugin) {
  100. if (plugin.name === key) {
  101. // name: {}
  102. if (typeof item[key] === 'object') {
  103. plugin.params = EXTEND({}, plugin.params || {}, item[key]);
  104. plugin.active = true;
  105. // name: false
  106. } else if (item[key] === false) {
  107. plugin.active = false;
  108. // name: true
  109. } else if (item[key] === true) {
  110. plugin.active = true;
  111. }
  112. }
  113. });
  114. }
  115. }
  116. });
  117. }
  118. defaults.multipass = config.multipass;
  119. // svg2js
  120. if (config.svg2js) {
  121. defaults.svg2js = config.svg2js;
  122. }
  123. // js2svg
  124. if (config.js2svg) {
  125. defaults.js2svg = config.js2svg;
  126. }
  127. return defaults;
  128. }
  129. /**
  130. * Setup and enable a custom plugin
  131. *
  132. * @param {String} plugin name
  133. * @param {Object} custom plugin
  134. * @return {Array} enabled plugin
  135. */
  136. function setupCustomPlugin(name, plugin) {
  137. plugin.active = true;
  138. plugin.params = EXTEND({}, plugin.params || {});
  139. plugin.name = name;
  140. return plugin;
  141. }
  142. /**
  143. * Try to group sequential elements of plugins array.
  144. *
  145. * @param {Object} plugins input plugins
  146. * @return {Array} output plugins
  147. */
  148. function optimizePluginsArray(plugins) {
  149. var prev;
  150. return plugins.reduce(function(plugins, item) {
  151. if (prev && item.type == prev[0].type) {
  152. prev.push(item);
  153. } else {
  154. plugins.push(prev = [item]);
  155. }
  156. return plugins;
  157. }, []);
  158. }