janekdb / rug

Runtime for Rugs

Atomist 'rug'

The Rug runtime: Support for Atomist project operations such as project editors and executors (aka rugs).

Key areas of functionality:

| Area | Purpose | Base Package | Remarks | |---|---|---|---|---| | Tree model | Models project and file structure (e.g. ASTs) as a unified tree | com.atomist.tree | Used by parser and path expressions
| Project operation support | Editors and executors | com.atomist.project| Project operations are authored in the Rug DSL or TypeScript. | Parsing support | Support for parsing files and preserving positional information to allow clean in-place updates | com.atomist.tree.content.text | Integrates with Scala parser combinators and Antlr. Microgrammar support in early development. |
| TypeScript integration | Allows project operations to be written in JavaScript/TypeScript | com.atomist.rug.runtime.js | We also provide a TypeScript library to simplify authoring TypeScript rugs | Rug DSL | DSL for writing simple Rugs | com.atomist.rug.runtime.rugdsl | Implemented using Scala parser combinators. The Rug interpreter implementation will be replaced by a Rug-to-TypeScript transpiler. | Path expression language | XPath-like language for conveniently navigating trees | com.atomist.tree | Immature, but an important part of the ultimate vision

See

• Documentation of the Rug language.
• Introductory blog by Rod Johnson

Using

Most users will not need to use this project directly, but will use tools, e.g., rug-cli, that build on this project.

If you wish to develop tools using this project, you will need to add this project as a dependency and the maven repository where it is published to your build tool's configuration. For example, if you use maven, add the dependency to the <dependencies> section and the repository to the <repositories> section of your pom.xml:

<?xml version='1.0' encoding='UTF-8'?>
<project
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0">
	<modelVersion>4.0.0</modelVersion>
    ...
    <dependencies>
        ...
		<dependency>
			<groupId>com.atomist</groupId>
			<artifactId>rug</artifactId>
			<version>0.3.2</version>
			<exclusions>
				<exclusion>
					<groupId>ch.qos.logback</groupId>
					<artifactId>logback-classic</artifactId>
				</exclusion>
				<exclusion>
					<groupId>ch.qos.logback</groupId>
					<artifactId>logback-access</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
        ...
	</dependencies>
    ...
	<repositories>
		<repository>
			<id>public-atomist-release</id>
			<name>Atomist Release</name>
			<url>https://atomist.jfrog.io/atomist/libs-release</url>
			<snapshots>
				<enabled>false</enabled>
			</snapshots>
		</repository>
	</repositories>
    ...
</project>

Be sure to change the <version> to the one you want to use.

Support

General support questions should be discussed in the #support channel on our community slack team at atomist-community.slack.com.

If you find a problem, please create an issue.

Development

You can build, test, and install the project locally with maven.

$ mvn install

To create a new release of the project, simply push a tag of the form M.N.P where M, N, and P are integers that form the next appropriate semantic version for release. For example:

$ git tag -a 1.2.3

The Travis CI build (see badge at the top of this page) will automatically create a GitHub release using the tag name for the release and the comment provided on the annotated tag as the contents of the release notes. It will also automatically upload the needed artifacts.

The Rug type documentation is created as part of running the tests. To generate the documentation without running all the tests, you can run the following command:

$ mvn test -DwildcardSuites=com.atomist.rug.rugdoc.TypeDocTest

The documentation for all of the Rug types will be in a single file named target/RugTypes.md.