refactor(xml-parser): rename xmi-parser to xml-parser

.changeset/thin-berries-camp.md

@@ -19,7 +19,7 @@
 '@cm2ml/plugin-adapter': major
 '@cm2ml/rest': major
 '@cm2ml/rest-adapter': major
-'@cm2ml/xmi-parser': major
+'@cm2ml/xml-parser': major
 'kernighan-lin': major
 '@cm2ml/uml': major
 'prefixspan': major

README.md

@@ -25,7 +25,7 @@
 - [@cm2ml/plugin-adapter](./packages/framework/plugin-adapter)
 - [@cm2ml/rest](./packages/framework/rest)
 - [@cm2ml/rest-adapter](./packages/framework/rest-adapter)
-- [@cm2ml/xmi-parser](./packages/framework/xmi-parser)
+- [@cm2ml/xml-parser](./packages/framework/xml-parser)
 
 ## Languages
 

packages/framework/builtin/package.json

@@ -49,7 +49,7 @@
     "@cm2ml/tf-encoder": "workspace:*",
     "@cm2ml/tree-encoder": "workspace:*",
     "@cm2ml/uml": "workspace:*",
-    "@cm2ml/xmi-parser": "workspace:*",
+    "@cm2ml/xml-parser": "workspace:*",
     "@yeger/streams": "1.2.2"
   },
   "devDependencies": {

packages/framework/builtin/src/index.ts

@@ -22,7 +22,7 @@ export * from '@cm2ml/pattern-miner'
 export * from '@cm2ml/tf-encoder'
 export * from '@cm2ml/tree-encoder'
 export * from '@cm2ml/uml'
-export * from '@cm2ml/xmi-parser'
+export * from '@cm2ml/xml-parser'
 
 export type Parser = Plugin<string, GraphModel, any>
 

packages/framework/cm2ml/package.json

@@ -50,7 +50,7 @@
     "@cm2ml/rest": "workspace:*",
     "@cm2ml/rest-adapter": "workspace:*",
     "@cm2ml/utils": "workspace:*",
-    "@cm2ml/xmi-parser": "workspace:*"
+    "@cm2ml/xml-parser": "workspace:*"
   },
   "devDependencies": {
     "@cm2ml/tsconfig": "workspace:*",

packages/framework/metamodel/src/metamodel.ts

@@ -171,7 +171,7 @@ export class MetamodelElement<
     if (this.metamodel.isValidTag(tag)) {
       return this.#assignableTags.has(tag)
     }
-    // During the transformation, we replace the xmi tags with the UML types, so this additional check is necessary
+    // Some parsers might also treat the tag as a type
     if (this.metamodel.isValidType(tag)) {
       return this.#assignableTypes.has(tag)
     }

packages/framework/xml-parser/README.md

@@ -0,0 +1 @@
+# @cm2ml/xml-parser

packages/framework/xmi-parser/package.json → packages/framework/xml-parser/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@cm2ml/xmi-parser",
+  "name": "@cm2ml/xml-parser",
   "type": "module",
   "version": "0.0.0",
   "author": {
@@ -10,7 +10,7 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/borkdominik/CM2ML.git",
-    "directory": "packages/framework/xmi-parser"
+    "directory": "packages/framework/xml-parser"
   },
   "bugs": {
     "url": "https://github.com/borkdominik/CM2ML/issues"

packages/framework/xmi-parser/src/index.ts → packages/framework/xml-parser/src/index.ts

@@ -9,12 +9,12 @@ import { parseDocument } from 'htmlparser2'
 
 export type TextNodeHandler = (node: GraphNode, text: string) => void
 
-export function createXmiParser(
+export function createXMLParser(
   metamodel: Metamodel<string, string, string>,
   textNodeHandler: TextNodeHandler,
 ) {
   return definePlugin({
-    name: 'xmi',
+    name: 'xml',
     parameters: {
       debug: {
         type: 'boolean',
@@ -33,12 +33,12 @@ export function createXmiParser(
 }
 
 function parse(
-  xmi: string,
+  xml: string,
   metamodel: Metamodel<string, string, string>,
   settings: Settings,
   textNodeHandler: TextNodeHandler,
 ): GraphModel {
-  const document = parseDocument(xmi, {
+  const document = parseDocument(xml, {
     xmlMode: true,
   })
   return mapDocument(document, metamodel, settings, textNodeHandler)
@@ -103,18 +103,18 @@ function initNodeFromElement(
 }
 
 function mapAttribute([name, value]: [string, string]): Attribute {
-  const xmiValue = mapValue(value)
+  const xmlValue = mapValue(value)
   const parsedName = parseNamespace(name)
   if (typeof parsedName === 'object') {
     return {
       name,
       simpleName: parsedName.name,
       namespace: parsedName.namespace,
       type: 'unknown',
-      value: xmiValue,
+      value: xmlValue,
     }
   }
-  return { name, type: 'unknown', value: xmiValue }
+  return { name, type: 'unknown', value: xmlValue }
 }
 
 function mapValue(value: string): Value {

packages/framework/xmi-parser/test/__snapshots__/xmi-parser.test.ts.snap → packages/framework/xml-parser/test/__snapshots__/xmi-parser.test.ts.snap

@@ -1,6 +1,6 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`xmi-parser > should parse 1`] = `
+exports[`xml-parser > should parse 1`] = `
 "<xmi:XMI xmlns:mofext="http://www.omg.org/spec/MOF/20131001" xmlns:uml="http://www.omg.org/spec/UML/20131001" xmlns:xmi="http://www.omg.org/spec/XMI/20131001">
   <uml:Package URI="http://www.omg.org/spec/XMI/20131001" name="XMI" xmi:id="_XMI" xmi:type="Package">
     <packagedElement name="Delete" xmi:id="_XMI-Delete" xmi:type="Class">

packages/framework/xmi-parser/test/xmi-parser.test.ts → packages/framework/xml-parser/test/xmi-parser.test.ts

@@ -3,7 +3,7 @@ import fs from 'node:fs'
 import { Metamodel } from '@cm2ml/ir'
 import { describe, expect, it } from 'vitest'
 
-import { createXmiParser } from '../src/index'
+import { createXMLParser } from '../src/index'
 
 const metamodel = new Metamodel({
   attributes: ['id', 'type'],
@@ -13,11 +13,11 @@ const metamodel = new Metamodel({
   tags: [],
 })
 
-describe('xmi-parser', () => {
+describe('xml-parser', () => {
   it('should parse', () => {
     const input = fs.readFileSync(`${import.meta.dirname}/../../../../models/xmi-model.xmi`, 'utf-8')
-    const xmiParser = createXmiParser(metamodel, () => { })
-    const output = xmiParser.validateAndInvoke(input, {
+    const xmlParser = createXMLParser(metamodel, () => { })
+    const output = xmlParser.validateAndInvoke(input, {
       debug: false,
       strict: true,
     })

packages/languages/archimate/package.json

@@ -43,7 +43,7 @@
     "@cm2ml/metamodel-refiner": "workspace:*",
     "@cm2ml/plugin": "workspace:*",
     "@cm2ml/utils": "workspace:*",
-    "@cm2ml/xmi-parser": "workspace:*"
+    "@cm2ml/xml-parser": "workspace:*"
   },
   "devDependencies": {
     "@cm2ml/tsconfig": "workspace:*",

packages/languages/archimate/src/archimate-parser.ts

@@ -1,7 +1,7 @@
 import type { GraphModel, GraphNode } from '@cm2ml/ir'
 import { createRefiner } from '@cm2ml/metamodel-refiner'
 import { compose, definePlugin } from '@cm2ml/plugin'
-import { createXmiParser } from '@cm2ml/xmi-parser'
+import { createXMLParser } from '@cm2ml/xml-parser'
 
 import { isArchiFormat, restructureArchiXml } from './formats/archi-format'
 import { isOpenGroupFormat, restructureOpenGroupXml } from './formats/opengroup-format'
@@ -118,7 +118,7 @@ function handleTextNode(node: GraphNode, textContent: string) {
 }
 
 export const ArchimateParser = compose(
-  createXmiParser(Archimate, handleTextNode),
+  createXMLParser(Archimate, handleTextNode),
   ArchimateRefiner,
   // compose(ArchimateRefiner, IrPostProcessor),
   'archimate',

packages/languages/ecore/package.json

@@ -42,7 +42,7 @@
     "@cm2ml/metamodel-refiner": "workspace:*",
     "@cm2ml/plugin": "workspace:*",
     "@cm2ml/utils": "workspace:*",
-    "@cm2ml/xmi-parser": "workspace:*",
+    "@cm2ml/xml-parser": "workspace:*",
     "@yeger/streams": "1.2.2"
   },
   "devDependencies": {

packages/languages/ecore/src/ecore-parser.ts

@@ -2,7 +2,7 @@ import type { GraphModel } from '@cm2ml/ir'
 import { IrPostProcessor } from '@cm2ml/ir-post-processor'
 import { createRefiner } from '@cm2ml/metamodel-refiner'
 import { compose, definePlugin } from '@cm2ml/plugin'
-import { createXmiParser } from '@cm2ml/xmi-parser'
+import { createXMLParser } from '@cm2ml/xml-parser'
 
 import { Ecore } from './metamodel/ecore'
 import { inferEcoreHandler } from './metamodel/ecore-handler-registry'
@@ -22,7 +22,7 @@ const EcoreRefiner = definePlugin({
 })
 
 export const EcoreParser = compose(
-  createXmiParser(Ecore, () => { }),
+  createXMLParser(Ecore, () => { }),
   compose(EcoreRefiner, IrPostProcessor),
   'ecore',
 )

packages/languages/uml/package.json

@@ -43,7 +43,7 @@
     "@cm2ml/metamodel-refiner": "workspace:*",
     "@cm2ml/plugin": "workspace:*",
     "@cm2ml/utils": "workspace:*",
-    "@cm2ml/xmi-parser": "workspace:*",
+    "@cm2ml/xml-parser": "workspace:*",
     "@yeger/streams": "1.2.2",
     "nanoid": "5.0.7"
   },

packages/languages/uml/src/uml-parser.ts

@@ -3,7 +3,7 @@ import { GraphNode } from '@cm2ml/ir'
 import { IrPostProcessor } from '@cm2ml/ir-post-processor'
 import { createRefiner } from '@cm2ml/metamodel-refiner'
 import { compose, definePlugin } from '@cm2ml/plugin'
-import { createXmiParser } from '@cm2ml/xmi-parser'
+import { createXMLParser } from '@cm2ml/xml-parser'
 import { nanoid } from 'nanoid'
 
 import { resolveDeployedElements } from './metamodel/resolvers/deployedElements'
@@ -273,7 +273,7 @@ function handleTextNode(node: GraphNode, text: string) {
 }
 
 export const UmlParser = compose(
-  createXmiParser(Uml, handleTextNode),
+  createXMLParser(Uml, handleTextNode),
   compose(UmlRefiner, IrPostProcessor),
   'uml',
 )