Skip to content

model refinements #50

@BioPhoton

Description

@BioPhoton

I see a couple of potential flaws in the current data structure the we should address.

  • The type RunnerOutput seems odd and I feel we should restructure the data to just and array of audit Output's and the name should be AuditOutput
  • At the moment not all meta informations are included in the report.
    The missing informations are:
    • plugin.meta
    • categories => should contain metadata
  • The naming could get more aligned
    • use xConfig for the different top level props in CoreConfig
    • use xMeta for all metaInformation and store it under a property called meta
      • use it for CoreConfig
      • use it for PluginConfig
        • is missing description to align with AuditMeatdata
      • use it for AuditMetadata
        • we should rename title to name to align with PluginConfig.meta.name
      • AuditGroup does not contain meta information => it should
    • use xOutput for the different results from a plugin execution
    • use xReport for data structures living in Report
    • remove label
    • always use title instead of name
  • To generate reports the configuration is needed. This tightly couples the report with the content of the code-pushup.config.js file at the time of execution. The report should be interpretable independent of the core config

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions