feat: add synchronous API

You can now use `svgr.sync` to call svgr synchronously! Closes #185
gregberge · Sep 30, 2018 · 169eb2f · 169eb2f
1 parent bb95828
commit 169eb2f
Show file tree

Hide file tree

Showing 12 changed files with 425 additions and 199 deletions.
diff --git a/README.md b/README.md
@@ -199,7 +199,7 @@ You can find all default templates in [templates folder](https://github.com/smoo
 
 ## Node API usage
 
-SVGR can also be used programmatically:
+### `svgr(code, config, state)`
 
 ```js
 import svgr from '@svgr/core'
@@ -218,6 +218,8 @@ svgr(svgCode, { icon: true }, { componentName: 'MyComponent' }).then(jsCode => {
 })
 ```
 
+Use `svgr.sync(code, config, state)` if you would like to use sync version.
+
 ## [Webpack loader](https://github.com/smooth-code/svgr/blob/master/packages/webpack)
 
 ## [Rollup plugin](https://github.com/smooth-code/svgr/blob/master/packages/rollup)

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -28,6 +28,8 @@ svgr(svgCode, { icon: true }, { componentName: 'MyComponent' }).then(jsCode => {
 })
 ```
 
+Use `svgr.sync(code, config, state)` if you would like to use sync version.
+
 ## License
 
 MIT

diff --git a/packages/core/src/__snapshots__/config.test.js.snap b/packages/core/src/__snapshots__/config.test.js.snap
@@ -0,0 +1,199 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`svgo async #loadConfig [async] should load config using filePath 1`] = `
+Object {
+  "dimensions": true,
+  "expandProps": "end",
+  "h2xConfig": null,
+  "icon": true,
+  "native": false,
+  "noSemi": true,
+  "prettier": true,
+  "prettierConfig": null,
+  "ref": false,
+  "replaceAttrValues": Array [
+    Array [
+      "#063855",
+      "currentColor",
+    ],
+  ],
+  "runtimeConfig": true,
+  "svgProps": null,
+  "svgo": true,
+  "svgoConfig": null,
+  "template": null,
+  "titleProp": false,
+}
+`;
+
+exports[`svgo async #loadConfig [async] should not load config with "runtimeConfig: false 1`] = `
+Object {
+  "dimensions": true,
+  "expandProps": "end",
+  "h2xConfig": null,
+  "icon": true,
+  "native": false,
+  "noSemi": true,
+  "prettier": true,
+  "prettierConfig": null,
+  "ref": false,
+  "replaceAttrValues": Array [
+    Array [
+      "#063855",
+      "currentColor",
+    ],
+  ],
+  "runtimeConfig": true,
+  "svgProps": null,
+  "svgo": true,
+  "svgoConfig": null,
+  "template": null,
+  "titleProp": false,
+  "useRuntimeConfig": false,
+}
+`;
+
+exports[`svgo async #loadConfig [async] should use default config without state.filePath 1`] = `
+Object {
+  "dimensions": false,
+  "expandProps": "end",
+  "h2xConfig": null,
+  "icon": false,
+  "native": false,
+  "prettier": true,
+  "prettierConfig": null,
+  "ref": false,
+  "replaceAttrValues": null,
+  "runtimeConfig": true,
+  "svgProps": null,
+  "svgo": true,
+  "svgoConfig": null,
+  "template": null,
+  "titleProp": false,
+}
+`;
+
+exports[`svgo async #loadConfig [async] should work with custom config path 1`] = `
+Object {
+  "dimensions": true,
+  "expandProps": "end",
+  "h2xConfig": null,
+  "icon": true,
+  "native": false,
+  "noSemi": true,
+  "prettier": true,
+  "prettierConfig": null,
+  "ref": false,
+  "replaceAttrValues": Array [
+    Array [
+      "#063855",
+      "currentColor",
+    ],
+  ],
+  "runtimeConfig": true,
+  "svgProps": null,
+  "svgo": true,
+  "svgoConfig": null,
+  "template": null,
+  "titleProp": false,
+}
+`;
+
+exports[`svgo sync #loadConfig [sync] should load config using filePath 1`] = `
+Object {
+  "dimensions": true,
+  "expandProps": "end",
+  "h2xConfig": null,
+  "icon": true,
+  "native": false,
+  "noSemi": true,
+  "prettier": true,
+  "prettierConfig": null,
+  "ref": false,
+  "replaceAttrValues": Array [
+    Array [
+      "#063855",
+      "currentColor",
+    ],
+  ],
+  "runtimeConfig": true,
+  "svgProps": null,
+  "svgo": true,
+  "svgoConfig": null,
+  "template": null,
+  "titleProp": false,
+}
+`;
+
+exports[`svgo sync #loadConfig [sync] should not load config with "runtimeConfig: false 1`] = `
+Object {
+  "dimensions": true,
+  "expandProps": "end",
+  "h2xConfig": null,
+  "icon": true,
+  "native": false,
+  "noSemi": true,
+  "prettier": true,
+  "prettierConfig": null,
+  "ref": false,
+  "replaceAttrValues": Array [
+    Array [
+      "#063855",
+      "currentColor",
+    ],
+  ],
+  "runtimeConfig": true,
+  "svgProps": null,
+  "svgo": true,
+  "svgoConfig": null,
+  "template": null,
+  "titleProp": false,
+  "useRuntimeConfig": false,
+}
+`;
+
+exports[`svgo sync #loadConfig [sync] should use default config without state.filePath 1`] = `
+Object {
+  "dimensions": false,
+  "expandProps": "end",
+  "h2xConfig": null,
+  "icon": false,
+  "native": false,
+  "prettier": true,
+  "prettierConfig": null,
+  "ref": false,
+  "replaceAttrValues": null,
+  "runtimeConfig": true,
+  "svgProps": null,
+  "svgo": true,
+  "svgoConfig": null,
+  "template": null,
+  "titleProp": false,
+}
+`;
+
+exports[`svgo sync #loadConfig [sync] should work with custom config path 1`] = `
+Object {
+  "dimensions": true,
+  "expandProps": "end",
+  "h2xConfig": null,
+  "icon": true,
+  "native": false,
+  "noSemi": true,
+  "prettier": true,
+  "prettierConfig": null,
+  "ref": false,
+  "replaceAttrValues": Array [
+    Array [
+      "#063855",
+      "currentColor",
+    ],
+  ],
+  "runtimeConfig": true,
+  "svgProps": null,
+  "svgo": true,
+  "svgoConfig": null,
+  "template": null,
+  "titleProp": false,
+}
+`;
diff --git a/packages/core/src/config.js b/packages/core/src/config.js
@@ -33,15 +33,37 @@ export async function resolveConfig(searchFrom, configFile) {
   return result ? result.config : null
 }
 
+resolveConfig.sync = (searchFrom, configFile) => {
+  if (configFile == null) {
+    const result = explorer.searchSync(searchFrom)
+    return result ? result.config : null
+  }
+  const result = explorer.loadSync(configFile)
+  return result ? result.config : null
+}
+
 export async function resolveConfigFile(filePath) {
   const result = await explorer.search(filePath)
   return result ? result.filepath : null
 }
 
+resolveConfigFile.sync = filePath => {
+  const result = explorer.searchSync(filePath)
+  return result ? result.filepath : null
+}
+
 export async function loadConfig({ configFile, ...baseConfig }, state = {}) {
   const rcConfig =
     state.filePath && baseConfig.runtimeConfig !== false
       ? await resolveConfig(state.filePath, configFile)
       : {}
   return { ...DEFAULT_CONFIG, ...rcConfig, ...baseConfig }
 }
+
+loadConfig.sync = ({ configFile, ...baseConfig }, state = {}) => {
+  const rcConfig =
+    state.filePath && baseConfig.runtimeConfig !== false
+      ? resolveConfig.sync(state.filePath, configFile)
+      : {}
+  return { ...DEFAULT_CONFIG, ...rcConfig, ...baseConfig }
+}
-Original file line number
+Diff line change
@@ Expand Up @@
     })
     ```
+    Use `svgr.sync(code, config, state)` if you would like to use sync version.
     ## License
     MIT
@@ Expand Down @@