Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/n370/rollup-plugin-geojson
An unofficial Rollup plugin which Converts .geojson files to ES6 modules.
https://github.com/n370/rollup-plugin-geojson
geojson plugin rollup
Last synced: about 1 month ago
JSON representation
An unofficial Rollup plugin which Converts .geojson files to ES6 modules.
- Host: GitHub
- URL: https://github.com/n370/rollup-plugin-geojson
- Owner: n370
- License: other
- Created: 2021-05-25T14:41:06.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-11T21:19:05.000Z (over 1 year ago)
- Last Synced: 2024-05-10T21:46:37.741Z (about 2 months ago)
- Topics: geojson, plugin, rollup
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/rollup-plugin-geojson
- Size: 96.7 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- awesome - geojson - Convert GeoJSON files to ES Modules. (Plugins / Other File Imports)
README
[npm]: https://img.shields.io/npm/v/rollup-plugin-geojson
[npm-url]: https://www.npmjs.com/package/rollup-plugin-geojson
[size]: https://packagephobia.now.sh/badge?p=rollup-plugin-geojson
[size-url]: https://packagephobia.now.sh/result?p=rollup-plugin-geojson
[![npm][npm]][npm-url]
[![size][size]][size-url]
[](https://liberamanifesto.com)
# rollup-plugin-geojson
🍣 An unofficial Rollup plugin which Converts .geojson 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 rollup-plugin-geojson --save-dev
```
## Usage
Create a `rollup.config.js` [configuration file](https://www.rollupjs.org/guide/en/#configuration-files) and import the plugin:
```js
import geojson from 'rollup-plugin-geojson';
export default {
input: 'src/index.js',
output: {
dir: 'output',
format: 'cjs'
},
plugins: [geojson()]
};
```
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).
With an accompanying file `src/index.js`, the local `data.geojson` file would now be importable as seen below:
```js
// src/index.js
import data from './data.geojson';
console.log(`running version ${data.features}`);
```
## Options
### `compact`
Type: `Boolean`
Default: `false`
If `true`, instructs the plugin to ignore `indent` and generates the smallest code.
### `exclude`
Type: `String` | `Array[...String]`
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: `String` | `Array[...String]`
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.
### `indent`
Type: `String`
Default: `'\t'`
Specifies the indentation for the generated default export.
### `namedExports`
Type: `Boolean`
Default: `true`
If `true`, instructs the plugin to generate a named export for every property of the JSON object.
### `preferConst`
Type: `Boolean`
Default: `false`
If `true`, instructs the plugin to declare properties as variables, using either `var` or `const`. This pertains to tree-shaking.
## Meta
[CONTRIBUTING](/.github/CONTRIBUTING.md)
[LICENSE (MIT)](/LICENSE)