readme.md

YAML file middleware for Atma.IO and Atma.Toolkit

The Plugin provides a custom middleware to transpile yml files to jsons on the fly:

• atma-io
• Atma Toolkit
• App Bundler

How to use

Embed into the project

• Atma Toolkit

  $ atma plugin install atma-io-middleware-yml --save-dev
  

  This adds atma-io-middleware-yml npm dependency and the package.json would look like:

      {
          "devDependencies": {
              "atma-io-middleware-yml"
          },
          "atma": {
              "plugins": [
                  "atma-io-middleware-yml"
              ],
              "settings": {
  				"atma-io-middleware-yml": {
                      "yml": {
                          // yaml settings
                      }
                  }
              }
          }
      }
  

• App Bundler

  $ npm i atma-io-middleware-yml --save-dev
  

  Extend AppBundler config with yaml settings, e.g.

  {
      /* ... any package json settings */
      "app-bundler": {
          /* ... any app-bundler settings */
          "middlewares": {                
              "yml": [
                  "atma-io-middleware-yml:read"
              ]
          }
      },
  }
  

• Run

  • Atma Toolkit Dev Server

    $ atma server
    

  • App Bundler Just run app bundler commands as usual

---

The MIT License