atma-io-middleware-yml

YAML middleware for Atma.IO and Atma.Toolkit

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
atma-io-middleware-yml
1.1.255 years ago5 years agoMinified + gzip package size for atma-io-middleware-yml in KB

Readme

YAML file middleware for Atma.IO and Atma.Toolkit ----- The Plugin provides a custom middleware to transpile yml files to jsons on the fly:
How to use
Embed into the project
  • Atma Toolkit
```bash
$ atma plugin install atma-io-middleware-yml --save-dev
```
This adds `atma-io-middleware-yml` npm dependency and the `package.json` would look like:
```javascript
{
"devDependencies": {
"atma-io-middleware-yml"
},
"atma": {
"plugins": [
"atma-io-middleware-yml"
],
"settings": {
"atma-io-middleware-yml": {
"yml": {
// yaml settings
}
}
}
}
}
```
  • App Bundler
```bash
$ npm i atma-io-middleware-yml --save-dev
```
Extend AppBundler config with yaml settings, e.g.
```javascript
{
/* ... any package json settings */
"app-bundler": {
/* ... any app-bundler settings */
"middlewares": {                
"yml": [
"atma-io-middleware-yml:read"
]
}
},
}
```
  • Run
+ **Atma Toolkit**  Dev Server
```bash
$ atma server
```
+ **App Bundler**  Just run app bundler commands as usual
---- The MIT License