feat(model generator): add a model schema as a standard place to list…

… and document your model's ttributes
marviq · Aug 26, 2016 · 58ac9e1 · 58ac9e1
1 parent 0b10652
commit 58ac9e1
Showing 1 changed file with 25 additions and 1 deletion.
diff --git a/generators/model/templates/model.coffee b/generators/model/templates/model.coffee
@@ -20,6 +20,7 @@
 
     'use strict'
 
+
     ###*<% if ( description ) { %>
     #   <%- description %>
     #<% } %>
@@ -29,7 +30,30 @@
     #   @constructor<% } %>
     ###
 
-    class <%- className %> extends Backbone.Model<% if ( singleton ) { %>
+    class <%- className %> extends Backbone.Model
+
+        ###*
+        #   List of [valid attribute names](#attrs).
+        #
+        #   @property       schema
+        #
+        #   @type           Array[String]
+        #   @static
+        #   @final
+        ###
+
+        ###*
+        #   The `<%- className %>`'s unique identifier.
+        #
+        #   @attribute      id
+        #
+        #   @type           String
+        ###
+
+        schema: [
+
+            'id'
+        ]<% if ( singleton ) { %>
 
 
     ##  Export singleton.