{"id":33178916,"url":"https://github.com/atomist-attic/rug","last_synced_at":"2025-11-20T21:01:57.370Z","repository":{"id":57099602,"uuid":"74643409","full_name":"atomist-attic/rug","owner":"atomist-attic","description":"DEPRECATED Runtime for Rugs","archived":true,"fork":false,"pushed_at":"2018-01-30T23:04:00.000Z","size":7235,"stargazers_count":52,"open_issues_count":0,"forks_count":13,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-08-18T12:00:39.127Z","etag":null,"topics":["atomist","rug","scala"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/atomist-attic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-24T06:15:09.000Z","updated_at":"2024-11-28T16:33:03.000Z","dependencies_parsed_at":"2022-08-22T23:10:22.154Z","dependency_job_id":null,"html_url":"https://github.com/atomist-attic/rug","commit_stats":null,"previous_names":["atomist/rug"],"tags_count":1084,"template":false,"template_full_name":null,"purl":"pkg:github/atomist-attic/rug","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Frug","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Frug/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Frug/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Frug/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atomist-attic","download_url":"https://codeload.github.com/atomist-attic/rug/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Frug/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":285511776,"owners_count":27184237,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-11-20T02:00:05.334Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["atomist","rug","scala"],"created_at":"2025-11-16T03:00:36.653Z","updated_at":"2025-11-20T21:01:57.364Z","avatar_url":"https://github.com/atomist-attic.png","language":"Scala","funding_links":[],"categories":["Generic ##"],"sub_categories":[],"readme":"# DEPRECATED 'rug'\n\n[![Build Status](https://travis-ci.org/atomist/rug.svg?branch=master)](https://travis-ci.org/atomist/rug)\n\nThe Rug runtime: Support for Atomist **project operations** and **handlers** (aka *rugs*). Rugs are authored in JavaScript or any language that compiles to JavaScript capable of executing in [Nashorn](https://en.wikipedia.org/wiki/Nashorn_(JavaScript_engine)). We recommend [TypeScript](http://www.typescriptlang.org/) and provide TypeScript interfaces for the Atomist project and team model.\n\nKey areas of functionality of this project:\n\n\n|  Area |  Purpose | Base Package/Path |  Remarks |\n|---|---|---|---|\n|  Tree model | Models project and file structure (e.g. ASTs) as a unified tree  | `com.atomist.tree`  | Used by parser and path expressions\n| Project operation support  | Editors and executors  |   `com.atomist.project`|   Project operations are authored in TypeScript, JavaScript or any language that compiles to JavaScript.\n|  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. \n| JavaScript/TypeScript integration | Allows project operations to be written in JavaScript/TypeScript | `com.atomist.rug.runtime.js` | Uses Nashorn\n| Path expression language | XPath-like language for conveniently navigating trees | `com.atomist.tree` | Central concept for navigating project and model structure\n| TypeScript library |A `node` module to simplify authoring TypeScript rugs  | `src/main/typescript`| See [architectural overview](https://github.com/atomist/rug/blob/master/docs/TypeScriptLibrary.md). Will eventually be moved into a separate project.\n\nSee\n\n*  [Documentation](http://docs.atomist.com/).\n*  [Introductory blog](https://medium.com/the-composition/software-that-writes-and-evolves-software-953578a6fc36#.blgtxoyu4) by Rod Johnson\n\n## Using\n\nMost users will not need to use this project directly, but will use\ntools, e.g., [rug-cli][cli], that build on this project.\n\n[cli]: https://github.com/atomist/rug-cli\n\nIf you wish to develop tools using this project, you will need to add\nthis project as a dependency and the maven repository where it is\npublished to your build tool's configuration.  For example, if you use\nmaven, add the dependency to the `\u003cdependencies\u003e` section and the\nrepository to the `\u003crepositories\u003e` section of your `pom.xml`:\n\n```xml\n\u003c?xml version='1.0' encoding='UTF-8'?\u003e\n\u003cproject\n\txsi:schemaLocation=\"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd\"\n\txmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://maven.apache.org/POM/4.0.0\"\u003e\n\t\u003cmodelVersion\u003e4.0.0\u003c/modelVersion\u003e\n    ...\n    \u003cdependencies\u003e\n        ...\n\t\t\u003cdependency\u003e\n\t\t\t\u003cgroupId\u003ecom.atomist\u003c/groupId\u003e\n\t\t\t\u003cartifactId\u003erug\u003c/artifactId\u003e\n\t\t\t\u003cversion\u003e0.3.2\u003c/version\u003e\n\t\t\t\u003cexclusions\u003e\n\t\t\t\t\u003cexclusion\u003e\n\t\t\t\t\t\u003cgroupId\u003ech.qos.logback\u003c/groupId\u003e\n\t\t\t\t\t\u003cartifactId\u003elogback-classic\u003c/artifactId\u003e\n\t\t\t\t\u003c/exclusion\u003e\n\t\t\t\t\u003cexclusion\u003e\n\t\t\t\t\t\u003cgroupId\u003ech.qos.logback\u003c/groupId\u003e\n\t\t\t\t\t\u003cartifactId\u003elogback-access\u003c/artifactId\u003e\n\t\t\t\t\u003c/exclusion\u003e\n\t\t\t\u003c/exclusions\u003e\n\t\t\u003c/dependency\u003e\n        ...\n\t\u003c/dependencies\u003e\n    ...\n\t\u003crepositories\u003e\n\t\t\u003crepository\u003e\n\t\t\t\u003cid\u003epublic-atomist-release\u003c/id\u003e\n\t\t\t\u003cname\u003eAtomist Release\u003c/name\u003e\n\t\t\t\u003curl\u003ehttps://atomist.jfrog.io/atomist/libs-release\u003c/url\u003e\n\t\t\t\u003csnapshots\u003e\n\t\t\t\t\u003cenabled\u003efalse\u003c/enabled\u003e\n\t\t\t\u003c/snapshots\u003e\n\t\t\u003c/repository\u003e\n\t\u003c/repositories\u003e\n    ...\n\u003c/project\u003e\n```\n\nBe sure to change the `\u003cversion\u003e` to the one you want to use.\n\n## Support\n\nGeneral support questions should be discussed in the `#support`\nchannel on our community slack team\nat [atomist-community.slack.com](https://join.atomist.com).\n\nIf you find a problem, please create an [issue][].\n\n[issue]: https://github.com/atomist/rug/issues\n\n## Development\n\nYou can build, test, and install the project locally\nwith [Maven][maven].\n\n[maven]: https://maven.apache.org/\n\n```\n$ mvn install\n```\n\nThis will build, test, and locally install the Rug library.  To build\nthe Rug TypeScript `@atomist/rug` and `@atomist/cortex` modules, the\n\"npm-release\" profile must be used.  Unlike the [cortex][] build, the\ncortex model is not downloaded dynamically because Rug tracks the\nlatest, perhaps unreleased, version of the model.\n\nTo build the TypeScript modules and their documentation, generated\nfrom the TypeScript modules using [TypeDoc][typedoc], execute at least\nthrough the Maven lifecycle `test` phase using the `npm-release`\nprofile.\n\n```\n$ mvn -P npm-release test\n```\n\nThe documentation for all of the Rug extensions will be in a directory\nnamed `target/typedoc`.\n\nDevelopment versions of the `@atomist/rug` npm module are published to\n`https://atomist.jfrog.io/atomist/api/npm/npm-dev`. The most\nstraightforward way to get these versions without making changes to\nyour configuration is:\n\n```bash\n$ npm install @atomist/rug --registry https://atomist.jfrog.io/atomist/api/npm/npm-dev\n```\n\nAlternatively, if you always want the latest snapshot, you can change\nyour config for the @atomist scope:\n\n```\nnpm config set @atomist:registry https://atomist.jfrog.io/atomist/api/npm/npm-dev\n```\n\n[typedoc]: http://typedoc.org/\n\n## Release\n\nReleasing Rug involves releasing the JVM artifacts to a Maven\nrepository, the TypeScript module to NPM, and the documentation to\nGitHub pages for this repository, available at\nhttp://apidocs.atomist.com/ .  Releasing Rug can be a multi-stepped\nprocess, depending on the changes that have been made.\n\nIf there are no changes to the TypeScript API, to create a release\nsimply push a tag of the form `M.N.P` where `M`, `N`, and `P` are\nintegers that form the next appropriate [semantic version][semver] for\nrelease.  For example:\n\n```\n$ git tag -a 1.2.3\n```\n\nThe Travis CI build (see badge at the top of this page) will upload\nthe needed artifacts and automatically create a GitHub release using\nthe tag name for the release and the comment provided on the annotated\ntag as the contents of the release notes.  The released artifacts are:\n\n-   Maven rug artifacts\n-   [`@atomist/rug`][rug-npm] Node module to [NPM][npm]\n-   TypeDoc for `@atomist/rug` and [`@atomist/cortex`][cortex-npm] to\n    the gh-pages branch of this repository, available under\n    http://apidocs.atomist.com/typedoc/\n\nNote that while the `@atomist/cortex` module is built as part of the\nrug build, it is published by the [cortex][]\nrepository [build][cortex-build].  The cortex release process also\npublishes the cortex TypeDoc to http://cortex.atomist.com .  So if the\nAPI of cortex has changed at all, you will need to initiate a release\nof that repository.  This confusion will need to be resolved at some\npoint in the future.\n\n[semver]: http://semver.org\n[rug-npm]: https://www.npmjs.com/package/@atomist/rug\n[npm]: https://www.npmjs.com/\n[cortex-npm]: https://www.npmjs.com/package/@atomist/cortex\n[cortex]: https://github.com/atomist/cortex\n[cortex-build]: https://travis-ci.org/atomist/cortex\n\nIf there have been changes to either the `@atomist/rug` or\n`@atomist/cortex` TypeScript APIs, you will need to update the\ndependencies in the [rugs][] repository `package.json` and initiate a\nnew release of that repository to publish a new version of the\n`@atomist/rugs` TypeScript module, which is the dependency everyone\nuses to bring in rug and cortex.  This should all be automated,\nperhaps in a separate repository or by chaining events to span\nrepositories.\n\n[rugs]: https://github.com/atomist/rugs\n\n---\nCreated by [Atomist][atomist].\nNeed Help?  [Join our Slack team][slack].\n\n[atomist]: https://www.atomist.com/\n[slack]: https://join.atomist.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatomist-attic%2Frug","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatomist-attic%2Frug","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatomist-attic%2Frug/lists"}