Author Validation Improvements (#4025)

* feat: set up typed nag (validators) system * feat: start on frontend impl * fix: shouldShow issues * feat: continue work * feat: re add submitting/re-submit nags * feat: start work implementing validation checks using new nag system * fix: links page + add more validations * feat: tags validations * fix: lint issues * fix: lint * fix: issues * feat: start on i18nifying nags * feat: impl intl * fix: minecraft title clause update * fix: locale issues * refactor: inline i18n * fix: summary char min * fix: issues * Rephrase a few core nags * Modify character limit numbers * Remove redundant sentanceEnders check to reduce false positive. * Description nag rephrasing and tweaks * Tweak links nags adding project type checking for source publication check, make description nag tonally consistent. * fix: description nag * bump source publication nag to warn until additional files can be checked. * refactor link checking helper functions, prevent misuse of dsc links, prevent link shortener usage, check if source required licensed projects have additional files, bump this check back to required. * Correct plugin project type checking * fix: lint issues * update links.ts * feat: key + sort nags by type * Tweak core and description nag titles, change image accessability nag logic. * feat: update readme * updates to tags checking and rest of the nag titles * fix locale * fix: formatjs * fix tags warning, and link shorteners and misused discord warnings to link settings page, reword some warnings. * correct vocabulary for resolutions tags warning and sort tags list in resolution tags nag * lint fix * fix method typo * Add nag for summary formatting. * Check for link shorteners in donation links * add Gallery requirement nag for shaders and most resource packs * update index.json --------- Signed-off-by: IMB11 <hendersoncal117@gmail.com> Co-authored-by: Prospector <6166773+Prospector@users.noreply.github.com> Co-authored-by: coolbot100s <76798835+coolbot100s@users.noreply.github.com>
2025-08-13 09:45:13 +01:00
parent 9497ba70a4
commit b279c43069
20 changed files with 2430 additions and 607 deletions
--- a/packages/moderation/types/nags.ts
+++ b/packages/moderation/types/nags.ts
@@ -0,0 +1,96 @@
+import type { Project, User, Version } from '@modrinth/utils'
+import type { MessageDescriptor } from '@vintl/vintl'
+import type { FunctionalComponent, SVGAttributes } from 'vue'
+
+/**
+ * Type which represents the status type of a nag.
+ *
+ * - `required` indicates that the nag must be addressed.
+ * - `warning` indicates that the nag is important but not critical, and can be ignored. It is often used for issues that should be resolved but do not block project submission.
+ * - `suggestion` indicates that the nag is a recommendation and can be ignored.
+ */
+export type NagStatus = 'required' | 'warning' | 'suggestion' | 'special-submit-action'
+
+/**
+ * Interface representing the context in which a nag is displayed.
+ * It includes the project, versions, current member, all members, and the current route.
+ * This context is used to determine whether a nag or it's link should be shown and how it should be presented.
+ */
+export interface NagContext {
+  /**
+   * The project associated with the nag.
+   */
+  project: Project
+  /**
+   * The versions associated with the project.
+   */
+  versions: Version[]
+  /**
+   * The current project member viewing the nag.
+   */
+  currentMember: User
+  /**
+   * The current route in the application.
+   */
+  currentRoute: string
+  /* eslint-disable @typescript-eslint/no-explicit-any */
+  tags: any
+  submitProject: (...any: any) => any
+  /* eslint-enable @typescript-eslint/no-explicit-any */
+}
+
+/**
+ * Interface representing a nag's link.
+ */
+export interface NagLink {
+  /**
+   * A relative path to the nag's link, e.g. '/settings'.
+   */
+  path: string
+  /**
+   * The text to display for the nag's link.
+   */
+  title: MessageDescriptor | string
+  /**
+   * The status of the nag, which can be 'required', 'warning', or 'suggestion'.
+   */
+  shouldShow?: (context: NagContext) => boolean
+}
+
+/**
+ * Interface representing a nag.
+ */
+export interface Nag {
+  /**
+   * A unique identifier for the nag.
+   */
+  id: string
+  /**
+   * The title of the nag.
+   */
+  title: MessageDescriptor | string
+  /**
+   * A function that returns the description of the nag.
+   * It can accept a context to provide dynamic descriptions.
+   */
+  description: MessageDescriptor | ((context: NagContext) => string)
+  /**
+   * The status of the nag, which can be 'required', 'warning', or 'suggestion'.
+   */
+  status: NagStatus
+  /**
+   * An optional icon for the nag, usually from `@modrinth/assets`.
+   * If not specified it will use the default icon associated with the nag status.
+   */
+  icon?: FunctionalComponent<SVGAttributes>
+
+  /**
+   * A function that determines whether the nag should be shown based on the context.
+   */
+  shouldShow: (context: NagContext) => boolean
+  /**
+   * An optional link associated with the nag.
+   * If provided, it should be displayed alongside the nag.
+   */
+  link?: NagLink
+}