Various JSDoc + type checking fixes (for v4.4.0 only) #2997
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-pr-2997
src/govuk/components/character-count/character-count.unit.test.mjs
Outdated
Show resolved
Hide resolved
As identified by the `tsc` TypeScript compiler
colinrotherham
force-pushed
the
fix-types-i18n
branch
from
0a679b8
to
a856000
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-pr-2997
colinrotherham
force-pushed
the
fix-types-i18n
branch
from
a856000
to
c2b9130
Compare
|
@romaricpascal Think we're all sorted now I forgot we also accept So I've had to link to the JSDoc config |
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-pr-2997
colinrotherham
commented
Nov 10, 2022
| @@ -10,5 +10,8 @@ module.exports = { | |||
| source: { | |||
| includePattern: '.+\\.m?js$', | |||
| excludePattern: '.+\\.test.m?js$' | |||
| }, | |||
| templates: { | |||
| cleverLinks: true | |||
There was a problem hiding this comment.
I've not used @see or @link yet to other areas of the code but we're ready for it now
Comment on lines
+101
to
+111
| /** | ||
| * Config for all components | ||
| * | ||
| * @typedef {object} Config | ||
| * @property {HTMLElement} [scope=document] - Scope to query for components | ||
| * @property {import('./components/accordion/accordion.mjs').AccordionConfig} [accordion] - Accordion config | ||
| * @property {import('./components/button/button.mjs').ButtonConfig} [button] - Button config | ||
| * @property {import('./components/character-count/character-count.mjs').CharacterCountConfig} [characterCount] - Character Count config | ||
| * @property {import('./components/error-summary/error-summary.mjs').ErrorSummaryConfig} [errorSummary] - Error Summary config | ||
| * @property {import('./components/notification-banner/notification-banner.mjs').NotificationBannerConfig} [notificationBanner] - Notification Banner config | ||
| */ |
There was a problem hiding this comment.
Oh yeah, we were so focused on the individual components that all was completely neglected 😬 Good spot! 🙌🏻
| @@ -31,13 +31,11 @@ var TRANSLATIONS_DEFAULT = { | |||
| * | |||
| * @class | |||
| * @param {HTMLElement} $module - HTML element to use for accordion | |||
| * @param {object} config - Accordion config | |||
| * @param {AccordionTranslations} config.i18n - Translations | |||
| * @param {AccordionTranslations} [config] - Accordion config | |||
There was a problem hiding this comment.
Suggested change
| * @param {AccordionTranslations} [config] - Accordion config | |
| * @param {AccordionConfig} [config] - Accordion config |
There was a problem hiding this comment.
Brilliant spot. All fixed and ready for you again 😊
See: #2921 Whilst `other` is required in English and is used as a fallback, it won’t be in all locales
colinrotherham
force-pushed
the
fix-types-i18n
branch
from
c2b9130
to
a80ecde
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-pr-2997
|
See the generated JSDoc config served by the review app |
This was referenced Dec 15, 2022
11 tasks
colinrotherham
added
🐛 bug
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes various JSDoc (and related code) issues identified in #2971
Including things like:
configparam are optionalplural formother` is optional (with caveats)i18n.${lookupKey}translation usage removedconfig.maxlengthandconfig.maxwordsare mutually exclusiveAll working fab here.
Screenshot showing
wordsUnderLimit(string) not matching the TranslationPluralForms (object) JSDoc type