From 24e2dddb69b63dfbb8aaa296088d16d03fd03dbe Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 11 Sep 2026 16:21:43 +0000 Subject: [PATCH 01/11] Update UML CI to validate docs Co-authored-by: fuhrmanator <7606540+fuhrmanator@users.noreply.github.com> --- .github/workflows/generateUml.yml | 15 ++++++--------- README.md | 13 ++++++++++++- 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/.github/workflows/generateUml.yml b/.github/workflows/generateUml.yml index bdcad169..01f6ef29 100644 --- a/.github/workflows/generateUml.yml +++ b/.github/workflows/generateUml.yml @@ -1,7 +1,7 @@ name: Generate UML Diagrams on: - push: + pull_request: branches: - master workflow_dispatch: @@ -44,13 +44,10 @@ jobs: echo "changed=false" >> $GITHUB_OUTPUT fi - - name: Push docs to current branch + - name: Fail if UML diagrams are outdated if: steps.check_changes.outputs.changed == 'true' - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | - git config --global user.name 'github-actions[bot]' - git config --global user.email 'github-actions[bot]@users.noreply.github.com' - git add -v doc-uml - git commit -v -m "Update docs for branch ${{ github.ref_name }}" - git push origin HEAD:refs/heads/${{ github.ref_name }} # Push to the branch that triggered the workflow + echo "Generated UML documentation is out of date." + echo "Run 'npm run uml', commit the updated files in doc-uml/, and update this pull request." + git diff -- doc-uml + exit 1 diff --git a/README.md b/README.md index 506be34e..c7d21160 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,17 @@ npx ts2famix [options] ## TypeScript Metamodel API documentation (visualization) -The following was generated by CI using [tplant](https://github.com/bafolts/tplant), in a similar fashion described [here](https://modularmoose.org/posts/2021-07-19-automatic-metamodel-documentation-generation). +The UML files in `doc-uml/` are versioned with the source. CI now checks that they are up to date and fails the pull request if they are not. + +When a change affects the TypeScript metamodel in `src/lib/famix/`, update the UML before pushing: + +```sh +npm install +npm run uml +git add doc-uml +git commit -m "Update UML documentation" +``` + +The following diagram is generated using [tplant](https://github.com/bafolts/tplant), in a similar fashion described [here](https://modularmoose.org/posts/2021-07-19-automatic-metamodel-documentation-generation). ![FamixTypeScript API Metamodel](doc-uml/famix-typescript-model.svg) From ac8fc89a3b56c2e6ea7f4d2bb2d50a32e6cde4b2 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 12 Sep 2026 15:45:55 +0000 Subject: [PATCH 02/11] Update committed UML artifacts for generate-uml workflow Co-authored-by: fuhrmanator <7606540+fuhrmanator@users.noreply.github.com> --- doc-uml/famix-typescript-model.puml | 87 +++++++++++++++++++++-------- doc-uml/famix-typescript-model.svg | 2 +- 2 files changed, 64 insertions(+), 25 deletions(-) diff --git a/doc-uml/famix-typescript-model.puml b/doc-uml/famix-typescript-model.puml index 3f78d0e6..285935ea 100644 --- a/doc-uml/famix-typescript-model.puml +++ b/doc-uml/famix-typescript-model.puml @@ -38,9 +38,13 @@ class SourceAnchor extends Entity { +element: SourcedEntity +element: SourcedEntity } -class SourcedEntity extends Entity { +abstract class EntityWithSourceAnchor extends Entity { + #_sourceAnchor: SourceAnchor + +sourceAnchor: SourceAnchor + +sourceAnchor: SourceAnchor +} +class SourcedEntity extends EntityWithSourceAnchor { -_isStub: boolean - -_sourceAnchor: SourceAnchor -_comments: Set +addComment(comment: Comment): void -_declaredSourceLanguage: SourceLanguage @@ -84,13 +88,14 @@ class Module extends ScriptEntity { -_parentScope: ScopingEntity -_outgoingImports: Set +addOutgoingImport(importClause: ImportClause): void + +removeOutgoingImport(importClause: ImportClause): void +getJSON(): string +addPropertiesToExporter(exporter: FamixJSONExporter): void +parentScope: ScopingEntity +parentScope: ScopingEntity +outgoingImports: Set } -class ImportClause extends Entity { +class ImportClause extends EntityWithSourceAnchor { -_importingEntity: Module -_importedEntity: NamedEntity -_moduleSpecifier: string @@ -129,6 +134,7 @@ class NamedEntity extends SourcedEntity { +addReceivedInvocation(receivedInvocation: Invocation): void -_incomingImports: Set +addIncomingImport(anImport: ImportClause): void + +removeIncomingImport(anImport: ImportClause): void -_name: string -_aliases: Set +addAlias(alias: Alias): void @@ -177,7 +183,7 @@ class Property extends StructuralEntity { +parentEntity: Class | Interface +parentEntity: Class | Interface } -class Inheritance extends Entity { +class Inheritance extends EntityWithSourceAnchor { -_superclass: Class | Interface -_subclass: Class | Interface +getJSON(): string @@ -195,8 +201,10 @@ class Class extends Type { +addMethod(method: Method): void -_superInheritances: Set +addSuperInheritance(superInheritance: Inheritance): void + +removeSuperInheritance(superInheritance: Inheritance): void -_subInheritances: Set +addSubInheritance(subInheritance: Inheritance): void + +removeSubInheritance(subInheritance: Inheritance): void +getJSON(): string +addPropertiesToExporter(exporter: FamixJSONExporter): void +isAbstract: boolean @@ -238,8 +246,10 @@ class Interface extends Type { +addMethod(method: Method): void -_superInheritances: Set +addSuperInheritance(superInheritance: Inheritance): void + +removeSuperInheritance(superInheritance: Inheritance): void -_subInheritances: Set +addSubInheritance(subInheritance: Inheritance): void + +removeSubInheritance(subInheritance: Inheritance): void +getJSON(): string +addPropertiesToExporter(exporter: FamixJSONExporter): void +properties: Set @@ -319,6 +329,16 @@ class ParameterType extends Type { +baseType: Type +arguments: Set } +class EntityTyping extends Entity { + -_typedEntity: Entity + -_declaredType: Type + +getJSON(): string + +addPropertiesToExporter(exporter: FamixJSONExporter): void + +typedEntity: Entity + +typedEntity: Entity + +declaredType: Type + +declaredType: Type +} class BehavioralEntity extends ContainerEntity { -_signature: string -_parameters: Set @@ -326,7 +346,7 @@ class BehavioralEntity extends ContainerEntity { -_numberOfParameters: number -_incomingInvocations: Set +addIncomingInvocation(incomingInvocation: Invocation): void - -_declaredType: Type + -_typing: EntityTyping -_genericParameters: Set +addGenericParameter(genericParameter: ParameterType): void +clearGenericParameters(): void @@ -338,8 +358,8 @@ class BehavioralEntity extends ContainerEntity { +numberOfParameters: number +numberOfParameters: number +incomingInvocations: Set - +declaredType: Type - +declaredType: Type + +typing: EntityTyping + +typing: EntityTyping +genericParameters: Set } class Invocation extends Entity { @@ -417,9 +437,7 @@ class Type extends ContainerEntity { -_typeAliases: Set +addTypeAlias(typeAlias: Alias): void -_structuresWithDeclaredType: Set - +addStructureWithDeclaredType(structureWithDeclaredType: StructuralEntity): void -_behavioralEntitiesWithDeclaredType: Set - +addBehavioralEntityWithDeclaredType(behavioralEntityWithDeclaredType: BehavioralEntity): void -_incomingReferences: Set +addIncomingReference(incomingReference: Reference): void +getJSON(): string @@ -431,15 +449,19 @@ class Type extends ContainerEntity { +behavioralEntitiesWithDeclaredType: Set +incomingReferences: Set } +class ParametricEntityTyping extends EntityTyping { + +getJSON(): string + +addPropertiesToExporter(exporter: FamixJSONExporter): void +} class StructuralEntity extends NamedEntity { -_incomingAccesses: Set +addIncomingAccess(incomingAccess: Access): void - -_declaredType: Type + -_typing: EntityTyping | ParametricEntityTyping +getJSON(): string +addPropertiesToExporter(exporter: FamixJSONExporter): void +incomingAccesses: Set - +declaredType: Type - +declaredType: Type + +typing: EntityTyping | ParametricEntityTyping + +typing: EntityTyping | ParametricEntityTyping } class Access extends Entity { -_accessor: ContainerEntity @@ -454,7 +476,7 @@ class Access extends Entity { +isWrite: boolean +isWrite: boolean } -class Concretisation extends Entity { +class Concretization extends Entity { -_genericEntity: ParametricClass | ParametricInterface | ParametricMethod | ParametricFunction -_concreteEntity: ParametricClass | ParametricInterface | ParametricMethod | ParametricFunction +getJSON(): string @@ -491,18 +513,18 @@ class IndexedFileAnchor extends SourceAnchor { +fileName: string +fileName: string } -class ParameterConcretisation extends Entity { +class ParameterConcretization extends Entity { -_genericParameter: ParameterType -_concreteParameter: PrimitiveType - -_concretisations: Set - +addConcretisation(concretisation: Concretisation): void + -_concretizations: Set + +addConcretization(concretization: Concretization): void +getJSON(): string +addPropertiesToExporter(exporter: FamixJSONExporter): void +genericParameter: ParameterType +genericParameter: ParameterType +concreteParameter: PrimitiveType +concreteParameter: PrimitiveType - +concretisations: Set + +concretizations: Set } interface SearchParameters { +searchArray: string[] @@ -528,6 +550,9 @@ class EntityDictionary { -UNKNOWN_VALUE: string +fmxElementObjectMap: Map +tsMorphElementObjectMap: Map + +fmxEntityTypingMap: Map + +reset(): void + +getAbsolutePath(): string +addSourceAnchor(fmx: Famix.SourcedEntity, node: TSMorphObjectType): Famix.IndexedFileAnchor +makeFamixIndexFileAnchor(sourceElement: TSMorphObjectType, famixElement: Famix.SourcedEntity): void +createOrGetFamixFile(f: SourceFile, isModule: boolean): Famix.Module | Famix.ScriptEntity @@ -542,6 +567,7 @@ class EntityDictionary { +createOrGetFamixParameter(param: ParameterDeclaration): Famix.Parameter +createFamixParameterType(tp: TypeParameterDeclaration): Famix.ParameterType +createOrGetFamixVariable(variable: VariableDeclaration): Famix.Variable + +createOrGetFamixEntityTyping(entity: Famix.BehavioralEntity | Famix.StructuralEntity, type: Famix.Type): Famix.EntityTyping +createOrGetFamixEnum(enumEntity: EnumDeclaration): Famix.Enum +createFamixEnumValue(enumMember: EnumMember): Famix.EnumValue +createOrGetFamixDecorator(decorator: Decorator, decoratedEntity: PropertyDeclaration | GetAccessorDeclaration | SetAccessorDeclaration | ParameterDeclaration | ClassDeclaration | MethodDeclaration): Famix.Decorator @@ -557,13 +583,13 @@ class EntityDictionary { +createFamixImportClause(importedEntity: Famix.NamedEntity, importingEntity: Famix.Module): void +oldCreateOrGetFamixImportClause(importClauseInfo: { importDeclaration?: ImportEqualsDeclaration | ImportDeclaration | undefined; importerSourceFile: SourceFile; moduleSpecifierFilePath: string; importElement: ImportSpecifier | Identifier; isInExports: boolean; isDefaultExport: boolean; }): void +createOrGetFamixArrowFunction(arrowExpression: Expression, currentCC: { [key: string]: number; }): Famix.ParametricArrowFunction | Famix.ArrowFunction - +createFamixConcretisation(conEntity: Famix.ParametricClass | Famix.ParametricInterface | Famix.ParametricMethod | Famix.ParametricFunction, genEntity: Famix.ParametricClass | Famix.ParametricInterface | Famix.ParametricMethod | Famix.ParametricFunction): Famix.Concretisation - +createFamixParameterConcretisation(concretisation: Famix.Concretisation): Famix.ParameterConcretisation | undefined - +createFamixConcretisationClassOrInterfaceSpecialisation(element: ClassDeclaration | InterfaceDeclaration): void - +createFamixConcretisationGenericInstantiation(cls: ClassDeclaration): void - +createFamixConcretisationFunctionInstantiation(element: FunctionDeclaration | MethodDeclaration): void - +createFamixConcretisationInterfaceClass(cls: ClassDeclaration): void - +createFamixConcretisationTypeInstanciation(element: ClassDeclaration | InterfaceDeclaration): void + +createFamixConcretization(conEntity: Famix.ParametricClass | Famix.ParametricInterface | Famix.ParametricMethod | Famix.ParametricFunction, genEntity: Famix.ParametricClass | Famix.ParametricInterface | Famix.ParametricMethod | Famix.ParametricFunction): Famix.Concretization + +createFamixParameterConcretization(concretization: Famix.Concretization): Famix.ParameterConcretization | undefined + +createFamixConcretizationClassOrInterfaceSpecialisation(element: ClassDeclaration | InterfaceDeclaration): void + +createFamixConcretizationGenericInstantiation(cls: ClassDeclaration): void + +createFamixConcretizationFunctionInstantiation(element: FunctionDeclaration | MethodDeclaration): void + +createFamixConcretizationInterfaceClass(cls: ClassDeclaration): void + +createFamixConcretizationTypeInstanciation(element: ClassDeclaration | InterfaceDeclaration): void +convertToRelativePath(absolutePath: string, absolutePathProject: string): string } class FamixRepository { @@ -604,6 +630,17 @@ class FamixRepository { +addElement(element: FamixBaseElement): void -validateFQNs(): void +getJSON(): string + +removeElements(entities: FamixBaseElement[]): void + +getImportClauses(): Famix.ImportClause[] + +getInheritances(): Famix.Inheritance[] + -getElementsBySourceFile(sourceFile: string): FamixBaseElement[] + +removeEntitiesBySourceFile(sourceFile: string): FamixBaseElement[] + +removeRelatedAssociations(entities: FamixBaseElement[]): void +} +enum SourceFileChangeType { + Create + Update + Delete } class Importer { -project: Project @@ -611,6 +648,8 @@ class Importer { -processEntities(project: Project): void +famixRepFromSource(filename: string, source: string): FamixRepository +famixRepFromProject(project: Project): FamixRepository + +updateFamixModelIncrementally(sourceFileChangeMap: Map): void + -processReferences(sourceFiles: SourceFile[], allExistingSourceFiles: SourceFile[]): void } abstract class FamixBaseElement { +id: number diff --git a/doc-uml/famix-typescript-model.svg b/doc-uml/famix-typescript-model.svg index c4d733a7..46471ea1 100644 --- a/doc-uml/famix-typescript-model.svg +++ b/doc-uml/famix-typescript-model.svg @@ -1 +1 @@ -FamixJSONExporterEntityFamixBaseElementSourceLanguageCommentSourcedEntitySourceAnchorScopingEntityContainerEntityScriptEntityModuleImportClauseAliasNamedEntityDecoratorParameterStructuralEntityPropertyInheritanceClassTypeMethodBehavioralEntityInterfacePrimitiveTypeParametricClassParametricInterfaceFunctionAccessorParametricMethodParametricFunctionArrowFunctionParametricArrowFunctionParameterTypeInvocationReferenceVariableAccessConcretisationEnumEnumValueIndexedFileAnchorParameterConcretisationSearchParametersEntityDictionaryFamixRepositoryImporter \ No newline at end of file +FamixJSONExporterEntityFamixBaseElementSourceLanguageCommentSourcedEntitySourceAnchorEntityWithSourceAnchorScopingEntityContainerEntityScriptEntityModuleImportClauseAliasNamedEntityDecoratorParameterStructuralEntityPropertyInheritanceClassTypeMethodBehavioralEntityInterfacePrimitiveTypeParametricClassParametricInterfaceFunctionAccessorParametricMethodParametricFunctionArrowFunctionParametricArrowFunctionParameterTypeEntityTypingInvocationReferenceVariableParametricEntityTypingAccessConcretizationEnumEnumValueIndexedFileAnchorParameterConcretizationSearchParametersEntityDictionaryFamixRepositorySourceFileChangeTypeImporter \ No newline at end of file From 42c6a7d8628334a0bd9b39c287c352c9f256013a Mon Sep 17 00:00:00 2001 From: "C. Fuhrman" Date: Fri, 18 Sep 2026 16:56:25 -0400 Subject: [PATCH 03/11] Link to the PUML diagram in README.md (don't generate an SVG) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c7d21160..3105d779 100644 --- a/README.md +++ b/README.md @@ -86,4 +86,4 @@ git commit -m "Update UML documentation" The following diagram is generated using [tplant](https://github.com/bafolts/tplant), in a similar fashion described [here](https://modularmoose.org/posts/2021-07-19-automatic-metamodel-documentation-generation). -![FamixTypeScript API Metamodel](doc-uml/famix-typescript-model.svg) +![FamixTypeScript API Metamodel](https://www.plantuml.com/plantuml/proxy?cache=no&fmt=svg&src=https://raw.githubusercontent.com/fuhrmanator/FamixTypeScriptImporter/refs/heads/master/doc-uml/famix-typescript-model.puml) From cd263826d90eda7114be499b2375ee6d00f99d41 Mon Sep 17 00:00:00 2001 From: "C. Fuhrman" Date: Fri, 18 Sep 2026 17:12:13 -0400 Subject: [PATCH 04/11] update run uml command (platform-independent) --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 9a404c1f..04c9dd2a 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,7 @@ "refresh": "rm -rf ./node_modules ./package-lock.json && npm install", "doc": "typedoc && touch docs/.gitkeep", "coverage": "jest --colors --silent --coverage --coverageDirectory=coverage", - "uml": "./src/generate_uml.sh" + "uml": "tplant -i \"src/lib/famix/**/*.ts\" -o doc-metamodel/famix-typescript-model.puml && node -e \"const fs = require('fs'); const f = 'doc-metamodel/famix-typescript-model.puml'; fs.writeFileSync(f, fs.readFileSync(f, 'utf8').replace('@startuml', '@startuml metamodel'));\"" }, "bin": { "ts2famix": "dist/ts2famix-cli-wrapper.js" From 0c128428c5879586258529a38c5f8d459911f4c1 Mon Sep 17 00:00:00 2001 From: "C. Fuhrman" Date: Fri, 18 Sep 2026 17:12:45 -0400 Subject: [PATCH 05/11] npm audit fix --- package-lock.json | 128 +++++++++++++++++++++++----------------------- 1 file changed, 64 insertions(+), 64 deletions(-) diff --git a/package-lock.json b/package-lock.json index b1768947..fe5383c6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -743,41 +743,41 @@ } }, "node_modules/@humanfs/core": { - "version": "0.19.1", - "resolved": "https://registry.npmjs.org/@humanfs/core/-/core-0.19.1.tgz", - "integrity": "sha512-5DyQ4+1JEUzejeK1JGICcideyfUbGixgS9jNgex5nqkW+cY7WZhxBigmieN5Qnw9ZosSNVC9KQKyb+GUaGyKUA==", + "version": "0.19.2", + "resolved": "https://registry.npmjs.org/@humanfs/core/-/core-0.19.2.tgz", + "integrity": "sha512-UhXNm+CFMWcbChXywFwkmhqjs3PRCmcSa/hfBgLIb7oQ5HNb1wS0icWsGtSAUNgefHeI+eBrA8I1fxmbHsGdvA==", "dev": true, "license": "Apache-2.0", + "dependencies": { + "@humanfs/types": "^0.15.0" + }, "engines": { "node": ">=18.18.0" } }, "node_modules/@humanfs/node": { - "version": "0.16.6", - "resolved": "https://registry.npmjs.org/@humanfs/node/-/node-0.16.6.tgz", - "integrity": "sha512-YuI2ZHQL78Q5HbhDiBA1X4LmYdXCKCMQIfw0pw7piHJwyREFebJUvrQN4cMssyES6x+vfUbx1CIpaQUKYdQZOw==", + "version": "0.16.8", + "resolved": "https://registry.npmjs.org/@humanfs/node/-/node-0.16.8.tgz", + "integrity": "sha512-gE1eQNZ3R++kTzFUpdGlpmy8kDZD/MLyHqDwqjkVQI0JMdI1D51sy1H958PNXYkM2rAac7e5/CnIKZrHtPh3BQ==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@humanfs/core": "^0.19.1", - "@humanwhocodes/retry": "^0.3.0" + "@humanfs/core": "^0.19.2", + "@humanfs/types": "^0.15.0", + "@humanwhocodes/retry": "^0.4.0" }, "engines": { "node": ">=18.18.0" } }, - "node_modules/@humanfs/node/node_modules/@humanwhocodes/retry": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/@humanwhocodes/retry/-/retry-0.3.1.tgz", - "integrity": "sha512-JBxkERygn7Bv/GbN5Rv8Ul6LVknS+5Bp6RgDC/O8gEBU/yeH5Ui5C/OlWrTb6qct7LjjfT6Re2NxB0ln0yYybA==", + "node_modules/@humanfs/types": { + "version": "0.15.0", + "resolved": "https://registry.npmjs.org/@humanfs/types/-/types-0.15.0.tgz", + "integrity": "sha512-ZZ1w0aoQkwuUuC7Yf+7sdeaNfqQiiLcSRbfI08oAxqLtpXQr9AIVX7Ay7HLDuiLYAaFPu8oBYNq/QIi9URHJ3Q==", "dev": true, "license": "Apache-2.0", "engines": { - "node": ">=18.18" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/nzakas" + "node": ">=18.18.0" } }, "node_modules/@humanwhocodes/module-importer": { @@ -850,9 +850,9 @@ } }, "node_modules/@istanbuljs/load-nyc-config/node_modules/js-yaml": { - "version": "3.15.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.15.0.tgz", - "integrity": "sha512-ttBQIIQPDeLjpPOohtUdXuXUVoA2uIB6fEH9HyJ7234s5mBJ5wTx20njxplLZQgLaOfpmPQA7X2t5AX6tIPbog==", + "version": "3.15.2", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.15.2.tgz", + "integrity": "sha512-6EuL879VkRA+1Cz578mKMiKvjPNEuk6+r1JaFzoSWejZmtf7xWbIyw1e3KkxlkzTIt9Taw6JBhEppG7utc1P+w==", "dev": true, "license": "MIT", "dependencies": { @@ -1443,9 +1443,9 @@ } }, "node_modules/@ts-morph/common/node_modules/brace-expansion": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.1.tgz", - "integrity": "sha512-WR1cURNjuvBLMZBMbqM0UoE+WAfdUcEV1ccD8PVBVOI+Z3ND4+SZbN8RsfT2bMuG1qwz5RFvPukSZm5fF2D5eA==", + "version": "2.1.7", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.7.tgz", + "integrity": "sha512-uZbew1NqdmPDTMJ8ah1y+b+9QEJrfkXFk3RcTQw3X0jW/xRUvFKsg1CfQdSYGdTbXZWExtU3J3ccxtnfw1Fi0g==", "license": "MIT", "dependencies": { "balanced-match": "^1.0.0" @@ -1815,9 +1815,9 @@ } }, "node_modules/@typescript-eslint/typescript-estree/node_modules/brace-expansion": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.1.tgz", - "integrity": "sha512-WR1cURNjuvBLMZBMbqM0UoE+WAfdUcEV1ccD8PVBVOI+Z3ND4+SZbN8RsfT2bMuG1qwz5RFvPukSZm5fF2D5eA==", + "version": "2.1.7", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.7.tgz", + "integrity": "sha512-uZbew1NqdmPDTMJ8ah1y+b+9QEJrfkXFk3RcTQw3X0jW/xRUvFKsg1CfQdSYGdTbXZWExtU3J3ccxtnfw1Fi0g==", "dev": true, "license": "MIT", "dependencies": { @@ -2173,9 +2173,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.10.40", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.40.tgz", - "integrity": "sha512-BSSLZ9/Cjjv7Gtj5B68ZzXcXUg8iOf3fme+FCuh8rC/Go+Kmh8cox7M3A8dolou16s64QjLPOSdngh7GxXvkSw==", + "version": "2.11.25", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.11.25.tgz", + "integrity": "sha512-gMmEShwwq7FJqMwvfRwvCl00v4kN+KOfJqXn+f4nrufak5gNHJOksd/60Dvjuz7sI8Y5WiSFBa8FEYr+zoyqCw==", "dev": true, "license": "Apache-2.0", "bin": { @@ -2250,9 +2250,9 @@ } }, "node_modules/brace-expansion": { - "version": "1.1.15", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.15.tgz", - "integrity": "sha512-EwOCDEex4quD37XhqM3omwtMoJjr//isUZz1JopUNWms+4Z2ViyM/k1YIRePpoVNnQhENnxtFjLaxNHrT7xIUg==", + "version": "1.1.21", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.21.tgz", + "integrity": "sha512-9zeA+KLZNNzglF2TPKRQEDyx6Yby7daAkuy8MiPzpXPsYDWi/DRM8jmwUDxokQjYqBpv5DgPiwD4h4ZZSy1Ujw==", "dev": true, "license": "MIT", "dependencies": { @@ -2273,9 +2273,9 @@ } }, "node_modules/browserslist": { - "version": "4.28.4", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.4.tgz", - "integrity": "sha512-MTc8i/x9jBQd1iMw2CFGS+rwMa07eYjLR0CCTLDACl9xhxy+nIs3KeML/biicXtk9JrZ6dnnTatmc7ErPXIxqw==", + "version": "4.29.0", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.29.0.tgz", + "integrity": "sha512-3GSvyjvDI4Dur1Meg2BekJquu5uF+9R9a1+5M1Mde192eZoXbeXjzgOsgqPS2V8D5wrrip0gR5Hf/GhWQ9ZzaA==", "dev": true, "funding": [ { @@ -2293,11 +2293,11 @@ ], "license": "MIT", "dependencies": { - "baseline-browser-mapping": "^2.10.38", - "caniuse-lite": "^1.0.30001799", - "electron-to-chromium": "^1.5.376", - "node-releases": "^2.0.48", - "update-browserslist-db": "^1.2.3" + "baseline-browser-mapping": "^2.11.23", + "caniuse-lite": "^1.0.30001810", + "electron-to-chromium": "^1.5.427", + "node-releases": "^2.0.55", + "update-browserslist-db": "^1.3.3" }, "bin": { "browserslist": "cli.js" @@ -2398,9 +2398,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001800", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001800.tgz", - "integrity": "sha512-MMHtuAz9Ys840zAY5F4k6fV5GaivZ9sPk+nz0mY+GYVzRBnYkN0mpqkSR92oWRQ19yQWo4HvBV/FnC16AJX8MA==", + "version": "1.0.30001810", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001810.tgz", + "integrity": "sha512-TITQPUkaz+aVk5GL6NhOdwk1aEaNTSDPsGFWrTuhKGtjTF70jL/Oht2W4c6rXUe5fu7Ie19VIahAXHIIiWWNeg==", "dev": true, "funding": [ { @@ -2758,9 +2758,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.382", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.382.tgz", - "integrity": "sha512-8ETaWbV6SZOrno+G93Ffd9ENsMtetqdnqj4nlfxFW90Sm5GgnuV28Kf62hqQVD6VUgzm7qFQKsTsAPmeUiU3Ug==", + "version": "1.5.432", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.432.tgz", + "integrity": "sha512-4qa5o+sI3qFR+p1C6wZvY99x6q/3tR34n+ezZvWiJ9s0HJaaKwN6h1HTupFfv4fiSdQYMZWtVFBuzHdAXo1BnA==", "dev": true, "license": "ISC" }, @@ -3188,9 +3188,9 @@ } }, "node_modules/filelist/node_modules/brace-expansion": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.1.tgz", - "integrity": "sha512-WR1cURNjuvBLMZBMbqM0UoE+WAfdUcEV1ccD8PVBVOI+Z3ND4+SZbN8RsfT2bMuG1qwz5RFvPukSZm5fF2D5eA==", + "version": "2.1.7", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.7.tgz", + "integrity": "sha512-uZbew1NqdmPDTMJ8ah1y+b+9QEJrfkXFk3RcTQw3X0jW/xRUvFKsg1CfQdSYGdTbXZWExtU3J3ccxtnfw1Fi0g==", "dev": true, "license": "MIT", "dependencies": { @@ -4480,9 +4480,9 @@ "license": "MIT" }, "node_modules/js-yaml": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.3.0.tgz", - "integrity": "sha512-1td788aAnnZ5qs7V2QIRl1owjtYpbKt749Y3xauqQgwIIGF/xXWz1wMTEBx5O3LK3lXLVuqXPdPxj2BoFHaW9Q==", + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.3.2.tgz", + "integrity": "sha512-SFNOvSJ+Dgf/9An904Yx+CgSlIPCkIpao4qo51lpee25TIRejdH3rhR4EZMGoNx3/TP3O+wzWuiTFl4sqbltzA==", "dev": true, "funding": [ { @@ -4665,9 +4665,9 @@ "license": "MIT" }, "node_modules/linkify-it": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.1.tgz", - "integrity": "sha512-wVoTjP4Q6R0NW5hiZkVJaFZPWgtXfoGF+6LucL3/FtiNjmcHhYjEr5f1Kqjirc1nBW07J/ZuRFumqr2oqccEWg==", + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.2.tgz", + "integrity": "sha512-ONTm2jCMAVZjgQa/Fy1kScXsuOoF5NPTsoFBdE1KVIZ2vAh/r9+Bqo+0jINCBYnavTPQZz38QzFTme79ENoN3Q==", "dev": true, "funding": [ { @@ -4983,9 +4983,9 @@ "license": "MIT" }, "node_modules/node-releases": { - "version": "2.0.50", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.50.tgz", - "integrity": "sha512-J6l92tKHX6w8Jy5nO1Vuc01NoIiRGi/d6qBKVxh+IQ8Cr3b6HbVNfKiF8ZpFKufTwpwxMmce2W3iQZ861ZRyTg==", + "version": "2.0.56", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.56.tgz", + "integrity": "sha512-x0InOIyzgdk+eyaWaRJFH5snEtiImgBgblZ2CyPrLmqqcuMQkEvcDPHbzqbD8eDsSeJbVOjn+crzyzHaM4D+/A==", "dev": true, "license": "MIT", "engines": { @@ -6252,9 +6252,9 @@ } }, "node_modules/typedoc/node_modules/brace-expansion": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.1.tgz", - "integrity": "sha512-WR1cURNjuvBLMZBMbqM0UoE+WAfdUcEV1ccD8PVBVOI+Z3ND4+SZbN8RsfT2bMuG1qwz5RFvPukSZm5fF2D5eA==", + "version": "2.1.7", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.7.tgz", + "integrity": "sha512-uZbew1NqdmPDTMJ8ah1y+b+9QEJrfkXFk3RcTQw3X0jW/xRUvFKsg1CfQdSYGdTbXZWExtU3J3ccxtnfw1Fi0g==", "dev": true, "license": "MIT", "dependencies": { @@ -6338,9 +6338,9 @@ } }, "node_modules/update-browserslist-db": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz", - "integrity": "sha512-Js0m9cx+qOgDxo0eMiFGEueWztz+d4+M3rGlmKPT+T4IS/jP4ylw3Nwpu6cpTTP8R1MAC1kF4VbdLt3ARf209w==", + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.3.3.tgz", + "integrity": "sha512-pJ2sYawQS0R/WI928Gj5GlPhTGzbMelq0+4INtSYNDV9ErKJcX6xjGWkoG/VnB3dpUm00zALaqkrUD77pO5TDQ==", "dev": true, "funding": [ { From bb035a36afeb4e1349bb24995439e75da322394f Mon Sep 17 00:00:00 2001 From: "C. Fuhrman" Date: Fri, 18 Sep 2026 17:55:03 -0400 Subject: [PATCH 06/11] unused script for generating UML diagrams --- src/generate_uml.sh | 20 -------------------- 1 file changed, 20 deletions(-) delete mode 100755 src/generate_uml.sh diff --git a/src/generate_uml.sh b/src/generate_uml.sh deleted file mode 100755 index 9449d73e..00000000 --- a/src/generate_uml.sh +++ /dev/null @@ -1,20 +0,0 @@ -#!/usr/bin/env bash -# Gets latest plantuml -rm -f plantuml.jar -wget --no-verbose https://downloads.sourceforge.net/project/plantuml/plantuml.jar -# echo the version -echo "PlantUML version: $(java -jar plantuml.jar -version)" -echo "tplant version: $(npx tplant --version)" -# Builds metamodel plantuml from TypeScript sources -npx tplant -i src/lib/famix/**/*.ts -o doc-metamodel/famix-typescript-model.puml -sed -i 's/@startuml/& metamodel/' doc-metamodel/famix-typescript-model.puml -# Converts plantuml source to SVG image -java -jar plantuml.jar -v -tsvg doc-metamodel/famix-typescript-model.puml -mv doc-metamodel/metamodel.svg doc-metamodel/metamodel-full.svg -# Inserts include line to customize the file -sed -i '/@startuml metamodel/a !include skins.include.puml' doc-metamodel/famix-typescript-model.puml -# Converts plantuml source to SVG image -java -jar plantuml.jar -v -tsvg doc-metamodel/famix-typescript-model.puml -# Moves artifacts -rm -f doc-uml/* -mv doc-metamodel/*.svg doc-uml From 9a0676e659f7df23272a575408f0adc63887dc0a Mon Sep 17 00:00:00 2001 From: "C. Fuhrman" Date: Fri, 18 Sep 2026 18:39:27 -0400 Subject: [PATCH 07/11] don't check for changes in SVG diagram --- .github/workflows/generateUml.yml | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/.github/workflows/generateUml.yml b/.github/workflows/generateUml.yml index 01f6ef29..89080702 100644 --- a/.github/workflows/generateUml.yml +++ b/.github/workflows/generateUml.yml @@ -30,15 +30,10 @@ jobs: - name: Generate PlantUML class diagram from source run: tplant -i src/lib/famix/**/*.ts -o doc-uml/famix-typescript-model.puml - - name: Generate SVG Diagram from PlantUML - uses: Timmy/plantuml-action@v1 - with: - args: -v -config "doc-metamodel/skins.include.cfg" -tsvg doc-uml/famix-typescript-model.puml - - name: Check for changes in UML diagrams id: check_changes run: | - if git status --porcelain | grep 'doc-uml/famix-typescript-model.puml\|doc-uml/famix-typescript-model.svg'; then + if git status --porcelain | grep 'doc-uml/famix-typescript-model.puml'; then echo "changed=true" >> $GITHUB_OUTPUT else echo "changed=false" >> $GITHUB_OUTPUT From 1dbe8a767139c5282eee32ab30ebbef7d309e4a3 Mon Sep 17 00:00:00 2001 From: "C. Fuhrman" Date: Fri, 18 Sep 2026 19:37:48 -0400 Subject: [PATCH 08/11] Update uml in correct folder --- doc-uml/famix-typescript-model.puml | 112 +++++++++++++++++++++++----- package.json | 2 +- 2 files changed, 93 insertions(+), 21 deletions(-) diff --git a/doc-uml/famix-typescript-model.puml b/doc-uml/famix-typescript-model.puml index 285935ea..3a63df51 100644 --- a/doc-uml/famix-typescript-model.puml +++ b/doc-uml/famix-typescript-model.puml @@ -1,4 +1,4 @@ -@startuml +@startuml metamodel class FamixJSONExporter { -element: FamixBaseElement -bufferArray: any @@ -262,25 +262,25 @@ class PrimitiveType extends Type { +addPropertiesToExporter(exporter: FamixJSONExporter): void } class ParametricClass extends Class { - -_genericParameters: Set - +addGenericParameter(genericParameter: ParameterType): void + -_genericParameters: Set + +addGenericParameter(genericParameter: TypeParameter): void +clearGenericParameters(): void -_concreteParameters: Set +addConcreteParameter(concreteParameter: Class | Interface | PrimitiveType): void +getJSON(): string +addPropertiesToExporter(exporter: FamixJSONExporter): void - +genericParameters: Set + +genericParameters: Set +concreteParameters: Set } class ParametricInterface extends Interface { - -_genericParameters: Set - +addGenericParameter(genericParameter: ParameterType): void + -_genericParameters: Set + +addGenericParameter(genericParameter: TypeParameter): void +clearGenericParameters(): void -_concreteParameters: Set +addConcreteParameter(concreteParameter: Class | Interface | PrimitiveType): void +getJSON(): string +addPropertiesToExporter(exporter: FamixJSONExporter): void - +genericParameters: Set + +genericParameters: Set +concreteParameters: Set } class Function extends BehavioralEntity { @@ -316,7 +316,7 @@ class ParametricArrowFunction extends ArrowFunction { +addPropertiesToExporter(exporter: FamixJSONExporter): void +concreteParameters: Set } -class ParameterType extends Type { +class TypeParameter extends Type { -_parentGeneric: Method | ParametricArrowFunction | ArrowFunction | ParametricClass | ParametricInterface | ParametricMethod | Accessor | FamixFunction | ParametricFunction -_baseType: Type -_arguments: Set @@ -347,8 +347,8 @@ class BehavioralEntity extends ContainerEntity { -_incomingInvocations: Set +addIncomingInvocation(incomingInvocation: Invocation): void -_typing: EntityTyping - -_genericParameters: Set - +addGenericParameter(genericParameter: ParameterType): void + -_genericParameters: Set + +addGenericParameter(genericParameter: TypeParameter): void +clearGenericParameters(): void +getJSON(): string +addPropertiesToExporter(exporter: FamixJSONExporter): void @@ -360,7 +360,7 @@ class BehavioralEntity extends ContainerEntity { +incomingInvocations: Set +typing: EntityTyping +typing: EntityTyping - +genericParameters: Set + +genericParameters: Set } class Invocation extends Entity { -_candidates: Set @@ -514,23 +514,87 @@ class IndexedFileAnchor extends SourceAnchor { +fileName: string } class ParameterConcretization extends Entity { - -_genericParameter: ParameterType + -_genericParameter: TypeParameter -_concreteParameter: PrimitiveType -_concretizations: Set +addConcretization(concretization: Concretization): void +getJSON(): string +addPropertiesToExporter(exporter: FamixJSONExporter): void - +genericParameter: ParameterType - +genericParameter: ParameterType + +genericParameter: TypeParameter + +genericParameter: TypeParameter +concreteParameter: PrimitiveType +concreteParameter: PrimitiveType +concretizations: Set } ++isFQNNode(node: Node): boolean ++buildStageMethodMap(sourceFile: SourceFile): Map ++buildMethodPositionMap(sourceFile: SourceFile): Map ++getFQN(node: Node | FQNNode): string ++getUniqueFQN(node: Node): string | undefined ++getNameOfNode(a: Node): string ++getParameters(a: Node): string ++getFQNUnresolvedInheritedClassOrInterface(unresolvedInheritedClassOrInterface: ExpressionWithTypeArguments): string ++resetProcessFunctions(): void ++isSourceFileAModule(sourceFile: SourceFile): boolean ++getModulePath(importDecl: ImportDeclaration): string ++getImplementedOrExtendedInterfaces(interfaces: InterfaceDeclaration[], subClass: ClassDeclaration | InterfaceDeclaration): (InterfaceDeclaration | ExpressionWithTypeArguments)[] ++processFiles(sourceFiles: SourceFile[]): void ++processFile(f: SourceFile): void ++isAmbient(node: ModuleDeclaration): boolean ++isNamespace(node: ModuleDeclaration): boolean ++processModule(m: ModuleDeclaration): Famix.Module ++processAliases(m: ContainerTypes, fmxScope: ScopedTypes): void ++processClasses(m: SourceFile | ModuleDeclaration, fmxScope: Famix.Module | Famix.ScriptEntity): void ++getArrowFunctionClasses(f: ArrowFunction): ClassDeclaration[] ++getClassesDeclaredInArrowFunctions(s: SourceFile | ModuleDeclaration): ClassDeclaration[] ++processInterfaces(m: SourceFile | ModuleDeclaration, fmxScope: Famix.Module | Famix.ScriptEntity): void ++processVariables(m: ContainerTypes, fmxScope: Famix.Module | Famix.ScriptEntity | Famix.Method | Famix.Accessor | Famix.Function): void ++processEnums(m: ContainerTypes, fmxScope: ScopedTypes): void ++processFunctions(m: ContainerTypes, fmxScope: ScopedTypes): void ++processModules(m: SourceFile | ModuleDeclaration, fmxScope: Famix.Module | Famix.ScriptEntity): void ++processAlias(a: TypeAliasDeclaration): Famix.Alias ++processClass(c: ClassDeclaration): Famix.Class | Famix.ParametricClass ++processInterface(i: InterfaceDeclaration): Famix.Interface | Famix.ParametricInterface ++processStructuredType(c: ClassDeclaration | InterfaceDeclaration, fmxScope: Famix.Class | Famix.Interface | Famix.ParametricClass | Famix.ParametricInterface): void ++processProperty(p: PropertyDeclaration | PropertySignature): Famix.Property ++processMethod(m: MethodDeclaration | MethodSignature | ConstructorDeclaration | GetAccessorDeclaration | SetAccessorDeclaration): Famix.Method | Famix.Accessor ++processFunction(f: ArrowFunction | FunctionDeclaration | FunctionExpression): Famix.Function ++processFunctionExpressions(f: MethodDeclaration | FunctionDeclaration | ConstructorDeclaration | GetAccessorDeclaration | SetAccessorDeclaration, fmxScope: Famix.Method | Famix.Accessor | Famix.Function): void ++processParameters(m: ArrowFunction | MethodDeclaration | MethodSignature | FunctionDeclaration | FunctionExpression | ConstructorDeclaration | GetAccessorDeclaration | SetAccessorDeclaration, fmxScope: Famix.Method | Famix.Accessor | Famix.Function): void ++processParameterAsProperty(param: ParameterDeclaration, classDecl: ClassDeclaration | ClassExpression): Famix.Property ++convertParameterToPropertyRepresentation(param: ParameterDeclaration): { name: string; type: string; scope: Scope; isReadonly: boolean; } ++processParameter(paramDecl: ParameterDeclaration): Famix.Parameter ++processTypeParameters(e: ArrowFunction | MethodDeclaration | MethodSignature | FunctionDeclaration | FunctionExpression | ... 4 more ... | InterfaceDeclaration, fmxScope: Famix.Method | Famix.ArrowFunction | Famix.ParametricClass | Famix.ParametricInterface | Famix.Accessor | Famix.Function): void ++processTypeParameter(tp: TypeParameterDeclaration): Famix.TypeParameter ++processVariableStatement(v: VariableStatement): Famix.Variable[] ++processVariable(v: VariableDeclaration): Famix.Variable ++processEnum(e: EnumDeclaration): Famix.Enum ++processEnumValue(v: EnumMember): Famix.EnumValue ++processDecorators(e: MethodDeclaration | PropertyDeclaration | GetAccessorDeclaration | SetAccessorDeclaration | ParameterDeclaration | ClassDeclaration, fmxScope: Famix.Class | Famix.Property | Famix.Method | Famix.ParametricClass | Famix.Accessor | Famix.Parameter): void ++processDecorator(d: Decorator, e: MethodDeclaration | PropertyDeclaration | GetAccessorDeclaration | SetAccessorDeclaration | ParameterDeclaration | ClassDeclaration): Famix.Decorator ++processComments(e: SourceFile | VariableDeclaration | ArrowFunction | MethodDeclaration | MethodSignature | ... 16 more ... | VariableStatement, fmxScope: Famix.NamedEntity): void ++processComment(c: CommentRange, fmxScope: Famix.NamedEntity): Famix.Comment ++processAccesses(accessMap: Map): void ++processNodeForAccesses(n: Identifier, id: number): void ++processImportClausesForImportEqualsDeclarations(sourceFiles: SourceFile[], exports: ReadonlyMap[]): void ++processImportClausesForModules(modules: SourceFile[], exports: ReadonlyMap[]): void ++isInExports(exports: ReadonlyMap[], importedEntityName: string): boolean ++processInheritances(classes: ClassDeclaration[], interfaces: InterfaceDeclaration[]): void ++processInvocations(methodsAndFunctionsWithId: Map): void ++processNodeForInvocations(nodeReferencingInvocable: Identifier, invocable: InvocableType, id: number): void ++processConcretizations(classes: ClassDeclaration[], interfaces: InterfaceDeclaration[], functions: Map): void interface SearchParameters { +searchArray: string[] +targetArray: string[] +start?: number | undefined } ++indexOfSplitArray(params: SearchParameters): number ++getSubTypeName(fmxNamedEntity: Famix.NamedEntity): "Class" | "Interface" | "Function" | "Enum" | "EnumValue" | "Alias" | "Variable" | "Type" | "Method" | "Decorator" | "Accessor" | "Parameter" | "Property" | "NamedEntity" ++computeSignature(text: string): string ++findAncestor(node: Identifier): Node ++findTypeAncestor(element: Node): Node | undefined ++arraysAreEqual(array1: string[], array2: string[]): boolean ++replaceLastBetweenTags(input: string, replacement: string): string class EntityDictionary { +famixRep: FamixRepository -fmxAliasMap: Map @@ -538,7 +602,7 @@ class EntityDictionary { -fmxInterfaceMap: Map -fmxModuleMap: Map -fmxFileMap: Map - -fmxTypeMap: Map + -fmxTypeMap: Map -fmxPrimitiveTypeMap: Map -fmxFunctionAndMethodMap: Map -fmxArrowFunctionMap: Map @@ -562,15 +626,15 @@ class EntityDictionary { +createOrGetFamixInterface(inter: InterfaceDeclaration): Famix.Interface | Famix.ParametricInterface +createOrGetFamixConcreteElement(concreteElement: ParametricVariantType, concreteElementDeclaration: ConcreteElementTSMorphType, concreteArguments: TypeNode[]): ParametricVariantType +createFamixProperty(property: PropertyDeclaration | PropertySignature): Famix.Property - +createOrGetFamixMethod(method: ConstructorDeclaration | MethodSignature | GetAccessorDeclaration | SetAccessorDeclaration | MethodDeclaration, currentCC: { [key: string]: number; }): Famix.Method | Famix.ParametricMethod | Famix.Accessor - +createOrGetFamixFunction(func: FunctionExpression | FunctionDeclaration, currentCC: { [key: string]: number; }): Famix.Function | Famix.ParametricFunction + +createOrGetFamixMethod(method: MethodDeclaration | MethodSignature | ConstructorDeclaration | GetAccessorDeclaration | SetAccessorDeclaration, currentCC: { [key: string]: number; }): Famix.Method | Famix.ParametricMethod | Famix.Accessor + +createOrGetFamixFunction(func: FunctionDeclaration | FunctionExpression, currentCC: { [key: string]: number; }): Famix.Function | Famix.ParametricFunction +createOrGetFamixParameter(param: ParameterDeclaration): Famix.Parameter - +createFamixParameterType(tp: TypeParameterDeclaration): Famix.ParameterType + +createFamixTypeParameter(tp: TypeParameterDeclaration): Famix.TypeParameter +createOrGetFamixVariable(variable: VariableDeclaration): Famix.Variable +createOrGetFamixEntityTyping(entity: Famix.BehavioralEntity | Famix.StructuralEntity, type: Famix.Type): Famix.EntityTyping +createOrGetFamixEnum(enumEntity: EnumDeclaration): Famix.Enum +createFamixEnumValue(enumMember: EnumMember): Famix.EnumValue - +createOrGetFamixDecorator(decorator: Decorator, decoratedEntity: PropertyDeclaration | GetAccessorDeclaration | SetAccessorDeclaration | ParameterDeclaration | ClassDeclaration | MethodDeclaration): Famix.Decorator + +createOrGetFamixDecorator(decorator: Decorator, decoratedEntity: MethodDeclaration | PropertyDeclaration | GetAccessorDeclaration | SetAccessorDeclaration | ParameterDeclaration | ClassDeclaration): Famix.Decorator +createFamixComment(comment: CommentRange, fmxScope: Famix.NamedEntity, isJSDoc: boolean): Famix.Comment +createOrGetFamixType(typeNameArg: string, tsMorphType: Type | undefined, element: TSMorphTypeDeclaration): Famix.Type +createOrGetFamixParametricType(typeName: string, element: TSMorphParametricType): Famix.Type @@ -587,11 +651,17 @@ class EntityDictionary { +createFamixParameterConcretization(concretization: Famix.Concretization): Famix.ParameterConcretization | undefined +createFamixConcretizationClassOrInterfaceSpecialisation(element: ClassDeclaration | InterfaceDeclaration): void +createFamixConcretizationGenericInstantiation(cls: ClassDeclaration): void - +createFamixConcretizationFunctionInstantiation(element: FunctionDeclaration | MethodDeclaration): void + +createFamixConcretizationFunctionInstantiation(element: MethodDeclaration | FunctionDeclaration): void +createFamixConcretizationInterfaceClass(cls: ClassDeclaration): void +createFamixConcretizationTypeInstanciation(element: ClassDeclaration | InterfaceDeclaration): void +convertToRelativePath(absolutePath: string, absolutePathProject: string): string } ++isPrimitiveType(typeName: string): boolean ++initFQN(sourceElement: TSMorphObjectType, famixElement: Famix.SourcedEntity): void ++isTypeContext(sourceElement: TSMorphObjectType): boolean ++getInterfaceOrClassDeclarationFromExpression(expression: ExpressionWithTypeArguments): ClassDeclaration | InterfaceDeclaration | undefined ++resolveSymbolToInterfaceOrClassDeclaration(symbol: TSMorphSymbol): ClassDeclaration | InterfaceDeclaration | undefined ++getPrimitiveTypeName(type: Type): string | undefined class FamixRepository { -elements: Set -famixClasses: Set @@ -637,6 +707,7 @@ class FamixRepository { +removeEntitiesBySourceFile(sourceFile: string): FamixBaseElement[] +removeRelatedAssociations(entities: FamixBaseElement[]): void } ++convertToRelativePath(absolutePath: string, absolutePathProject: string): string enum SourceFileChangeType { Create Update @@ -651,6 +722,7 @@ class Importer { +updateFamixModelIncrementally(sourceFileChangeMap: Map): void -processReferences(sourceFiles: SourceFile[], allExistingSourceFiles: SourceFile[]): void } ++initFamixRep(project: Project): void abstract class FamixBaseElement { +id: number +{abstract} getJSON(): string diff --git a/package.json b/package.json index 2cb5d92a..7c44daf6 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,7 @@ "refresh": "rm -rf ./node_modules ./package-lock.json && npm install", "doc": "typedoc && touch docs/.gitkeep", "coverage": "jest --colors --silent --coverage --coverageDirectory=coverage", - "uml": "tplant -i \"src/lib/famix/**/*.ts\" -o doc-metamodel/famix-typescript-model.puml && node -e \"const fs = require('fs'); const f = 'doc-metamodel/famix-typescript-model.puml'; fs.writeFileSync(f, fs.readFileSync(f, 'utf8').replace('@startuml', '@startuml metamodel'));\"" + "uml": "tplant -i \"src/lib/famix/**/*.ts\" -o doc-uml/famix-typescript-model.puml && node -e \"const fs = require('fs'); const f = 'doc-uml/famix-typescript-model.puml'; fs.writeFileSync(f, fs.readFileSync(f, 'utf8').replace('@startuml', '@startuml metamodel'));\"" }, "bin": { "ts2famix": "dist/ts2famix-cli-wrapper.js" From 8cfa30ae1e7513302ca9a05882dfcba2849ae7a0 Mon Sep 17 00:00:00 2001 From: "C. Fuhrman" Date: Fri, 18 Sep 2026 19:42:23 -0400 Subject: [PATCH 09/11] Run same command for generating UML diagrams in workflow as in package.json --- .github/workflows/generateUml.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/generateUml.yml b/.github/workflows/generateUml.yml index 89080702..69bc2755 100644 --- a/.github/workflows/generateUml.yml +++ b/.github/workflows/generateUml.yml @@ -28,7 +28,7 @@ jobs: run: npm install -g tplant@3.1.0 - name: Generate PlantUML class diagram from source - run: tplant -i src/lib/famix/**/*.ts -o doc-uml/famix-typescript-model.puml + run: npm run uml - name: Check for changes in UML diagrams id: check_changes From 64386dcc06bbd1db92ba718b5c74d1be473975f5 Mon Sep 17 00:00:00 2001 From: "C. Fuhrman" Date: Fri, 18 Sep 2026 19:45:04 -0400 Subject: [PATCH 10/11] difference in puml (testing Action to fail) --- doc-uml/famix-typescript-model.puml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc-uml/famix-typescript-model.puml b/doc-uml/famix-typescript-model.puml index 3a63df51..197e10c1 100644 --- a/doc-uml/famix-typescript-model.puml +++ b/doc-uml/famix-typescript-model.puml @@ -1,4 +1,4 @@ -@startuml metamodel +@startuml class FamixJSONExporter { -element: FamixBaseElement -bufferArray: any @@ -728,4 +728,4 @@ abstract class FamixBaseElement { +{abstract} getJSON(): string +addPropertiesToExporter(exporter: FamixJSONExporter): void } -@enduml \ No newline at end of file +@enduml From a894f814df74b9ad9ee61977aa75c7e6cbbc0fe5 Mon Sep 17 00:00:00 2001 From: "C. Fuhrman" Date: Fri, 18 Sep 2026 19:47:09 -0400 Subject: [PATCH 11/11] update docs --- doc-uml/famix-typescript-model.puml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc-uml/famix-typescript-model.puml b/doc-uml/famix-typescript-model.puml index 197e10c1..3a63df51 100644 --- a/doc-uml/famix-typescript-model.puml +++ b/doc-uml/famix-typescript-model.puml @@ -1,4 +1,4 @@ -@startuml +@startuml metamodel class FamixJSONExporter { -element: FamixBaseElement -bufferArray: any @@ -728,4 +728,4 @@ abstract class FamixBaseElement { +{abstract} getJSON(): string +addPropertiesToExporter(exporter: FamixJSONExporter): void } -@enduml +@enduml \ No newline at end of file