Skip to content

Commit 81854e6

Browse files
kgilpinapotterri
authored andcommitted
feat: Migrate from @appland/cli to @appland/appmap
The JS CLI package has been renamed. Migrate to the new package.
1 parent 8cf73f0 commit 81854e6

File tree

4 files changed

+414
-26
lines changed

4 files changed

+414
-26
lines changed

ARCHITECTURE.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ The official documentation for `appmap-ruby` is at [appland.com/docs](https://ap
66

77
## Integration with appmap-js
88

9-
Most of the analytics functionality for AppMap JSON is implemented in [appmap-js](https://github.com/applandinc/appmap-js/). In particular, `packages/cli`. `appmap-ruby` includes the source code and dependencies of `@appland/cli`. Check the [Rakefile](./Rakefile) for references to npm and/or yarn to see how the packaging works.
9+
Most of the analytics functionality for AppMap JSON is implemented in [appmap-js](https://github.com/applandinc/appmap-js/). In particular, `packages/cli`. `appmap-ruby` includes the source code and dependencies of `@appland/appmap`. Check the [Rakefile](./Rakefile) for references to npm and/or yarn to see how the packaging works.
1010

11-
`appmap-ruby` executes command-line programs provdied by `@appland/cli`; it doesn't attempt to load a Node.js library in-process. `@appland/cli` commands are designed to produce clean output on stdout, which is obtained and processed by `appmap-ruby`.
11+
`appmap-ruby` executes command-line programs provided by `@appland/appmap`; it doesn't attempt to load a Node.js library in-process. `@appland/appmap` commands are designed to produce clean output on stdout, which is obtained and processed by `appmap-ruby`.
1212

1313
## Swagger (OpenAPI) generation
1414

@@ -41,7 +41,7 @@ The package `appmap/swagger` is loaded automatically by `appmap`, when Rake is a
4141

4242
## Depends (incremental testing)
4343

44-
`appmap-ruby` provides a [Rake task](./lib/appmap/depends/rake_tasks.rb) to automatically run tests and update AppMaps as local source files and test files are modified. It leans heavily on the `depends` command provided by `@appland/cli`. To understand how the Rake tasks work, consider running `appmap-js depends` on your local AppMaps - you can `touch` source files to see the dependency detection in action.
44+
`appmap-ruby` provides a [Rake task](./lib/appmap/depends/rake_tasks.rb) to automatically run tests and update AppMaps as local source files and test files are modified. It leans heavily on the `depends` command provided by `@appland/appmap`. To understand how the Rake tasks work, consider running `appmap-js depends` on your local AppMaps - you can `touch` source files to see the dependency detection in action.
4545

4646
However, computing which AppMaps need updating as a result of source files changes is only part of the story. `depends` also has to:
4747

@@ -50,7 +50,7 @@ However, computing which AppMaps need updating as a result of source files chang
5050
* Update the AppMap index after updating the AppMaps.
5151
* Remove any AppMaps which refer to tests that have been deleted.
5252

53-
Because `depends` has some complexity, there is an [API](./lib/appmap/depends/api.rb) module that implements key commands. To understand `depends` in further detail, after trying out the `@appland/cli` command, read this API.
53+
Because `depends` has some complexity, there is an [API](./lib/appmap/depends/api.rb) module that implements key commands. To understand `depends` in further detail, after trying out the `@appland/appmap` command, read this API.
5454

5555
The package `appmap/depends` is loaded automatically by `appmap`, when Rake is available in the bundle.
5656

lib/appmap/node_cli.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
module AppMap
77
# Utilities for invoking the +@appland/appmap+ CLI.
88
class NodeCLI
9-
APPMAP_JS = Pathname.new(__dir__).join('../../node_modules/@appland/cli/src/cli.js').expand_path.to_s
9+
APPMAP_JS = Pathname.new(__dir__).join('../../node_modules/@appland/appmap/src/cli.js').expand_path.to_s
1010

1111
attr_reader :verbose
1212
# Directory to scan for AppMaps.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@
1717
},
1818
"homepage": "https://github.com/applandinc/appmap-ruby#readme",
1919
"dependencies": {
20-
"@appland/cli": "^1.3.2"
20+
"@appland/appmap": "^3.0.0"
2121
}
2222
}

0 commit comments

Comments
 (0)