Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(models): refine data structure #55

Merged
merged 32 commits into from
Sep 22, 2023
Merged

refactor(models): refine data structure #55

merged 32 commits into from
Sep 22, 2023

Conversation

BioPhoton
Copy link
Collaborator

@BioPhoton BioPhoton commented Sep 19, 2023

This PR includes:

  • Replaced RunnerOutput schema object with AuditOutput array
// before
type RunnerOutput = {
  audits: AuditOutputSchema[]
}

// after
type AuditOutputsSchema
  • Introduce reusable schema for date and duration
  • Renamed name to title in plugin metadata to align with audit metadata
  • Introduce reusable schema for meta information and use it in audit and plugin
// shared meta
type MetaInformation {
  slug: string,
  title: string,
  description?: string,
  docsUrl?: string
}
  • Rename AuditMetadata to Audit
  • Remove slug from metaSchema
  • Add metaSchema to CategoryConfig
  • Add metaSchema to AuditGroup
  • Flatten PluginConfig#meta information into PluginConfig
  • Remove label from all meat information
  • Add meta info to AuditOutput
  • Add meta info to PluginOutput
  • Make report independent from config
    • Add categories to report
    • refactor report to MD
    • refactor report to stdout

closes #50

matejchalk
matejchalk previously approved these changes Sep 20, 2023
Copy link
Collaborator

@matejchalk matejchalk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice improvement 👍

vmasek
vmasek previously approved these changes Sep 20, 2023
@BioPhoton BioPhoton dismissed stale reviews from vmasek and matejchalk via ca5ce03 September 21, 2023 02:07
matejchalk
matejchalk previously approved these changes Sep 21, 2023
@BioPhoton BioPhoton merged commit f94933b into main Sep 22, 2023
@BioPhoton BioPhoton deleted the refine-models-1 branch September 22, 2023 15:56
@BioPhoton BioPhoton mentioned this pull request Oct 18, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

model refinements
3 participants