Artefact file structure.md

Artefact file structure

artefact.json
map.json
/view-models
/services
/ui
/preview
/fakes
/test
/docs
...

Artefact response.md

{
  "name": "contacts",
  "description": "Contacts management",
  "author": {
    "name": "Kristian Mandrup",
    "alias": "kmandrup",
    "email": "[email protected]",
    "organisation": "tecla5",
    "profile": "tecla5.com/kmandrup"
  },
  "type": "component",
  "keywords": [
    "contacts"
  ],
  "version": “0.9.5",
  "location": "github:kmandrup/contacts#1.2",
  "notice": "Added bootstrap support",
  "status": “beta”,
  “environment”: {
    “app”: {
      “vue”: {
        “versions”: {
          “>1 and <2”: {
            “status”: “stable”
          }
        }
      }
    },
    “test”: {
      “unit”: {
        “mocha”: {
          “versions”: [“1”, “2”]
        }
      },
      “e2e”: {
        “nightwatch”: {
          “versions”: “<1”
        }
      }
    },
    “ui”: {
      “bootstrap”: {
        “versions”: [“3”, “4”]
      }
    }
  },
  "install": {
   "dependencies": {
      "components": {
        "entity": {
          "version": "^1.0"
        }
      },
      "libs": [
        "lodash"
      ]
    }
  }        
}   

test.md

Test artefact

/tests
  - map.json
  - Tests.md
  /unit
    /mocha
      - contacts.spec.js
    /karma
      - …
  /e2e
    /nightwatch
      - …
    /protractor

map.json

{
  “unit”: {
    “mocha”: {
      "versions": {
        “^1.0”: {
          "path": “unit/mocha”,
          "dependencies": {
            "libs": {
              "mocha": "^1.0"
            }
          }
        }
        “^2.0”: {
          "path“: "unit/mocha-v2”,
          "dependencies": {
            "libs": {
              "mocha": "^2.0"
            }
          }
        }
      }
    },
    “karma”: “unit/karma”
  }
  “e2e”: {
    …
  }
  …
}

Version response.md

{
 "categories": [
   "entity"
 ],
 "popularWith": {
   "components": {
     "edgy": {
       "combined": 1151
     }
   },
   "apps": {
     "social-app": {
       "combined": 94
     }
   }
 },
 "version": "1.2",
 "location": "github:kmandrup/contacts#1.2",
 "notice": "Added bootstrap",
 "status": "beta",
 "ratings": [
   { "rating": "4", "comment": "Perfect for my needs", "user": "goofy" },
   { "rating": "2", "comment": "Missing a Dialogue", "user": "all4you" },
   { "rating": "3", "comment": "Bootstrap UI looks good", "user": "megaboy" }
 ],
 "fakes": "complete",
 "preview": "complete",
 "docs": "complete",
 "tests": "incomplete",
 "configs": {
   "local": "complete",
   "remote": "alpha"
 }
 }