https://github.com/YanceyOfficial/rollup-plugin-toml

Convert .toml files to ES6 modules.
https://github.com/YanceyOfficial/rollup-plugin-toml

Last synced: 3 months ago
JSON representation

Convert .toml files to ES6 modules.

• Host: GitHub
• URL: https://github.com/YanceyOfficial/rollup-plugin-toml
• Owner: YanceyOfficial
• License: mit
• Created: 2022-06-24T10:10:47.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-10-16T17:08:15.000Z (about 2 years ago)
• Last Synced: 2024-03-15T12:13:07.319Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 42 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - toml - Convert .toml files to ES6 modules. (Plugins / Other File Imports)

README

        
[npm]: https://img.shields.io/npm/v/@yancey-inc/rollup-plugin-toml

[npm-url]: https://www.npmjs.com/package/@yancey-inc/rollup-plugin-toml

[size]: https://packagephobia.now.sh/badge?p=@yancey-inc/rollup-plugin-toml

[size-url]: https://packagephobia.now.sh/result?p=@yancey-inc/rollup-plugin-toml

[![npm][npm]][npm-url]

[![size][size]][size-url]

[![libera manifesto](https://img.shields.io/badge/libera-manifesto-lightgrey.svg)](https://liberamanifesto.com)

![Awesome Rollup](https://camo.githubusercontent.com/64f8905651212a80869afbecbf0a9c52a5d1e70beab750dea40a994fa9a9f3c6/68747470733a2f2f617765736f6d652e72652f62616467652e737667)

# @yancey-inc/rollup-plugin-toml

🍣 A Rollup plugin which Converts TOML files to ES6 modules.

## Requirements

This plugin requires an [LTS](https://github.com/nodejs/Release) Node version (v8.0.0+) and Rollup v1.20.0+.

## Install

Using npm:

```console

npm install @yancey-inc/rollup-plugin-toml --save-dev

```

## Usage

Create a `rollup.config.js` [configuration file](https://www.rollupjs.org/guide/en/#configuration-files) and import the plugin:

```js

import toml from '@yancey-inc/rollup-plugin-toml'

export default {

  input: 'src/index.js',

  output: {

    dir: 'output',

    format: 'cjs',

  },

  plugins: [toml()],

}

```

Then call `rollup` either via the [CLI](https://www.rollupjs.org/guide/en/#command-line-reference) or the [API](https://www.rollupjs.org/guide/en/#javascript-api).

## Options

### `exclude`

Type: `FilterPattern`


Default: `null`

A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should _ignore_. By default no files are ignored.

### `include`

Type: `FilterPattern`


Default: `null`

A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should operate on. By default all files are targeted.

## Meta

[CONTRIBUTING](/.github/CONTRIBUTING.md)

[LICENSE (MIT)](/LICENSE)