Skip to content

Commit 9ea5da4

Browse files
authored
refactor(core): use exportName transform (#616)
BREAKING CHANGE: @svgr/core now exposes { transform } instead of default export.
1 parent 8a1b0aa commit 9ea5da4

File tree

8 files changed

+14
-16
lines changed

8 files changed

+14
-16
lines changed

packages/cli/src/util.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/* eslint-disable no-console */
22
import { promises as fs } from 'fs'
33
import { red } from 'chalk'
4-
import svgrConvert, { Config, State } from '@svgr/core'
4+
import { transform, Config, State } from '@svgr/core'
55
import svgo from '@svgr/plugin-svgo'
66
import jsx from '@svgr/plugin-jsx'
77
import prettier from '@svgr/plugin-prettier'
@@ -31,7 +31,7 @@ export const convert = (
3131
config: Config,
3232
state: Partial<State>,
3333
): string => {
34-
return svgrConvert.sync(code, config, {
34+
return transform.sync(code, config, {
3535
...state,
3636
caller: {
3737
name: '@svgr/cli',

packages/core/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ npm install @svgr/core
1313
## Usage
1414

1515
```js
16-
import svgr from '@svgr/core'
16+
import { transform } from '@svgr/core'
1717

1818
const svgCode = `
1919
<svg xmlns="http://www.w3.org/2000/svg"
@@ -23,7 +23,7 @@ const svgCode = `
2323
</svg>
2424
`
2525

26-
svgr(svgCode, { icon: true }, { componentName: 'MyComponent' }).then(
26+
transform(svgCode, { icon: true }, { componentName: 'MyComponent' }).then(
2727
(jsCode) => {
2828
console.log(jsCode)
2929
},

packages/core/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
export { default } from './convert'
1+
export { transform } from './transform'
22
export * from './config'
33
export type { State } from './state'
44
export type { Plugin, ConfigPlugin } from './plugins'

packages/core/src/convert.test.ts renamed to packages/core/src/transform.test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
import convert, { Config, State } from '.'
1+
import { transform, Config, State } from '.'
22

33
function convertWithAllPlugins(
44
code: string,
55
config?: Config,
66
state?: Partial<State>,
77
) {
8-
return convert(
8+
return transform(
99
code,
1010
{
1111
plugins: [
@@ -24,7 +24,7 @@ function convertSyncWithAllPlugins(
2424
config?: Config,
2525
state?: Partial<State>,
2626
) {
27-
return convert.sync(
27+
return transform.sync(
2828
code,
2929
{
3030
plugins: [

packages/core/src/convert.ts renamed to packages/core/src/transform.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const run = (code: string, config: Config, state: Partial<State>): string => {
1515
return nextCode
1616
}
1717

18-
const convert = async (
18+
export const transform = async (
1919
code: string,
2020
config: Config = {},
2121
state: Partial<State> = {},
@@ -24,13 +24,11 @@ const convert = async (
2424
return run(code, config, state)
2525
}
2626

27-
convert.sync = (
27+
transform.sync = (
2828
code: string,
2929
config: Config = {},
3030
state: Partial<State> = {},
3131
): string => {
3232
config = loadConfig.sync(config, state)
3333
return run(code, config, state)
3434
}
35-
36-
export default convert

packages/rollup/src/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import * as fs from 'fs'
2-
import convert, { Config } from '@svgr/core'
2+
import { transform, Config } from '@svgr/core'
33
import { createFilter, CreateFilter } from 'rollup-pluginutils'
44
import { transformAsync, createConfigItem } from '@babel/core'
55
import svgo from '@svgr/plugin-svgo'
@@ -58,7 +58,7 @@ const plugin: PluginImpl<Options> = (options = {}) => {
5858

5959
const previousExport = exportMatches ? data : null
6060

61-
const jsCode = await convert(load, options, {
61+
const jsCode = await transform(load, options, {
6262
filePath: id,
6363
caller: {
6464
name: '@svgr/rollup',

packages/webpack/src/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { callbackify } from 'util'
22
import { transformAsync, createConfigItem } from '@babel/core'
3-
import convert, { Config, State } from '@svgr/core'
3+
import { transform, Config, State } from '@svgr/core'
44
import { normalize } from 'path'
55
import svgo from '@svgr/plugin-svgo'
66
import jsx from '@svgr/plugin-jsx'
@@ -42,7 +42,7 @@ interface LoaderOptions extends Config {
4242
const tranformSvg = callbackify(
4343
async (contents: string, options: LoaderOptions, state: Partial<State>) => {
4444
const { babel = true, ...config } = options
45-
const jsCode = await convert(contents, config, state)
45+
const jsCode = await transform(contents, config, state)
4646
if (!babel) return jsCode
4747
const result = await transformAsync(
4848
jsCode,

0 commit comments

Comments
 (0)