@atomist/rug

user-model

TypeScript model for user-authored code

installation

To make our model classes and interfaces work with the compiler and with jvm-npm for running it in Nashorn, read the following instructions.

Clone this repo into a folder called node_modules. node_modules needs to be in one of the parent folders of your project hosting your TypeScript Editor implementations.

Eg. the following layout will work

+- workspace
   +- node_modules
      +- user-model
   +- my-first-editor-project
      +- .atomist
         +- editors
            +- MyEditor.ts

Changelog

[0.11.0] - 2017-02-01

Added

• Implement JsonBackedContainerTreeNode, allows a ContainerTreeNode to maintain the Json is was generated from
• Add correlationId to Message, allows handler to define how Messages are correlated
• Support for @parameter TS class field decorators as per [#229][229]
• Support for a new TS (JS) Handler programming model as per [#105][105]
• Support for Type extensions/TreeNode written in TypeScript as per [#214][214]
• Generators are now declared with the generator keyword
• Optional predicates in tree expressions

Fixed

• LinkedJsonTreeDeserializer now properly returns string values
• LinkedJsonTreeDeserializer now works when an already linked object is updated
• TS generators are now passed project name as second argument as per TS contract
• Retain all changes from an editor [#199][199]
• Yml type can now be instantiated from ProjectMutableView, DirectoryMutableView, and FileMutableView [#250][250]
• Handle YAML files with multiple documents, but only first is parsed and addressable.

Changed

• BREAKING TreeNode.nodeType renamed to TreeNode.nodeTags
• We now create a new JS rug for each thread for safety [#78][78]
• BREAKING all JS based Rugs must export (a la Common-JS) vars implementing the associated interfaces. Previously we scanned for all top level vars.
• BREAKING Remove Executor support from Rug DSL as per [#206][206]
• TypeScript editors now return void. Use the new ProjectMutableView describeChange method to add any comments about the working of your editor.
• BREAKING CustomizingProjectGenerator was removed from ProjectGenerator.ts as it's no longer required, and it's thought that it's not being used at all yet.
• BREAKING signature of TypeScript ProjectGenerator.populate() changed: parameter projectName got removed. Name of the generated project can be obtained via project.name().
• Core.ts is generated and compiled on-the-fly during unit-testing so that the build is not dependent on network or later maven phases until deployment
• Scala compiler warnings are now fatal by default, use -P allow-warnings profile to have the old behavior. The Travis CI build uses the allow-warnings profile.

Deprecated

• The @generator has been deprecated in favor of the generator keyword