import {AtviseScriptTransformer} from 'atscm/src/transform/ScriptTransformer.js'

public class | source

AtviseScriptTransformer

src/lib/transform/PartialTransformer.js~PartialTransformer → SplittingTransformer → XMLTransformer → AtviseScriptTransformer

A transformer that splits atvise scripts and quick dynamics into a code file and a .json file containing parameters and metadata.

Static Member Summary

Static Public Members
public static get	scriptSourceExtension: string The source file extension to allow for scripts.
public static get	sourceExtensions: string[] The source file extensions to allow.

Public Methods
public	combineNodes(node: Node, sources: {[ext: string]}) Inlines the passed source nodes to the given container node.
public	processMetadata(document: Object): Object Extracts a script's metadata.
public	processParameters(document: Object): Object[] Extracts a script's parameters.
public	async transformFromDB(node: Node, context: Object): * Splits a node into multiple source nodes.

From class SplittingTransformer
public static get abstract	extension: string The extension to add to container node names when they are pulled.
public static get abstract	sourceExtensions: string[] The source file extensions to allow.
public static	splitFile(node: Node, newExtension: string): Node Splits a Node: The resulting is a clone of the input file, with a different path.
public abstract	combineNodes(node: BrowsedNode, sourceNodes: Map<string, BrowsedNode>) Combines the container node and the source nodes to one single node.
public	readNodeFile(node: BrowsedNode): boolean Returns `false` for all container nodes, so they don't get read.
public	async transformFromDB(node: BrowsedNode) Renames a container node, should be called by all subclasses.
public	async transformFromFilesystem(node: BrowsedNode, context: Object) Reads a given container nodes source nodes and combines them.
private	_combineNodes(node: BrowsedNode, sourceNodes: {[extension: string]}) Combines the container node and the source nodes to one single node by calling SplittingTransformer#combineNodes.

From class XMLTransformer
public get	builder: function(object: Object): string Returns the XML builder to use based on the current Transformer#direction.
private	_fromDBBuilder: function(object: Object): string The builder to use with direction TransformDirection.FromDB.
private	_fromFilesystemBuilder: function(object: Object): string The builder to use with direction TransformDirection.FromFilesystem.
public	decodeContents(node: Node): * Parses XML in a node's contents.
public	encodeContents(object: Object): * Builds an XML string from an object.

The source file extension to allow for scripts.

The source file extensions to allow.

Inlines the passed source nodes to the given container node.

Extracts a script's metadata.

Name	Type	Attribute	Description
document	Object		The parsed xml document to process.

The metadata found.

Extracts a script's parameters.

Name	Type	Attribute	Description
document	Object		The parsed xml document to process.

The parameters found.

Splits a node into multiple source nodes.

Name	Type	Attribute	Description
node	Node		A server node.
context	Object		The current transform context.