Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standard SVG transform pipeline doesn't understand Typescript #8376

Closed
samjt opened this issue Aug 8, 2022 · 2 comments 路 Fixed by #8411
Closed

Standard SVG transform pipeline doesn't understand Typescript #8376

samjt opened this issue Aug 8, 2022 · 2 comments 路 Fixed by #8411

Comments

@samjt
Copy link
Contributor

samjt commented Aug 8, 2022

馃悰 bug report

The standard SVG transform pipeline using @parcel/transformer-svg-react doesn't understand Typescript emitted by SVGR and assumes it is pure JS.

馃帥 Configuration (.babelrc, package.json, cli command)

.parcelrc

{
    "extends": ["@parcel/config-default"],
    "resolvers": ["...", "@parcel/resolver-glob"],
    "transformers": {
        "*.svg": ["...", "@parcel/transformer-svg-react"]
    }
}

.svgrrc.yaml

# When generating icons from raw svgs, we need to expose the color value as a prop to make it modifiable in React
replaceAttrValues: { "#011e41": "{props.color}", "#adb9c3": "{props.color}" }
icon: true
dimensions: true
typescript: true

馃 Expected Behavior

When typescript: true is set in the svgrrc.yaml, the pipeline should process the output of @parcel/transformer-svg-react as TypeScript and output typed definitions of svgs

馃槸 Current Behavior

The pipeline throws an error on encountering a :, presumably the type definition of the SVG.

馃毃 Build failed.

@parcel/transformer-js: Expected ',', got ':'

馃拋 Possible Solution

Forcing Parcel to use a Typescript transform in the pipeline resolves the issue and generates proper types for the SVGs

{
    "extends": ["@parcel/config-default"],
    "resolvers": ["...", "@parcel/resolver-glob"],
    "transformers": {
        "*.svg": ["...", "@parcel/transformer-svg-react", "@parcel/transformer-typescript-tsc"]
    }
}

馃敠 Context

Generate an Icon library from SVG files that works with a Typescript development environment.

馃捇 Code Sample

馃實 Your Environment

Software Version(s)
Parcel 2.7.0
Node 16.13.1
npm/Yarn 3.2.2
Operating System macOS 12.4
@mischnic
Copy link
Member

mischnic commented Aug 8, 2022

I think the proper solution would be setting this to tsx instead if the typescript option is enabled, then it would use the pipeline that is used by all Typescript assets

This PR will add proper config loading, so the config could be checked with that: #7741

@samjt
Copy link
Contributor Author

samjt commented Aug 8, 2022

Sure, that makes more sense, I guess I should describe the solution more as a workaround for the time being.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants