airbnb/babel-plugin-inline-react-svg

Need `includePattern` as option

Open

#62 opened on Jun 5, 2019

View on GitHub
 (11 comments) (0 reactions) (0 assignees)JavaScript (90 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (474 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

My issue is that we want to use this babel transform just for icons that we want to style - inline icons that should have the same color as surrounding text, etc.

On the other hand, we'd like to use webpack's url-loader to handle all larger "illustration" SVGs. We would rather put those in img tags and let them be cached by the browser and not have them in our javascript bundle.

To do so, an includePattern could be used that would only use this babel transform on (for example):

  • *.icon.svg
  • */icons/*.svg

Thoughts? I'm about to make a PR.

Contributor guide

Research direction
Familiarize yourself with the plugin's source code, specifically how options are currently handled. Add an 'includePattern' option that filters which SVGs to transform. Use a glob matching library like 'micromatch'. Update documentation accordingly.
Tech stack
javascriptreact
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70