@originjs/vite-plugin-content
v1.0.5
Published
A vite plugin that convert xml, yaml, xlsx, csv, toml, ini, properties, plist files to ES6 modules
Downloads
12,940
Keywords
Readme
vite-plugin-content
Convert yaml
, xml
, xlsx
, ini
, toml
, csv
, plist
and properties
files to ES6 modules.
Features
- The files are read using
UTF-8
encoding. yaml
files transformed byjs-yaml
.xml
files transformed byxml2js
.ini
files transformed byini
.toml
files transformed by@iarna/toml
.csv
files transformed bycsv-parse
.plist
files transformed byplist
.properties
files transformed byplist
.- 'xlsx' files transformed by
sheetjs
Install
npm install @originjs/vite-plugin-content --save-dev
or
yarn add @originjs/vite-plugin-content --dev
Usage
First, add @originjs/vite-plugin-content
in vite.config.js
.
// vite.config.js
import content from '@originjs/vite-plugin-content'
export default {
plugins: [
content(
/* options */
)
]
}
Then you can import yaml
, xml
, xlsx
, ini
, toml
, csv
, plist
and properties
as ES module files
import yaml from 'assets/test.yaml'
import xml from 'assets/test.xml'
import xlsx from 'assets/test.xlsx'
import ini from 'assets/test.ini'
import toml from 'assets/test.toml'
import csv from 'assets/test.csv'
import plist from 'assets/test.plist'
import properties from 'assets/test.properties'
console.log(yaml)
console.log(xml)
console.log(xlsx)
console.log(ini)
console.log(toml)
console.log(csv)
console.log(plist)
console.log(properties)
Options
[yaml/xml/xlsx/ini/toml/csv/plist/properties].enabled
- Type:
boolean
- Default:
true
Whether or not to enable
yaml/xml/xlsx/ini/toml/csv/plist/properties
transformation.- Type:
[yaml/xml/xlsx/ini/toml/csv/plist/properties].include
- Type:
String
|Array[...String]
- Default:
null
A minimatch pattern, or array of patterns, which specifies the files in the build the plugin should operate on. All files are targeted y default.
- Type:
[yaml/xml/xlsx/ini/toml/csv/plist/properties].exclude
- Type:
String
|Array[...String]
- Default:
null
A minimatch pattern, or array of patterns, which specifies the files in the build the plugin should ignore. No files are ignored by default.
- Type:
yaml.loadMultiDocument
- Type:
boolean
- Default:
false
Whether or not to read yaml as multi-document sources. With
true
, theloadAll
will be used to parse yaml files. Withfalse
, theload
will be used to parse yaml files. See here for more details.- Type:
xml.xml2jsOptions
- Type:
ParserOptions
- Default:
null
Options of
xml2js
. See here for more details.- Type:
csv.csvOptions
Options ofcsv-parse
. See here for more details.xlsx.xlsxOptions
Options ofsheetjs
. See here for more details.