Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juliandavidmr/microdsl
Content generator, takes the structure of any mysql database and automatically creates web forms, ORM models and many other custom content.
https://github.com/juliandavidmr/microdsl
dsl generator node-module
Last synced: about 1 month ago
JSON representation
Content generator, takes the structure of any mysql database and automatically creates web forms, ORM models and many other custom content.
- Host: GitHub
- URL: https://github.com/juliandavidmr/microdsl
- Owner: juliandavidmr
- License: mit
- Created: 2017-12-09T19:00:23.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2017-12-22T17:21:44.000Z (almost 7 years ago)
- Last Synced: 2024-10-11T06:05:54.329Z (about 1 month ago)
- Topics: dsl, generator, node-module
- Language: TypeScript
- Homepage:
- Size: 78.1 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# MicroDSL
Content generator, takes the structure of any mysql database and automatically creates web forms, ORM models and many other custom content.
**[See Examples](./examples)**
## Install
Using npm
```bash
npm install microdsl --save
```
Using yarn
```bash
yarn add microdsl
```
## Example
Automatically building a simple web form
**Step 1**: Import package and connect your database
```js
// test.js
var microdsl = require('microdsl')
// Mysql connect config
var config = {
user: 'root',
password: 'root',
host: 'localhost',
database: 'project'
}
microdsl(config, './form.html.microdsl').then(compiled => {
console.log(compiled)
/*
[
'here the content of your generated file',
'here the content of your 2° generated file',
...
]
*/
})
```
**Step 2**: Create file input _(form.html.microdsl)_
```html
Register <%= TABLENAME %>
<% for(var i=0; i< COLUMNS.length; i++) { %>
<% } %>
```
**Step 3**: Start compilation
```bash
node test.js
```
**Example output for a database table:**
```html
Register convocatoria
```
## API
MicroDSL has global variables that can be called from the input files
| Variable | Description | Content structure |
|-----------|-------------------|---------------------|
| TABLENAME | Name of the table | string type - 'person' |
| COLUMNS | Columns of the current table | array type - `[{ "Type": "varchar(64)","Null": "NO", "Key": "", "Default": null, "Extra": "", "name": "nombre" }, ...]` |
| RELS | Relations of the current table (foreign keys) | `['role.id', ...]`|
> If you want to know more about the compilation syntax, see [EJS](http://www.embeddedjs.com)
### **Functions**
| Function | Description | Example |
|--------------|------------------------------------------------------------|----------------------------------|
| to_sequelize | returns the equivalent MySQL object type in Sequelize ORM | [`<%= to_sequelize('VARCHAR') %>`](./examples/sequelize.microdsl) |
| to_waterline | returns the equivalent MySQL object type in Waterline ORM | [`<%= to_waterline('VARCHAR') %>`](./examples/waterline.model.microdsl) |
| is_required | returns a boolean, true if the MySQL attribute is required | [`<%= is_required(COLUMNS[i]) %>`](./examples/waterline.model.microdsl) |
| tag | render a html tag | [`<%= tag('div', 'Here content', 'class=test') %>`](./examples/tags.base.ejs) |
Example of execution of a function:
```ejs
<% for(var i=0; i< COLUMNS.length; i++) { %>
'<%= COLUMNS[i].name %>': {
type: '<%= to_waterline(COLUMNS[i]) %>',
required: <%= is_required(COLUMNS[i]) %>
},
<% } %>
```
## TODO
- [ ] Create CLI _(separate project)_
- [ ] [More examples](./examples)
---
Maintained by [juliandavidmr](https://github.com/juliandavidmr)