init

.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  env: {
+    es6: true
+  },
+  parserOptions: {
+    sourceType: 'module',
+    ecmaVersion: '2017'
+  },
+  extends: ['standard', 'prettier'],
+  plugins: ['node'],
+  rules: {
+    'node/no-unsupported-features/es-syntax': 2
+  }
+}

.gitignore

@@ -0,0 +1,188 @@
+dist
+test.js
+
+# Created by https://www.gitignore.io/api/git,osx,node,code,linux,windows
+# Edit at https://www.gitignore.io/?templates=git,osx,node,code,linux,windows
+
+### Code ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+### Git ###
+# Created by git for backups. To disable backups in Git:
+# $ git config --global mergetool.keepBackup false
+*.orig
+
+# Created by git when using merge tools for conflicts
+*.BACKUP.*
+*.BASE.*
+*.LOCAL.*
+*.REMOTE.*
+*_BACKUP_*.txt
+*_BASE_*.txt
+*_LOCAL_*.txt
+*_REMOTE_*.txt
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+### OSX ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.gitignore.io/api/git,osx,node,code,linux,windows

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "arrowParens": "always"
+}

README.md

@@ -0,0 +1,102 @@
+# gatsby-transformer-inline-svg
+
+[![npm](https://img.shields.io/npm/v/gatsby-transformer-inline-svg.svg?label=npm@latest)](https://www.npmjs.com/package/gatsby-transformer-inline-svg)
+[![npm](https://img.shields.io/npm/v/gatsby-transformer-inline-svg/canary.svg)](https://www.npmjs.com/package/gatsby-transformer-inline-svg)
+[![npm](https://img.shields.io/npm/dm/gatsby-transformer-inline-svg.svg)](https://www.npmjs.com/package/gatsby-transformer-inline-svg)
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/fc81fa5e535561c0a6ff/maintainability)](https://codeclimate.com/github/axe312ger/gatsby-transformer-inline-svg/maintainability)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+
+Read and optimize graqhQL SVG file nodes to render them inline in your website.
+
+If you want to render static SVG files, use https://www.gatsbyjs.org/packages/gatsby-plugin-react-svg/. This plugin is for everybody having a not-fixed set of svgs, eventually from an external data source like Contentful.
+
+
+## Todo
+
+This is still in development, missing features:
+
+* support `gatsby-source-filesystem` nodes
+* clean up code
+* actually cache to disk, not to gatsby cache only
+
+## Features
+
+* Read content of your SVG file nodes and stores it as `svgContent` field.
+* Optimizes output via [SVGO](https://github.com/svg/svgo)
+* Contentful only: Download svg and cache it to `node_modules/.cache/gatsby-transformer-inline-svg`
+
+## Installation
+
+```sh
+npm i gatsby-transformer-inline-svg@alpha
+```
+
+## Usage
+
+Pass your server connection credentials, the remote cache directory and the directories you want to cache to the plugin options in your `gatsby-config.js`:
+
+**gatsby-config.js**:
+
+```js
+module.exports = {
+  plugins: [
+    `gatsby-transformer-inline-svg`
+  ]
+}
+```
+
+
+**GraphQL Query**:
+```graphql
+... on ContentfulAsset {
+  svgContent
+  file {
+    contentType
+    url
+    fileName
+    contentType
+    details {
+      image {
+        width
+        height
+      }
+    }
+  }
+  fluid (...) {
+    ...
+  }
+}
+```
+
+
+
+**Rendering**:
+```jsx
+import React from 'react'
+import propTypes from 'prop-types'
+import Img from 'gatsby-image'
+
+// Render inline SVG with fallback non-svg images
+export default function Image({ svgContent, fluid, file, alt }) {
+  if (file.contentType === 'image/svg+xml') {
+    if (svgContent) {
+      // Inlined SVGs
+      return <div dangerouslySetInnerHTML={{ __html: svgContent }} />
+    }
+
+    // SVGs that can/should not be inlined
+    return <img src={file.url} alt={alt} />
+  }
+
+  // Non SVG images
+  return <Img fluid={fluid} alt={alt} />
+}
+
+Image.propTypes = {
+  svgContent: propTypes.string,
+  fluid: propTypes.object,
+  file: propTypes.object.isRequired,
+  alt: propTypes.string.isRequired,
+}
+```