Repository: Developmint/nuxt-svg-loader
Branch: master
Commit: 7e3a18d10091
Files: 23
Total size: 21.7 KB
Directory structure:
gitextract_eibwddy1/
├── .editorconfig
├── .eslintrc.js
├── .github/
│ └── FUNDING.yml
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── commitlint.config.js
├── lib/
│ └── module.js
├── package.json
├── renovate.json
└── test/
├── __snapshots__/
│ └── module.test.js.snap
├── fixture/
│ ├── configs/
│ │ ├── default.js
│ │ ├── error-without-image-loader-rule.js
│ │ ├── with-extend-fn.js
│ │ └── with-options.js
│ ├── modules/
│ │ ├── error.js
│ │ └── main.css
│ └── pages/
│ ├── background-image.vue
│ ├── index.vue
│ └── two.vue
└── module.test.js
================================================
FILE CONTENTS
================================================
================================================
FILE: .editorconfig
================================================
# editorconfig.org
root = true
[*]
indent_size = 2
indent_style = space
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.md]
trim_trailing_whitespace = false
================================================
FILE: .eslintrc.js
================================================
module.exports = {
root: true,
parserOptions: {
parser: 'babel-eslint',
sourceType: 'module'
},
extends: [
'@nuxtjs'
],
rules: {
'vue/attribute-hyphenation': ['error', 'always', {
ignore: ['viewBox']
}]
}
}
================================================
FILE: .github/FUNDING.yml
================================================
github: [manniL]
custom: ['https://www.lichter.io/support-me/']
================================================
FILE: .gitignore
================================================
node_modules
*.iml
.idea
*.log*
.nuxt
.vscode
.DS_STORE
coverage
dist
================================================
FILE: .travis.yml
================================================
language: node_js
node_js:
- "8"
- "9"
- "10"
cache:
yarn: true
directories:
- node_modules
install:
- yarn
script:
- yarn test
after_success:
- yarn coverage
================================================
FILE: CHANGELOG.md
================================================
# Change Log
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
# [1.2.0](https://github.com/Developmint/nuxt-svg-loader/compare/v1.0.1...v1.2.0) (2020-01-22)
### Bug Fixes
* revert df4be5 to fix regex ([465298a](https://github.com/Developmint/nuxt-svg-loader/commit/465298a))
* use image name function when using inline query ([c90a8ed](https://github.com/Developmint/nuxt-svg-loader/commit/c90a8ed))
### Features
* proper loading svg used as background url ([#50](https://github.com/Developmint/nuxt-svg-loader/issues/50)) ([9df6300](https://github.com/Developmint/nuxt-svg-loader/commit/9df6300))
# [1.1.0](https://github.com/Developmint/nuxt-svg-loader/compare/v1.0.1...v1.1.0) (2020-01-22)
### Bug Fixes
* use image name function when using inline query ([c90a8ed](https://github.com/Developmint/nuxt-svg-loader/commit/c90a8ed))
### Features
* proper loading svg used as background url ([#50](https://github.com/Developmint/nuxt-svg-loader/issues/50)) ([9df6300](https://github.com/Developmint/nuxt-svg-loader/commit/9df6300))
## [1.0.1](https://github.com/Developmint/nuxt-svg-loader/compare/v1.0.0...v1.0.1) (2019-01-11)
### Bug Fixes
* re-enable lazy-loading capabilities ([#28](https://github.com/Developmint/nuxt-svg-loader/issues/28)) ([e7928ab](https://github.com/Developmint/nuxt-svg-loader/commit/e7928ab))
# [1.0.0](https://github.com/Developmint/nuxt-svg-loader/compare/v0.1.0...v1.0.0) (2019-01-09)
### Bug Fixes
* check if options is a thing ([ec9999f](https://github.com/Developmint/nuxt-svg-loader/commit/ec9999f))
### Features
* replaced vue-svg-loader with svg-to-vue-component ([#19](https://github.com/Developmint/nuxt-svg-loader/issues/19)) ([6061109](https://github.com/Developmint/nuxt-svg-loader/commit/6061109))
* use default options from svg-to-vue and add svgo backwards compat ([84a84b7](https://github.com/Developmint/nuxt-svg-loader/commit/84a84b7))
# [0.1.0](https://github.com/Developmint/nuxt-svg-loader/compare/v0.0.1...v0.1.0) (2018-11-05)
### Features
* pass custom loader options if needed ([071edce](https://github.com/Developmint/nuxt-svg-loader/commit/071edce))
## 0.0.1 (2018-10-14)
================================================
FILE: LICENSE
================================================
MIT License
Copyright (c) Alexander Lichter
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
================================================
FILE: README.md
================================================
# Nuxt SVG Loader - SVGs as components, also on the server side!
[](https://npmjs.com/package/nuxt-svg-loader)
[](https://npmjs.com/package/nuxt-svg-loader)
[](https://travis-ci.com/Developmint/nuxt-svg-loader)
[](https://codecov.io/gh/Developmint/nuxt-svg-loader)
[](https://david-dm.org/Developmint/nuxt-svg-loader)
[](http://standardjs.com)
[](https://thanks.lichter.io/)
>
[📖 **Release Notes**](./CHANGELOG.md)
## Features
* Full support of SVGs as components. Import them like your Vue SFCs
* Use Vue bindings as you'd do it with normal components
* Built on top of [svg-to-vue-component](https://github.com/egoist/svg-to-vue-component)
* Nuxt 2 (and only Nuxt 2) support
* Fully tested!
## Demo
A live demo is available through the [CodeSandBox](https://codesandbox.io/s/github/Developmint/nuxt-svg-loader/tree/master) of the repo.
## Setup
- Add `nuxt-svg-loader` as a dependency using yarn or npm to your project
- Add `nuxt-svg-loader` to `modules` section of `nuxt.config.js`
```js
{
modules: [
'nuxt-svg-loader',
]
}
```
- Now you can use your svg files like regular Vue components
- You can use inline svg as well by adding `?inline` at the end of the file path
```
```
- No more options are needed. It'll simply work
## Configuration
The plugin will work seamlessly out of the box.
It will also include SVGO defaults to avoid collisions between your optimized SVG files!
If you want to configure the underlying loader (or SVGO), you can do that easily as well.
(All options available [here](https://github.com/egoist/svg-to-vue-component#loader-options))
```js
// file: nuxt.config.js
export default {
// ...
// Your loader options as svgLoader object
svgLoader: {
svgoConfig: {
plugins: [
{ prefixIds: false } // Disables prefixing for SVG IDs
]
}
}
}
```
## Migrating from 0.x
1. Update the deps (of course!)
2. Rename `svgo` to `svgoConfig`
3. If you used id prefixing manually before, you can delete the config:
```js
export default {
svgLoader: {
svgo: { //Rename to svgoConfig
plugins: [
{ prefixIds: true } // Delete that line (or the whole svgLoader object if you don't have any other configurations)
]
}
}
}
```
## How to fix Eslint auto lint error
If you turn on Eslint on save by server, you should exclude `.svg` files of `eslint-loader`.
Example:
```js
// nuxt.config.js
build: {
extend(config, ctx) {
// Run ESLint on save
if (ctx.isDev && ctx.isClient) {
config.module.rules.push({
enforce: 'pre',
test: /\.(js|vue)$/,
loader: 'eslint-loader',
exclude: /(node_modules)|(\.svg$)/ /* <--- here */
})
}
}
}
```
## Development
- Clone this repository
- Install dependencies using `yarn install` or `npm install`
- Start development server using `npm run dev`
## License
[MIT License](./LICENSE)
Copyright (c) Alexander Lichter
================================================
FILE: commitlint.config.js
================================================
module.exports = { extends: ['@commitlint/config-conventional'] }
================================================
FILE: lib/module.js
================================================
const logger = require('consola').withScope('nuxt-svg-loader')
export default function nuxtSvgLoader(moduleOptions) {
const options = Object.assign({}, this.options.svgLoader, moduleOptions)
if (options && options.svgo && !options.svgoConfig) {
options.svgoConfig = options.svgo
}
const fileName = this.nuxt.options.build.filenames.img(this.nuxt.options.dev)
this.extendBuild(setupVueSvgLoader(options, fileName))
}
const svgRulePredicate = rule => rule.test && rule.test.test('.svg')
const setupVueSvgLoader = (options, fileName) => (config) => {
// https://github.com/egoist/svg-to-vue-component#nuxtjs-2
const imageLoaderRule = config.module.rules.find(svgRulePredicate)
if (!imageLoaderRule) {
logger.error('Could not modify image loader rule!')
return
}
// Don't process .svg files in default image rule
// from https://github.com/nuxt/nuxt.js/blob/76b10d2d3f4e5352f1c9d14c52008f234e66d7d5/lib/builder/webpack/base.js#L203
imageLoaderRule.test = /\.(png|jpe?g|gif|webp)$/
// Add a new rule for .svg file
config.module.rules.push({
test: /\.svg$/,
oneOf: [
{
resourceQuery: /inline/,
use: {
loader: "file-loader",
options: {
esModule: false,
name: fileName
},
},
},
{
use: [
'vue-loader',
{
loader: 'svg-to-vue-component/loader',
options
}
]
}
]
})
}
module.exports.meta = require('../package.json')
================================================
FILE: package.json
================================================
{
"name": "nuxt-svg-loader",
"version": "1.2.0",
"description": "",
"license": "MIT",
"contributors": [
{
"name": "Alexander Lichter "
}
],
"main": "lib/module.js",
"repository": {
"type": "git",
"url": "git+https://github.com/Developmint/nuxt-svg-loader"
},
"bugs": {
"url": "https://github.com/Developmint/nuxt-svg-loader/issues"
},
"publishConfig": {
"access": "public"
},
"scripts": {
"dev": "nuxt --config-file test/fixture/configs/default.js",
"lint": "eslint lib test",
"test": "yarn run lint && jest --detectOpenHandles",
"release": "standard-version && git push --follow-tags && npm publish",
"commitlint": "commitlint -e $GIT_PARAMS",
"coverage": "codecov"
},
"eslintIgnore": [
"lib/templates/*.*"
],
"files": [
"lib"
],
"keywords": [
"nuxtjs",
"nuxt",
"nuxt-module",
"svg",
"loader",
"svg-loader"
],
"engines": {
"node": ">=8.0.0",
"npm": ">=5.0.0"
},
"jest": {
"testEnvironment": "node",
"collectCoverage": true,
"coveragePathIgnorePatterns": [
"/node_modules/",
"/test/fixture"
],
"forceExit": true
},
"dependencies": {
"consola": "^2.3.2",
"svg-to-vue-component": "^0.3.1"
},
"devDependencies": {
"@commitlint/cli": "^7.3.1",
"@commitlint/config-conventional": "^7.3.1",
"@nuxtjs/eslint-config": "^0.0.1",
"babel-eslint": "^10.0.1",
"codecov": "^3.1.0",
"eslint": "^5.12.0",
"eslint-config-standard": "^12.0.0",
"eslint-plugin-import": "^2.14.0",
"eslint-plugin-jest": "^22.1.3",
"eslint-plugin-node": "^8.0.1",
"eslint-plugin-promise": "^4.0.1",
"eslint-plugin-standard": "^4.0.0",
"eslint-plugin-vue": "^5.1.0",
"get-port": "^4.1.0",
"husky": "^1.3.1",
"jest": "^23.6.0",
"jsdom": "^13.1.0",
"nuxt-edge": "^2.4.0-25786640.3ebd6b70",
"standard-version": "^4.4.0"
},
"husky": {
"hooks": {
"pre-commit": "yarn run lint",
"commit-msg": "yarn run commitlint"
}
}
}
================================================
FILE: renovate.json
================================================
{
"extends": [
"@nuxtjs"
]
}
================================================
FILE: test/__snapshots__/module.test.js.snap
================================================
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`ssr correctly load SVG as background image 1`] = `
"