docs(spelling): Add codespell config + github action, run and fix a good number of typos (#3645)

extensions/cornerstone-dicom-sr/src/index.tsx

@@ -54,7 +54,7 @@ const dicomSRExtension = {
   },
   getCommandsModule,
   getSopClassHandlerModule,
-  // Include dynmically computed values such as toolNames not known till instantiation
+  // Include dynamically computed values such as toolNames not known till instantiation
   getUtilityModule({ servicesManager }) {
     return [
       {

extensions/cornerstone-dicom-sr/src/utils/findMostRecentStructuredReport.js

@@ -44,7 +44,7 @@ const isStructuredReportSeries = series => {
 };
 
 /**
- *  Checkes if series1 is newer than series2
+ *  Checks if series1 is newer than series2
  *
  * @param {Object} series1 - Series Metadata 1
  * @param {Object} series2 - Series Metadata 2

extensions/cornerstone/src/Viewport/Overlays/utils.ts

@@ -75,7 +75,7 @@ export function formatPN(name) {
  * Gets compression type
  *
  * @param {number} imageId
- * @returns {string} comrpession type.
+ * @returns {string} compression type.
  */
 export function getCompression(imageId) {
   const generalImageModule = metaData.get('generalImageModule', imageId) || {};

extensions/cornerstone/src/state.ts

@@ -19,7 +19,7 @@ const setEnabledElement = (viewportId: string, element: HTMLElement, context?: s
 };
 
 /**
- * Grabs the enabled element `dom` reference of an ative viewport.
+ * Grabs the enabled element `dom` reference of an active viewport.
  *
  * @return {HTMLElement} Active viewport element.
  */

extensions/cornerstone/src/utils/getInterleavedFrames.js

@@ -30,7 +30,7 @@ export default function getInterleavedFrames(imageIds) {
     !prefetchQueuedFilled.currentPositionUpToMaximum
   ) {
     if (!prefetchQueuedFilled.currentPositionDownToMinimum) {
-      // Add imageId bellow
+      // Add imageId below
       lowerImageIdIndex--;
       imageIdsToPrefetch.push({
         imageId: imageIds[lowerImageIdIndex],

extensions/default/src/CustomizableContextMenu/ContextMenuController.tsx

@@ -69,8 +69,8 @@ export default class ContextMenuController {
       event,
       content: ContextMenu,
 
-      // This naming is part of hte uiDialogService convention
-      // Clicking outside simpy closes the dialog box.
+      // This naming is part of the uiDialogService convention
+      // Clicking outside simply closes the dialog box.
       onClickOutside: () => this.services.uiDialogService.dismiss({ id: 'context-menu' }),
 
       contentProps: {

extensions/default/src/CustomizableContextMenu/types.ts

@@ -5,7 +5,7 @@ import { Types } from '@ohif/core';
  * menu item for display.
  * An instance of SelectorProps is provided to the selector functions, which
  * return true to include the item or false to exclude it.
- * The point of this is to allow more specific conext menus which hide
+ * The point of this is to allow more specific context menus which hide
  * non-relevant menu options, optimizing the speed of selection of menus
  */
 export interface SelectorProps {
@@ -69,7 +69,7 @@ export interface MenuItem {
   // or more importantly, if the delegating subMenu will be included.
   selector?: (props: SelectorProps) => boolean;
 
-  /** Adapts the item by filling in additional properties as requried */
+  /** Adapts the item by filling in additional properties as required */
   adaptItem?: (item: MenuItem, props: ContextMenuProps) => UIMenuItem;
 
   /** List of commands to run when this item's action is taken. */

extensions/default/src/DicomWebDataSource/index.js

@@ -343,7 +343,7 @@ function createDicomWebApi(dicomWebConfig, userAuthenticationService) {
       const addRetrieveBulkData = instance => {
         const naturalized = naturalizeDataset(instance);
 
-        // if we konw the server doesn't use bulkDataURI, then don't
+        // if we know the server doesn't use bulkDataURI, then don't
         if (!dicomWebConfig.bulkDataURI?.enabled) {
           return naturalized;
         }

extensions/default/src/DicomWebDataSource/retrieveStudyMetadata.js

@@ -9,7 +9,7 @@ const StudyMetaDataPromises = new Map();
  *
  * @param {Object} server Object with server configuration parameters
  * @param {string} StudyInstanceUID The UID of the Study to be retrieved
- * @param {boolean} enabledStudyLazyLoad Whether the study metadata should be loaded asynchronusly.
+ * @param {boolean} enabledStudyLazyLoad Whether the study metadata should be loaded asynchronously.
  * @param {function} storeInstancesCallback A callback used to store the retrieved instance metadata.
  * @param {Object} [filters] - Object containing filters to be applied on retrieve metadata process
  * @param {string} [filter.seriesInstanceUID] - series instance uid to filter results against

extensions/default/src/Panels/PanelMeasurementTable.tsx

@@ -99,7 +99,7 @@ export default function PanelMeasurementTable({
           ? 'Research Derived Series' // default
           : promptResult.value; // provided value
 
-      // Re-use an existing series having the same series description to avoid
+      // Reuse an existing series having the same series description to avoid
       // creating too many series instances.
       const options = findSRWithSameSeriesDescription(SeriesDescription, displaySetService);
 
@@ -236,7 +236,7 @@ function _getMappedMeasurements(measurementService) {
 
 /**
  * Map the measurements to the display text.
- * Adds finding and site inforamtion to the displayText and/or label,
+ * Adds finding and site information to the displayText and/or label,
  * and provides as 'displayText' and 'label', while providing the original
  * values as baseDisplayText and baseLabel
  */

extensions/default/src/commandsModule.ts

@@ -182,7 +182,7 @@ const commandsModule = ({
           stateSyncReduce;
 
         if (!protocolId) {
-          // Re-use the previous protocol id, and optionally stage
+          // Reuse the previous protocol id, and optionally stage
           protocolId = hpInfo.protocolId;
           if (stageId === undefined && stageIndex === undefined) {
             stageIndex = hpInfo.stageIndex;

extensions/default/src/findViewportsByPosition.ts

@@ -3,7 +3,7 @@ import { StateSyncService } from '@ohif/core';
 /**
  * This find or create viewport is paired with the reduce results from
  * below, and the action of this viewport is to look for previously filled
- * viewports, and to re-use by position id.  If there is no filled viewport,
+ * viewports, and to reuse by position id.  If there is no filled viewport,
  * then one can be re-used from the display set if it isn't going to be displayed.
  * @param hangingProtocolService - bound parameter supplied before using this
  * @param viewportsByPosition - bound parameter supplied before using this

extensions/dicom-microscopy/src/DicomMicroscopySRSopClassHandler.js

@@ -42,7 +42,7 @@ function _getDisplaySetsFromSeries(instances, servicesManager, extensionManager)
   const instance = instances[0];
 
   // TODO ! Consumption of DICOMMicroscopySRSOPClassHandler to a derived dataset or normal dataset?
-  // TOOD -> Easy to swap this to a "non-derived" displaySet, but unfortunately need to put it in a different extension.
+  // TODO -> Easy to swap this to a "non-derived" displaySet, but unfortunately need to put it in a different extension.
   const naturalizedDataset = DicomMetadataStore.getSeries(
     instance.StudyInstanceUID,
     instance.SeriesInstanceUID

extensions/dicom-microscopy/src/components/ViewportOverlay/utils.ts

@@ -78,7 +78,7 @@ export function formatPN(name) {
  * Gets compression type
  *
  * @param {number} imageId
- * @returns {string} comrpession type.
+ * @returns {string} compression type.
  */
 export function getCompression(imageId) {
   const generalImageModule = cornerstone.metaData.get('generalImageModule', imageId) || {};

extensions/dicom-microscopy/src/services/MicroscopyService.ts

@@ -48,7 +48,7 @@ export default class MicroscopyService extends PubSubService {
   }
 
   /**
-   * Cleares all the annotations and managed viewers, setting the manager state
+   * Clears all the annotations and managed viewers, setting the manager state
    * to its initial state
    */
   clear() {
@@ -357,7 +357,7 @@ export default class MicroscopyService extends PubSubService {
 
   /**
    * Removes the given third-party viewer API's object from the managed viewers
-   * and cleares all its event subscriptions
+   * and clears all its event subscriptions
    *
    * @param {Object} viewer Third-party viewer API's object to be removed
    */

extensions/dicom-microscopy/src/tools/viewerManager.js

@@ -109,7 +109,7 @@ class ViewerManager extends PubSubService {
   }
 
   /**
-   * Cleares all the relevant event handlers for the third-party API
+   * Clears all the relevant event handlers for the third-party API
    */
   unregisterEvents() {
     this.container.removeEventListener(ApiEvents.ROI_ADDED, this.onRoiAdded);
@@ -205,7 +205,7 @@ class ViewerManager extends PubSubService {
    * @param {String} label The label of the annotation.
    */
   addRoiGraphicWithLabel(roiGraphic, label) {
-    // NOTE: Dicom Microscopy Viewer will override styles for "Text" evalutations
+    // NOTE: Dicom Microscopy Viewer will override styles for "Text" evaluations
     // to hide all other geometries, we are not going to use its label.
     // if (label) {
     //   if (!roiGraphic.properties) roiGraphic.properties = {};

extensions/dicom-microscopy/src/utils/RoiAnnotation.js

@@ -151,7 +151,7 @@ class RoiAnnotation extends PubSubService {
   /**
    * Returns the geometry type of the annotation concatenated with the label
    * defined for the annotation.
-   * Difference with getDetailedLabel() is that this will return empty string for empy
+   * Difference with getDetailedLabel() is that this will return empty string for empty
    * label.
    *
    * @returns {String} Text with geometry type and label

extensions/dicom-microscopy/src/utils/loadSR.js

@@ -31,7 +31,7 @@ export default async function loadSR(
     // NOTE: When saving Microscopy SR, we are attaching identifier property
     // to each ROI, and when read for display, it is coming in as "TEXT"
     // evaluation.
-    // As the Dicom Microscopy Viewer will override styles for "Text" evalutations
+    // As the Dicom Microscopy Viewer will override styles for "Text" evaluations
     // to hide all other geometries, we are going to manually remove that
     // evaluation item.
     const roi = rois[i];