You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ARCHITECTURE.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,9 @@ The official documentation for `appmap-ruby` is at [appland.com/docs](https://ap
6
6
7
7
## Integration with appmap-js
8
8
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.
10
10
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`.
12
12
13
13
## Swagger (OpenAPI) generation
14
14
@@ -41,7 +41,7 @@ The package `appmap/swagger` is loaded automatically by `appmap`, when Rake is a
41
41
42
42
## Depends (incremental testing)
43
43
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.
45
45
46
46
However, computing which AppMaps need updating as a result of source files changes is only part of the story. `depends` also has to:
47
47
@@ -50,7 +50,7 @@ However, computing which AppMaps need updating as a result of source files chang
50
50
* Update the AppMap index after updating the AppMaps.
51
51
* Remove any AppMaps which refer to tests that have been deleted.
52
52
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.
54
54
55
55
The package `appmap/depends` is loaded automatically by `appmap`, when Rake is available in the bundle.
0 commit comments