search

ember-learn / ember-jsonapi-docs

fixes up the ember docs generated by YUIDoc to be in JSONAPI format + some other niceties
9 stars 11 forks source link

add parent to submodules #20

Closed esantelises closed 7 years ago

esantelises commented 7 years ago

addresses #14, add parent attribute to submodules

Before:

{
   "_id": "module-ember-2.10.0-ember-debug",
   "_rev": "2-ec994853d014dad098bf385723272d0c",
   "data": {
       "id": "ember-2.10.0-ember-debug",
       "type": "module",
       "attributes": {
           "name": "ember-debug",
           "submodules": {
           },
           "elements": {
           },
           "classes": {
               "Ember.Debug": 1
           },
           "fors": {
               "Ember": 1
           },
           "is_submodule": 1,
           "namespaces": {
           },
           "namespace": "",
           "file": "packages/ember-debug/lib/index.js",
           "line": 222
       },
       "relationships": {
           "classes": {
               "data": [
                   {
                       "type": "class",
                       "id": "ember-2.10.0-Ember.Debug"
                   }
               ]
           },
           "project-version": {
               "data": {
                   "id": "ember-2.10.0",
                   "type": "project-version"
               }
           }
       }
   }
}

After:

{
   "_id": "module-ember-2.10.0-ember-debug",
   "_rev": "2-ec994853d014dad098bf385723272d0c",
   "data": {
       "id": "ember-2.10.0-ember-debug",
       "type": "module",
       "attributes": {
           "name": "ember-debug",
           "submodules": {
           },
           "elements": {
           },
           "classes": {
               "Ember.Debug": 1
           },
           "fors": {
               "Ember": 1
           },
           "is_submodule": 1,
           "namespaces": {
           },
           "namespace": "",
           "file": "packages/ember-debug/lib/index.js",
           "line": 222,
          "parent": "ember"
       },
       "relationships": {
           "classes": {
               "data": [
                   {
                       "type": "class",
                       "id": "ember-2.10.0-Ember.Debug"
                   }
               ]
           },
           "project-version": {
               "data": {
                   "id": "ember-2.10.0",
                   "type": "project-version"
               }
           }
       }
   }
}
toddjordan commented 7 years ago

LGTM. Also ran the script and things generated as expected. Thanks!