@groma/scanner-vue 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alex Gavrilescu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,67 @@
+# Vue scanner
+
+The Vue scanner adds single-file component (SFC) event bindings to Groma's
+TypeScript scanner evidence. Install the project's dependencies using its
+package manager and lockfile. The scanner reads the root `tsconfig.json`;
+it does not install dependencies or execute application code.
+
+```sh
+bun install --frozen-lockfile --ignore-scripts
+bun plugins/scanners/vue/build.ts
+```
+
+In the project being scanned:
+
+```sh
+groma scanner add /absolute/path/to/groma/plugins/scanners/vue/dist/package
+groma scan
+```
+
+The package bundles Vue language-core 3.3.11, Volar TypeScript 2.4.28,
+Vue compiler-dom 3.5.42 and its own TypeScript 5.9.3. Compiler-sfc 3.5.42
+provides build-time declarations only. The build
+pins compiler imports to that TypeScript installation. The separate TypeScript scanner uses its own 7.1 SDK. Compiler libraries and Vue helper declarations
+ship in the package; no consumer build or installation script is required.
+
+[Vue language tools](https://github.com/vuejs/language-tools) supply project
+configuration, SFC parsing, template code generation and original-source
+mappings. [Volar](https://github.com/volarjs/volar.js) integrates the generated
+code with the TypeScript checker, which resolves component imports and handler
+function identities. The scanner translates these facts into the existing
+supplied-callback evidence contract; it has no separate name or type resolver.
+
+## Supported interaction
+
+The qualified example is Vue REPL's CodeMirror `change` event bound to the
+parent's `onChange` function. A static imported SFC must use a typed
+`defineEmits` declaration assigned to a constant. A call to that same symbol
+must supply a declared literal event name inside a source function. The parent
+template must bind the event directly to one source function declaration or
+constant function expression. Imported TypeScript functions use the same rule.
+See [Vue component events](https://vuejs.org/guide/components/events).
+
+The observation records the emitting function, literal emit call, concrete
+template attribute and supplied handler. All positions refer to the original
+physical source, as zero-based UTF-16 offsets; lines are one-based. The nearest
+function owns a nested emit call. Repeated scans are deterministic.
+
+Unresolved, dynamic or unsupported bindings produce `unsupported-vue-binding`
+diagnostics and no certain relationship. This revision does not support
+Options API events, runtime `defineEmits` arrays, dynamic components, dynamic
+event names, handler expressions or modifiers, state stores, routing, server
+frameworks or arbitrary event mutation. Compiler syntax/template errors fail
+the scan and preserve the previous complete map. Readiness errors explain
+missing project dependencies or invalid configuration.
+
+Vue contributes `vue` Code provenance for configured source files. Shared core
+keeps one physical-file owner, interprets complementary and conflicting
+observations, and writes readable relationship rows. `.vue` and TypeScript
+edits participate in the existing scan watcher.
+
+In OKF, the result is ordinary source links and relationship Markdown. An SFC
+is source evidence; it does not automatically define a C4 responsibility or
+add a containment level. Groma's existing ownership and relationship model
+owns that interpretation. No new architecture metadata is added.
+
+See [validation](validation.md) for the pinned project and executed release
+checks. This prototype package name does not imply public publication.