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

platform/core/README.md

@@ -42,7 +42,7 @@ implementation][react-viewer].
 
 ### Install
 
-> This library is pre- v1.0. All realeases until a v1.0 have the possibility of
+> This library is pre- v1.0. All releases until a v1.0 have the possibility of
 > introducing breaking changes. Please depend on an "exact" version in your
 > projects to prevent issues caused by loose versioning.
 

platform/core/src/classes/MetadataProvider.js

@@ -498,7 +498,7 @@ const WADO_IMAGE_LOADER_TAGS = {
   OVERLAY_PLANE_MODULE: 'overlayPlaneModule',
   PATIENT_DEMOGRAPHIC_MODULE: 'patientDemographicModule',
 
-  // react-cornerstone-viewport specifc
+  // react-cornerstone-viewport specific
   PATIENT_MODULE: 'patientModule',
   GENERAL_IMAGE_MODULE: 'generalImageModule',
   GENERAL_STUDY_MODULE: 'generalStudyModule',

platform/core/src/services/HangingProtocolService/HangingProtocolService.ts

@@ -362,7 +362,7 @@ export default class HangingProtocolService extends PubSubService {
    * @param params is the dataset to run the hanging protocol on.
    * @param params.activeStudy is the "primary" study to hang  This may or may
    *        not be displayed by the actual viewports.
-   * @param params.studies is the list of studies to hang.  If absent, will re-use the previous set.
+   * @param params.studies is the list of studies to hang.  If absent, will reuse the previous set.
    * @param params.displaySets is the list of display sets associated with
    *        the studies to display in viewports.
    * @param protocol is a specific protocol to apply.

platform/core/src/services/MeasurementService/MeasurementService.ts

@@ -517,7 +517,7 @@ class MeasurementService extends PubSubService {
     };
 
     if (oldMeasurement) {
-      // TODO: Ultimately, each annotation should have a selected flag right from the soure.
+      // TODO: Ultimately, each annotation should have a selected flag right from the source.
       // For now, it is just added in OHIF here and in setMeasurementSelected.
       this.measurements.set(internalUID, newMeasurement);
       if (isUpdate) {

platform/core/src/services/StateSyncService/StateSyncService.ts

@@ -6,7 +6,7 @@ const EVENTS = {};
 type Obj = Record<string, unknown>;
 
 type StateConfig = {
-  /** clearOnModeExit defines state configuraion that is cleared automatically on
+  /** clearOnModeExit defines state configuration that is cleared automatically on
    * exiting a mode.  This clearing occurs after the mode onModeExit,
    * so it is possible to preserve desired state during exit to be restored
    * later.

platform/core/src/services/ToolBarService/ToolbarService.ts

@@ -152,7 +152,7 @@ export default class ToolbarService extends PubSubService {
     //   unsubscribe = commandsManager.runCommand(commandName, commandOptions);
     // }
 
-    // // Storing the unsubscribe for later reseting
+    // // Storing the unsubscribe for later resetting
     // if (unsubscribe && typeof unsubscribe === 'function') {
     //   if (this.unsubscriptions.indexOf(unsubscribe) === -1) {
     //     this.unsubscriptions.push(unsubscribe);

platform/core/src/types/HangingProtocol.ts

@@ -257,7 +257,7 @@ export type ProtocolNotifications = {
  * It is a set of rules about when the protocol can be applied at all,
  * as well as a set of stages that represent indivividual views.
  * Additionally, the display set selectors are used to choose from the existing
- * display sets.  The hanging protcol definition here does NOT allow
+ * display sets.  The hanging protocol definition here does NOT allow
  * redefining the display sets to use, but only selects the views to show.
  */
 export type Protocol = {

platform/core/src/utils/Queue.js

@@ -8,7 +8,7 @@ export default class Queue {
   /**
    * Creates a new "proxy" function associated with the current execution queue
    * instance. When the returned function is invoked, the queue limit is checked
-   * to make sure the limit of scheduled tasks is repected (throwing an
+   * to make sure the limit of scheduled tasks is respected (throwing an
    * exception when the limit has been reached and before calling the original
    * function). The original function is only invoked after all the previously
    * scheduled tasks have finished executing (their returned promises have

platform/core/src/utils/hierarchicalListUtils.js

@@ -36,11 +36,11 @@ function addToList(list, ...values) {
  * once for each leaf-node of the tree. The ancestors of the leaf-node being
  * visited are passed to the callback function along with the leaf-node in
  * the exact same order they appear on the tree (from root to leaf);
- *  @ For example, if the hierachy `a > b > c` appears on the tree ("a" being
+ *  @ For example, if the hierarchy `a > b > c` appears on the tree ("a" being
  *    the root and "c" being the leaf) the callback function will be called as:
  *  callback('a', 'b', 'c');
  * @param {Array} list The hierarchical list to be iterated
- * @param {function} callback The callback which will be exected once for
+ * @param {function} callback The callback which will be executed once for
  *  each leaf-node of the hierarchical list;
  * @returns {Array} Returns the provided list or null for bad arguments;
  */

platform/core/src/utils/objectPath.js

@@ -6,7 +6,7 @@ export class ObjectPath {
    * @param path {String} A string representing the property to be set, e.g. "user.study.series.timepoint".
    * @param value {Any} The value of the property that will be set.
    * @return {Boolean} Returns "true" on success, "false" if any intermediate component of the supplied path
-   * ... is not a valid Object, in which case the property cannot be set. No excpetions are thrown.
+   * ... is not a valid Object, in which case the property cannot be set. No exceptions are thrown.
    */
   static set(object, path, value) {
     let components = ObjectPath.getPathComponents(path),

platform/core/src/utils/progressTrackingUtils.js

@@ -114,7 +114,7 @@ function finish(task) {
 /**
  * Generate a summarized snapshot of the current status of the given task List
  * @param {Object} list The List instance to be scanned
- * @returns {Object} An obeject representing the summarized status of the list
+ * @returns {Object} An object representing the summarized status of the list
  */
 function getOverallProgress(list) {
   const status = createStatus();
@@ -223,7 +223,7 @@ function getTaskByName(list, name) {
  * @param {Object} list The List instance to which the observer will be appended
  * @param {Function} observer The observer (function) that will be executed
  *  every time a change happens within the list
- * @returns {boolean} Returns true on success and false otherewise
+ * @returns {boolean} Returns true on success and false otherwise
  */
 function addObserver(list, observer) {
   if (isList(list) && Array.isArray(list.observers) && typeof observer === 'function') {
@@ -237,7 +237,7 @@ function addObserver(list, observer) {
  * Removes an observer (callback function) from a given List instance
  * @param {Object} list The instance List from which the observer will removed
  * @param {Function} observer The observer function to be removed
- * @returns {boolean} Returns true on success and false otherewise
+ * @returns {boolean} Returns true on success and false otherwise
  */
 function removeObserver(list, observer) {
   if (isList(list) && Array.isArray(list.observers) && list.observers.length > 0) {

platform/core/src/utils/splitComma.ts

@@ -1,4 +1,4 @@
-/** Splits a list of stirngs by commas within the strings */
+/** Splits a list of strings by commas within the strings */
 const splitComma = (strings: string[]): string[] => {
   if (!strings) {
     return null;