build: use a different dprint config for messages files to allow longer lines

Author: bradenmacdonald

dprint.json

@@ -27,7 +27,8 @@
     "jest.config.js",
     "env.config.*",
     "example.env.config.*",
-    "module.config.js"
+    "module.config.js",
+    "src/**/messages.{ts,js}"
   ],
   "plugins": [
     "https://plugins.dprint.dev/typescript-0.95.15.wasm",

dprint.messages.json

@@ -0,0 +1,10 @@
+{
+  // For messages files, we allow unlimited line length, to keep the file format consistent.
+  // For now a separate file is required, but this could be simplified when
+  // https://github.com/dprint/dprint/issues/996 is implemented or if we change to a different formatter.
+  "extends": "dprint.json",
+  "lineWidth": 10000,
+  "includes": ["src/**/messages.{ts,js}"]
+  // Because this inherits "excludes" from "dprint.json", it's necessary to use "--excludes-override none"
+  // to run this on the command line.
+}

package.json

@@ -13,8 +13,8 @@
     "build": "fedx-scripts webpack",
     "i18n_extract": "fedx-scripts formatjs extract --include=plugins",
     "stylelint": "stylelint \"plugins/**/*.scss\" \"src/**/*.scss\" \"scss/**/*.scss\" --config .stylelintrc.json",
-    "lint": "dprint check && oxlint --type-aware --deny-warnings && npm run stylelint",
-    "lint:fix": "dprint fmt && oxlint --type-aware --fix",
+    "lint": "dprint check && dprint --config dprint.messages.json check --excludes-override none && oxlint --type-aware --deny-warnings && npm run stylelint",
+    "lint:fix": "dprint fmt && dprint --config dprint.messages.json fmt --excludes-override none && oxlint --type-aware --fix",
     "start": "fedx-scripts webpack-dev-server --progress",
     "start:with-theme": "paragon install-theme && npm start && npm install",
     "dev": "PUBLIC_PATH=/authoring/ MFE_CONFIG_API_URL='http://localhost:8000/api/mfe_config/v1' fedx-scripts webpack-dev-server --progress --host apps.local.openedx.io",

src/accessibility-page/AccessibilityBody/messages.ts

@@ -13,8 +13,7 @@ const messages = defineMessages({
   },
   a11yBodyIntroGraph: {
     id: 'a11yBodyIntroGraph',
-    defaultMessage:
-      `At edX, we seek to understand and respect the unique needs and perspectives of the edX global community.
+    defaultMessage: `At edX, we seek to understand and respect the unique needs and perspectives of the edX global community.
       We value every course team and are committed to expanding access to all, including course team creators and authors with
       disabilities. To that end, we have adopted a {communityAccessibilityLink} and this process to allow course team creators
       and authors to request assistance if they are unable to develop and post content on our platform via Studio because of their
@@ -28,32 +27,27 @@ const messages = defineMessages({
   },
   a11yBodyEdxResponse: {
     id: 'a11yBodyEdxResponse',
-    defaultMessage:
-      `'We will communicate with you about your preferences and needs in determining the appropriate solution, although
+    defaultMessage: `'We will communicate with you about your preferences and needs in determining the appropriate solution, although
       the ultimate decision will be ours, provided that the solution is effective and timely. The factors we will consider in choosing
       an accessibility solution are: effectiveness; timeliness (relative to your deadlines); ease of implementation; and ease of use for
       you. We will notify you of the decision and explain the basis for our decision within 10 business days of discussing with you.`,
     description: 'Paragraph outlining how we will select an accessibility solution.',
   },
   a11yBodyEdxFollowUp: {
     id: 'a11yBodyEdxFollowUp',
-    defaultMessage:
-      `Thereafter, we will communicate with you on a weekly basis regarding our evaluation, decision, and progress in
+    defaultMessage: `Thereafter, we will communicate with you on a weekly basis regarding our evaluation, decision, and progress in
       implementing the accessibility solution. We will notify you when implementation of your accessibility solution is complete and
       will follow-up with you as may be necessary to see if the solution was effective.`,
-    description:
-      'Paragraph outlining how we will follow-up with you during and after implementing an accessibility solution.',
+    description: 'Paragraph outlining how we will follow-up with you during and after implementing an accessibility solution.',
   },
   a11yBodyOngoingSupport: {
     id: 'a11yBodyOngoingSupport',
-    defaultMessage:
-      'EdX will provide ongoing technical support as needed and will address any additional issues that arise after the initial course creation.',
+    defaultMessage: 'EdX will provide ongoing technical support as needed and will address any additional issues that arise after the initial course creation.',
     description: 'A statement of ongoing support.',
   },
   a11yBodyA11yFeedback: {
     id: 'a11yBodyA11yFeedback',
-    defaultMessage:
-      'Please direct any questions or suggestions on how to improve the accessibility of Studio to {emailElement} or use the form below. We welcome your feedback.',
+    defaultMessage: 'Please direct any questions or suggestions on how to improve the accessibility of Studio to {emailElement} or use the form below. We welcome your feedback.',
     description: 'Contact information heading for those with accessibility issues or suggestions.',
   },
   a11yBodyEmailHeading: {
@@ -78,39 +72,33 @@ const messages = defineMessages({
   },
   a11yBodyTimeConstraints: {
     id: 'a11yBodyTimeConstraints',
-    defaultMessage:
-      'how soon you need access and for how long (e.g., a planned course start date or in connection with a course-related deadline such as a final essay).',
+    defaultMessage: 'how soon you need access and for how long (e.g., a planned course start date or in connection with a course-related deadline such as a final essay).',
     description: 'Time contstraint information.',
   },
   a11yBodyReceipt: {
     id: 'a11yBodyReceipt',
-    defaultMessage:
-      'The edX Support Team will respond to confirm receipt and forward your request to the edX Partner Manager for your institution and the edX Website Accessibility Specialist.',
+    defaultMessage: 'The edX Support Team will respond to confirm receipt and forward your request to the edX Partner Manager for your institution and the edX Website Accessibility Specialist.',
     description: 'Paragraph outlining what steps edX will take immediately.',
   },
   a11yBodyExtraInfo: {
     id: 'a11yBodyExtraInfo',
-    defaultMessage:
-      `With guidance from the Website Accessibility Specialist, edX will contact you to discuss your request and gather
+    defaultMessage: `With guidance from the Website Accessibility Specialist, edX will contact you to discuss your request and gather
       additional information from you about your preferences and needs, to determine if there's a workable solution that edX is able to support.`,
     description: 'Paragraph outlining how and when edX will reach out to you.',
   },
   a11yBodyFixesListHeader: {
     id: 'a11yBodyFixesListHeader',
-    defaultMessage:
-      'EdX will assist you promptly and thoroughly so that you are able to create content on the CMS within your time constraints.  Such efforts may include, but are not limited to:',
+    defaultMessage: 'EdX will assist you promptly and thoroughly so that you are able to create content on the CMS within your time constraints.  Such efforts may include, but are not limited to:',
     description: 'Heading for list of ways we might be able to assist.',
   },
   a11yBodyThirdParty: {
     id: 'a11yBodyThirdParty',
-    defaultMessage:
-      'Purchasing a third-party tool or software for use on an individual basis to assist your use of Studio;',
+    defaultMessage: 'Purchasing a third-party tool or software for use on an individual basis to assist your use of Studio;',
     description: 'Buy third-party software.',
   },
   a11yBodyContractor: {
     id: 'a11yBodyContractor',
-    defaultMessage:
-      'Engaging a trained independent contractor to provide real-time visual, verbal and physical assistance; or',
+    defaultMessage: 'Engaging a trained independent contractor to provide real-time visual, verbal and physical assistance; or',
     description: 'Hire a contractor.',
   },
   a11yBodyCodeFix: {

src/accessibility-page/AccessibilityForm/messages.ts

@@ -8,8 +8,7 @@ const messages = defineMessages({
   },
   accessibilityPolicyFormErrorHighVolume: {
     id: 'accessibilityPolicyFormErrorHighVolume',
-    defaultMessage:
-      'We are currently experiencing high volume. Try again later today or send an email message to {emailLink}.',
+    defaultMessage: 'We are currently experiencing high volume. Try again later today or send an email message to {emailLink}.',
     description: 'Error message when site is experiencing high volume that will include an email link',
   },
   accessibilityPolicyFormErrorMissingFields: {
@@ -54,8 +53,7 @@ const messages = defineMessages({
   },
   accessibilityPolicyFormSuccessDetails: {
     id: 'accessibilityPolicyFormSuccessDetails',
-    defaultMessage:
-      'Thank you for your feedback regarding the accessibility of Studio. We typically respond within one business day ({day_start} to {day_end}, {time_start} to {time_end}).',
+    defaultMessage: 'Thank you for your feedback regarding the accessibility of Studio. We typically respond within one business day ({day_start} to {day_end}, {time_start} to {time_end}).',
     description: 'Detailed thank you message when form submission is successful',
   },
   accessibilityPolicyFormValidEmail: {

src/advanced-settings/messages.ts

@@ -19,17 +19,15 @@ const messages = defineMessages({
   },
   alertWarningDescriptions: {
     id: 'course-authoring.advanced-settings.alert.warning.descriptions',
-    defaultMessage:
-      'Your changes will not take effect until you save your progress. Take care with key and value formatting, as validation is not implemented.',
+    defaultMessage: 'Your changes will not take effect until you save your progress. Take care with key and value formatting, as validation is not implemented.',
   },
   alertSuccess: {
     id: 'course-authoring.advanced-settings.alert.success',
     defaultMessage: 'Your policy changes have been saved.',
   },
   alertSuccessDescriptions: {
     id: 'course-authoring.advanced-settings.alert.success.descriptions',
-    defaultMessage:
-      'No validation is performed on policy keys or value pairs. If you are having difficulties, check your formatting.',
+    defaultMessage: 'No validation is performed on policy keys or value pairs. If you are having difficulties, check your formatting.',
   },
   alertProctoringError: {
     id: 'course-authoring.advanced-settings.alert.proctoring.error',

src/advanced-settings/settings-sidebar/messages.ts

@@ -7,13 +7,11 @@ const messages = defineMessages({
   },
   aboutDescription1: {
     id: 'course-authoring.advanced-settings.sidebar.about.description-1',
-    defaultMessage:
-      'Advanced settings control specific course functionality. On this page, you can edit manual policies, which are JSON-based key and value pairs that control specific course settings.',
+    defaultMessage: 'Advanced settings control specific course functionality. On this page, you can edit manual policies, which are JSON-based key and value pairs that control specific course settings.',
   },
   aboutDescription2: {
     id: 'course-authoring.advanced-settings.sidebar.about.description-2',
-    defaultMessage:
-      'Any policies you modify here override all other information you’ve defined elsewhere in Studio. Do not edit policies unless you are familiar with both their purpose and syntax.',
+    defaultMessage: 'Any policies you modify here override all other information you’ve defined elsewhere in Studio. Do not edit policies unless you are familiar with both their purpose and syntax.',
   },
   other: {
     id: 'course-authoring.advanced-settings.sidebar.other.title',

src/certificates/certificate-details/messages.ts

@@ -18,8 +18,7 @@ const messages = defineMessages({
   },
   detailsCourseTitleOverrideDescription: {
     id: 'course-authoring.certificates.details.course.title.override.description',
-    defaultMessage:
-      'Specify an alternative to the official course title to display on certificates. Leave blank to use the official course title.',
+    defaultMessage: 'Specify an alternative to the official course title to display on certificates. Leave blank to use the official course title.',
     description: 'Helper text under the course title override input field',
   },
   detailsCourseNumber: {
@@ -45,15 +44,12 @@ const messages = defineMessages({
   editCertificateConfirmationTitle: {
     id: 'course-authoring.certificates.details.confirm.edit',
     defaultMessage: 'Edit this certificate?',
-    description:
-      'Title for the confirmation modal when a user attempts to edit an already activated (live) certificate',
+    description: 'Title for the confirmation modal when a user attempts to edit an already activated (live) certificate',
   },
   editCertificateMessage: {
     id: 'course-authoring.certificates.details.confirm.edit.message',
-    defaultMessage:
-      'This certificate has already been activated and is live. Are you sure you want to continue editing?',
-    description:
-      'Message warning users about the implications of editing a certificate that is already live, prompting for confirmation',
+    defaultMessage: 'This certificate has already been activated and is live. Are you sure you want to continue editing?',
+    description: 'Message warning users about the implications of editing a certificate that is already live, prompting for confirmation',
   },
 });
 

src/certificates/certificate-signatories/messages.ts

@@ -8,10 +8,8 @@ const messages = defineMessages({
   },
   signatoriesRecommendation: {
     id: 'course-authoring.certificates.signatories.recommendation',
-    defaultMessage:
-      'It is strongly recommended that you include four or fewer signatories. If you include additional signatories, preview the certificate in Print View to ensure the certificate will print correctly on one page.',
-    description:
-      'A recommendation for the number of signatories to include on a certificate, emphasizing the importance of testing the print layout',
+    defaultMessage: 'It is strongly recommended that you include four or fewer signatories. If you include additional signatories, preview the certificate in Print View to ensure the certificate will print correctly on one page.',
+    description: 'A recommendation for the number of signatories to include on a certificate, emphasizing the importance of testing the print layout',
   },
   signatoriesSectionTitle: {
     id: 'course-authoring.certificates.signatories.section.title',
@@ -55,8 +53,7 @@ const messages = defineMessages({
   },
   titleDescription: {
     id: 'course-authoring.certificates.signatories.title.description',
-    defaultMessage:
-      'Titles more than 100 characters may prevent students from printing their certificate on a single page.',
+    defaultMessage: 'Titles more than 100 characters may prevent students from printing their certificate on a single page.',
     description: 'Helper text under the title input field',
   },
   organizationLabel: {
@@ -107,8 +104,7 @@ const messages = defineMessages({
   deleteSignatoryConfirmation: {
     id: 'course-authoring.certificates.signatories.confirm-modal',
     defaultMessage: 'Delete "{name}" from the list of signatories?',
-    description:
-      'Title for the confirmation modal when a user attempts to delete a signatory, where "{name}" is the name of the signatory to be deleted',
+    description: 'Title for the confirmation modal when a user attempts to delete a signatory, where "{name}" is the name of the signatory to be deleted',
   },
   deleteSignatoryConfirmationMessage: {
     id: 'course-authoring.certificates.signatories.confirm-modal.message',

src/certificates/layout/certificates-sidebar/messages.ts

@@ -8,14 +8,12 @@ const messages = defineMessages({
   },
   workingWithCertificatesFirstParagraph: {
     id: 'course-authoring.certificates.sidebar.working-with-certificates.first-paragraph',
-    defaultMessage:
-      'Specify a course title to use on the certificate if the course\'s official title is too long to be displayed well.',
+    defaultMessage: 'Specify a course title to use on the certificate if the course\'s official title is too long to be displayed well.',
     description: 'Instructions for specifying a course title for the certificate',
   },
   workingWithCertificatesSecondParagraph: {
     id: 'course-authoring.certificates.sidebar.working-with-certificates.second-paragraph',
-    defaultMessage:
-      'For verified certificates, specify between one and four signatories and upload the associated images. To edit or delete a certificate before it is activated, hover over the top right corner of the form and select {strongText} or the delete icon.',
+    defaultMessage: 'For verified certificates, specify between one and four signatories and upload the associated images. To edit or delete a certificate before it is activated, hover over the top right corner of the form and select {strongText} or the delete icon.',
     description: 'Details on how to specify signatories for verified certificates and edit or delete certificates',
   },
   workingWithCertificatesSecondParagraph_strong: {
@@ -40,8 +38,7 @@ const messages = defineMessages({
   },
   issuingCertificatesFirstParagraph: {
     id: 'course-authoring.certificates.sidebar.issuing-certificates.first-paragraph',
-    defaultMessage:
-      'To begin issuing course certificates, a course team member with either the Staff or Admin role selects {strongText}. Only course team members with these roles can edit or delete an activated certificate.',
+    defaultMessage: 'To begin issuing course certificates, a course team member with either the Staff or Admin role selects {strongText}. Only course team members with these roles can edit or delete an activated certificate.',
     description: 'Instructions for issuing course certificates and the roles required to edit or delete certificates',
   },
   issuingCertificatesFirstParagraph_strong: {
@@ -51,8 +48,7 @@ const messages = defineMessages({
   },
   issuingCertificatesSecondParagraph: {
     id: 'course-authoring.certificates.sidebar.issuing-certificates.second-paragraph',
-    defaultMessage:
-      '{strongText} delete certificates after a course has started; learners who have already earned certificates will no longer be able to access them.',
+    defaultMessage: '{strongText} delete certificates after a course has started; learners who have already earned certificates will no longer be able to access them.',
     description: 'A warning against deleting certificates once a course has started, noting the impact on learners',
   },
   issuingCertificatesSecondParagraph_strong: {