# sails-generate-raml-scaffolding > sails generate raml-scaffolding Latest version **0.1.2** (published 2015-01-03) · MIT license · 0 weekly downloads ## Install ```sh npm install sails-generate-raml-scaffolding pnpm add sails-generate-raml-scaffolding yarn add sails-generate-raml-scaffolding bun add sails-generate-raml-scaffolding ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.2 | | Published | 2015-01-03 | | First published | 2014-12-31 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 4 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | stt | | Maintainers | stt | | Keywords | raml-scaffolding, raml, scaffolding, generator, sails, generate, plugin | ## Links - npm: https://www.npmjs.com/package/sails-generate-raml-scaffolding - Repository: https://github.com/stt/sails-generate-raml-scaffolding - Issues: https://github.com/stt/sails-generate-raml-scaffolding/issues - npm.io page: https://npm.io/package/sails-generate-raml-scaffolding ## Dependencies (4) - [lodash](https://npm.io/package/lodash.md) >=2.4.x - [bluebird](https://npm.io/package/bluebird.md) ^2.5.3 - [raml-parser](https://npm.io/package/raml-parser.md) ~0.8.9 - [merge-defaults](https://npm.io/package/merge-defaults.md) >=0.1.0 ## Recent versions - 0.1.2 (latest) — 2015-01-03 - 0.1.1 — 2015-01-02 - 0.1.0 — 2014-12-31 ## README # sails-generate-raml-scaffolding A tool for generating Sails models from [RESTful API Modeling Language](http://raml.org/) specification. This is not intended to produce a working implementation of an API, or even working code in most cases, instead the result is simply meant to serve as a quickstart basis for a new project. ### Features - creates a model for each RAML resource - maps formParameters from post actions to model attributes - if Sails blueprints are configured to pluralize will rename models accordingly - maps several RAML attribute properties to one recognized by Waterline - parses RAML resource description field for annotations prefixed by `@wl-`, and inserts them in the model attribute definition (see [here](https://github.com/balderdashy/waterline-docs/blob/master/models.md) for supported properties), rest of the description is added as javascript comment ### Planned features - generating placeholder code for controllers and policies ### Known issues - identifying resources is naive and is likely to contain issues, e.g. collisions - practically no validation is done to verify RAML description fields or the code injected in to the model files - overwrites attributes of existing models if one with same name is parsed from RAML In other words, be cautious, do not run in a project with uncommitted code of any value. ### Installation ```sh $ npm install sails-generate-raml-scaffolding ``` ### Usage ##### On the command line ```sh $ sails generate raml-scaffolding ~/api.raml ``` ### Development To get started quickly and see this generator in action, ... Also see `CONTRIBUTING.md` for more information on overriding/enhancing existing generators. ### Questions? See `FAQ.md`. ### More Resources - [Stackoverflow](http://stackoverflow.com/questions/tagged/sails.js) - [#sailsjs on Freenode](http://webchat.freenode.net/) (IRC channel) - [Twitter](https://twitter.com/sailsjs) - [Professional/enterprise](https://github.com/balderdashy/sails-docs/blob/master/FAQ.md#are-there-professional-support-options) - [Tutorials](https://github.com/balderdashy/sails-docs/blob/master/FAQ.md#where-do-i-get-help) - Sails.js logo (small) ### License **[MIT](./LICENSE)** © 2014 [stt](http://github.com/stt) As for [Sails](http://sailsjs.org)? It's free and open-source under the [MIT License](http://sails.mit-license.org/). ![image_squidhome@2x.png](http://i.imgur.com/RIvu9.png) --- _Source: https://npm.io/package/sails-generate-raml-scaffolding · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._