installer

For installing dependencies of a pie item.

build

npm run build

test

npm test # unit tests
npm run integration-test # this is disabled for now. instead run: 
./node_modules/.bin/jest --config jest.config.int.js

publish

See the main readme.

Item Configuration

A pie item will have the following configuration:

{
  /** 
    * elements is a mapping between a custom element name and it's package.
    * on the left side is the name of the custom element that'll be used.
    * on the right side is the npm style dependency look up.
    * > NOTE: The npm package name does not need to match the element name, they'll be associated with each other.
    */

  elements: {
    'el-one': '../..', //where ../.. is an npm package called located 2 directories above
    'el-two': '^1.0.0', //looks for an npm package called 'el-two'
    'el-three': '@scope/name@^2.0.1' //looks for an npm package '@scope/name@^2.0.1`
    'el-four': 'user/repo#v2.0.0' // github repo
  },
  models: [
    { id: '1', element: 'el-one', ...}
  ]
}

Using the above pie item definition, install will install the dependencies needed and will return information on the installation.

The installation directory will look like so:

root
├── .configure   
│   ├── node_modules # configure dependencies in here
│   └── package.json
├── .controllers
│   ├── node_modules # controller dependencies in here
│   └── package.json
├── node_modules # player dependencies in here
└── package.json

It'll return an array of objects similar to:

{
  "element": "text-entry",
  "isLocal": true,
  "isPackage": true,
  "main": {
    "dir": "/Users/edeustace/dev/github/PieElements/pie-elements/packages/text-entry/docs/demo/.pie",
    "moduleId": "@pie-elements/text-entry",
    "tag": "text-entry"
  },
  "src": "../..",
  "controller": {
    "dir": "/Users/edeustace/dev/github/PieElements/pie-elements/packages/text-entry/docs/demo/.pie/.controller",
    "moduleId": "@pie-elements/text-entry-controller"
  },
  "configure": {
    "dir": "/Users/edeustace/dev/github/PieElements/pie-elements/packages/text-entry/docs/demo/.pie/.configurue",
    "moduleId": "@pie-elements/text-entry-configure",
    "tag": "text-entry-configure"
  }
}