Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/franckldx/grunt-swapi2json
This download swapi data available at http://swapi.co/ and store them in json files. Useful when one wanted to create a generated site or want to store those data locally
https://github.com/franckldx/grunt-swapi2json
Last synced: 5 days ago
JSON representation
This download swapi data available at http://swapi.co/ and store them in json files. Useful when one wanted to create a generated site or want to store those data locally
- Host: GitHub
- URL: https://github.com/franckldx/grunt-swapi2json
- Owner: franckLdx
- License: mit
- Created: 2016-07-01T11:13:02.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-24T21:22:31.000Z (over 6 years ago)
- Last Synced: 2024-10-30T07:07:30.618Z (about 2 months ago)
- Language: JavaScript
- Size: 80.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-swapi2json
> This download [swapi data](http://swapi.co/) and store them in json files. Useful when one wanted to create a generated site or one want to store those data locally.
**This version require
## Getting Started
**This plugin requires `Grunt ~0.4.5` and `Node v8.x or later`. For older Node, you can use `grunt-swapi2json 1.x`**
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-swapi2json --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-swapi2json');
```
## The "swapi2json" task
### Overview
In your project's Gruntfile, add a section named `swapi2json` to the data object passed into `grunt.initConfig()`.
You can either download all swapi resources, or download only some of them.
#### Download all resources:
```js
grunt.initConfig({
swapi2json: {
all: {
dir: './json'
},
},
});
```
#### Download some resources:
Use the [swapi resource(s)](http://swapi.co/documentation#root) name as a target:
```js
grunt.initConfig({
swapi2json: {
options: {
dir: './json'
},
films: {},
people: {},
},
});
```
### Options
#### dir
Type: `String`
Default value: `.`
The directory where files are be saved.
### Usage Examples
#### All resources
In this example, all resources are downloaded and saved.
```js
grunt.initConfig({
swapi2json: {
all: {
dir: './json'
},
},
});
```
When all target is used, a task for each resources are dynamically created:
#### Save some resources in a single directory
Use [swapi resource(s)](http://swapi.co/documentation#root) as target name.
```js
grunt.initConfig({
swapi2json: {
options: {
dir: './json'
},
films: {},
people: {},
},
});
```
#### Save some resources in directories
Use [swapi resource(s)](http://swapi.co/documentation#root) as target name.
```js
grunt.initConfig({
swapi2json: {
films: {
dir: './starwars/movies'
},
people: {
dir: './starwars/characters'
},
},
});
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
## Release History
* v1.0.0 First release.
* v1.0.1 Fix packaging.
* v1.0.2 Code refactoring.
* v1.0.3 Update dependencies.
* v2.0.0 Use [swapi-promise](https://www.npmjs.com/package/swapi-promise) instead of swapi-node.
* v2.0.1 Use new [swapi-promise](https://www.npmjs.com/package/swapi-promise) version.