Home Manual Reference Source Test
Manual » Configuration

Atviseproject.js

This file is required to exist in all atvise-scm project directories. It is automatically generated when running atvise-scm init.

It contains a ES2015 JavaScript module exporting a subclass of the Atviseproject class. Therefore look at the API Documentation for all available keys.

Sample

// Atviseproject.js

import { Atviseproject, NodeId } from 'atvise-scm';

export default class MyProject extends Atviseproject {

  static get host() {
    return 'localhost';
  }

  static get port() {
    return {
      opc: 4842,
      http: 80,
    };
  }

  static get nodes() {
    return [
      new NodeId('AGENT'),
      new NodeId('SYSTEM'),
    ];
  }

}

Extending Atviseproject

As the configuration is a regular ES2015 JavaScript class you can subclass it just like a regular JavaScript class:

export default class MyProject extends Atviseproject {

  ...

  // Add a custom transformer
  static get useTransformers() {
    return super.useTransformers.concat(new MyCustomTransformer());
  }

  // Use only the first default node
  static get nodes() {
    return super.nodes.slice(0, 1);
  }

}