Skip to content

Improve Management of Static Hyperlinks in Warning Messages #238

@Dragos0000

Description

@Dragos0000

Issue Description

Currently, hyperlinks to the SEMIC Style Guide are statically embedded in the messages within the code for each checking rule.

For example:

f:generateWarningMessage(fn:concat(
    'The stereotype applied to ', f:getConnectorName($connector),
    'is not known and will be ignored. '),
    path($connector),
    'connector-stereotype-9',
    'CMC-R17',
    '<a href="https://semiceu.github.io/style-guide/1.0.0/gc-conceptual-model-conventions.html#sec:cmc-r17" target="_blank">CMC-R17</a>'
)

The hyperlink to the style guide is repeated across rules, making it static and difficult to update if the URL changes (e.g., if the style guide version changes from 1.0.0 to 2.0.0).

Proposed Solution

Introduce a configuration variable (styleGuideBaseUrl) to hold the base URL of the SEMIC Style Guide. This variable can be referenced in the code to dynamically generate hyperlinks to the checking rules.

Example:

f:generateWarningMessage(fn:concat(
    'The stereotype applied to ', f:getConnectorName($connector),
    'is not known and will be ignored. '),
    path($connector),
    'connector-stereotype-9',
    'CMC-R17',
    fn:concat($styleGuideBaseUrl, 'gc-conceptual-model-conventions.html#sec:cmc-r17')
)

Metadata

Metadata

Assignees

Labels

type: feature requestsomething requested to be implemented in a future release

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions