fix(app,shared-data): change type name from boolean to bool (#14778)

* fix(app,shared-data): change type name from boolean to bool
Opentrons · May 20, 2024 · c573bcf · c573bcf
1 parent c5ca312
commit c573bcf
Show file tree

Hide file tree

Showing 16 changed files with 35 additions and 35 deletions.
diff --git a/app/src/organisms/ChooseRobotSlideout/__tests__/ChooseRobotSlideout.test.tsx b/app/src/organisms/ChooseRobotSlideout/__tests__/ChooseRobotSlideout.test.tsx
@@ -48,7 +48,7 @@ const mockRunTimeParameters: RunTimeParameter[] = [
     value: false,
     variableName: 'DRYRUN',
     description: 'Is this a dry or wet run? Wet is true, dry is false',
-    type: 'boolean',
+    type: 'bool',
     default: false,
   },
   {
@@ -226,7 +226,7 @@ describe('ChooseRobotSlideout', () => {
       })
 
       screen.getByText(param.displayName)
-      if (param.type === 'boolean' || 'choices' in param) {
+      if (param.type === 'bool' || 'choices' in param) {
         screen.getByText(param.description)
       } else {
         if (param.type === 'int') {

diff --git a/app/src/organisms/ChooseRobotSlideout/index.tsx b/app/src/organisms/ChooseRobotSlideout/index.tsx
@@ -422,7 +422,7 @@ export function ChooseRobotSlideout(
             }}
           />
         )
-      } else if (runtimeParam.type === 'boolean') {
+      } else if (runtimeParam.type === 'bool') {
         return (
           <Flex
             flexDirection={DIRECTION_COLUMN}

diff --git a/app/src/organisms/ChooseRobotToRunProtocolSlideout/index.tsx b/app/src/organisms/ChooseRobotToRunProtocolSlideout/index.tsx
@@ -70,7 +70,7 @@ export function ChooseRobotToRunProtocolSlideoutComponent(
       value: false,
       variableName: 'DRYRUN',
       description: 'Is this a dry or wet run? Wet is true, dry is false',
-      type: 'boolean',
+      type: 'bool',
       default: false,
     },
     {

diff --git a/app/src/organisms/Devices/ProtocolRun/__tests__/ProtocolRunRuntimeParameters.test.tsx b/app/src/organisms/Devices/ProtocolRun/__tests__/ProtocolRunRuntimeParameters.test.tsx
@@ -31,7 +31,7 @@ const mockRunTimeParameterData: RunTimeParameter[] = [
     displayName: 'Dry Run',
     variableName: 'DRYRUN',
     description: 'Is this a dry or wet run? Wet is true, dry is false',
-    type: 'boolean',
+    type: 'bool',
     default: false,
     value: false,
   },
@@ -124,7 +124,7 @@ describe('ProtocolRunRuntimeParameters', () => {
           displayName: 'Dry Run',
           variableName: 'DRYRUN',
           description: 'Is this a dry or wet run? Wet is true, dry is false',
-          type: 'boolean',
+          type: 'bool',
           default: false,
           value: true,
         },

diff --git a/app/src/organisms/ProtocolDetails/ProtocolParameters/__tests__/ProtocolParameters.test.tsx b/app/src/organisms/ProtocolDetails/ProtocolParameters/__tests__/ProtocolParameters.test.tsx
@@ -25,7 +25,7 @@ const mockRunTimeParameter: RunTimeParameter[] = [
     variableName: 'TIP_TRASH',
     description:
       'to throw tip into the trash or to not throw tip into the trash',
-    type: 'boolean',
+    type: 'bool',
     default: true,
     value: true,
   },

diff --git a/app/src/organisms/ProtocolSetupParameters/index.tsx b/app/src/organisms/ProtocolSetupParameters/index.tsx
@@ -24,15 +24,15 @@ export const mockData: RunTimeParameter[] = [
     displayName: 'Dry Run',
     variableName: 'DRYRUN',
     description: 'Is this a dry or wet run? Wet is true, dry is false',
-    type: 'boolean',
+    type: 'bool',
     default: false,
   },
   {
     value: true,
     displayName: 'Use Gripper',
     variableName: 'USE_GRIPPER',
     description: 'For using the gripper.',
-    type: 'boolean',
+    type: 'bool',
     default: true,
   },
   {
@@ -41,15 +41,15 @@ export const mockData: RunTimeParameter[] = [
     variableName: 'TIP_TRASH',
     description:
       'to throw tip into the trash or to not throw tip into the trash',
-    type: 'boolean',
+    type: 'bool',
     default: true,
   },
   {
     value: true,
     displayName: 'Deactivate Temperatures',
     variableName: 'DEACTIVATE_TEMP',
     description: 'deactivate temperature on the module',
-    type: 'boolean',
+    type: 'bool',
     default: true,
   },
   {
@@ -234,7 +234,7 @@ export function ProtocolSetupParameters({
           return (
             <React.Fragment key={`${parameter.displayName}_${index}`}>
               <ProtocolSetupStep
-                hasIcon={!(parameter.type === 'boolean')}
+                hasIcon={!(parameter.type === 'bool')}
                 status="general"
                 title={parameter.displayName}
                 onClickSetupStep={() => console.log('TODO: wire this up')}

diff --git a/app/src/pages/ProtocolDetails/Parameters.tsx b/app/src/pages/ProtocolDetails/Parameters.tsx
@@ -70,7 +70,7 @@ export const Parameters = (props: { protocolId: string }): JSX.Element => {
     }
 
     switch (type) {
-      case 'boolean': {
+      case 'bool': {
         return t('on_off')
       }
       case 'float':

diff --git a/app/src/pages/ProtocolDetails/fixtures.ts b/app/src/pages/ProtocolDetails/fixtures.ts
@@ -5,31 +5,31 @@ export const mockRunTimeParameterData: RunTimeParameter[] = [
     displayName: 'Dry Run',
     variableName: 'DRYRUN',
     description: 'a dry run description',
-    type: 'boolean',
+    type: 'bool',
     default: false,
     value: false,
   },
   {
     displayName: 'Use Gripper',
     variableName: 'USE_GRIPPER',
     description: '',
-    type: 'boolean',
+    type: 'bool',
     default: true,
     value: true,
   },
   {
     displayName: 'Trash Tips',
     variableName: 'TIP_TRASH',
     description: 'throw tip in trash',
-    type: 'boolean',
+    type: 'bool',
     default: true,
     value: true,
   },
   {
     displayName: 'Deactivate Temperatures',
     variableName: 'DEACTIVATE_TEMP',
     description: 'deactivate temperature?',
-    type: 'boolean',
+    type: 'bool',
     default: true,
     value: true,
   },

diff --git a/app/src/pages/Protocols/hooks/__tests__/hooks.test.tsx b/app/src/pages/Protocols/hooks/__tests__/hooks.test.tsx
@@ -38,28 +38,28 @@ const mockRTPData = [
     displayName: 'Dry Run',
     variableName: 'DRYRUN',
     description: 'a dry run description',
-    type: 'boolean',
+    type: 'bool',
     default: false,
   },
   {
     displayName: 'Use Gripper',
     variableName: 'USE_GRIPPER',
     description: '',
-    type: 'boolean',
+    type: 'bool',
     default: true,
   },
   {
     displayName: 'Trash Tips',
     variableName: 'TIP_TRASH',
     description: 'throw tip in trash',
-    type: 'boolean',
+    type: 'bool',
     default: true,
   },
   {
     displayName: 'Deactivate Temperatures',
     variableName: 'DEACTIVATE_TEMP',
     description: 'deactivate temperature?',
-    type: 'boolean',
+    type: 'bool',
     default: true,
   },
   {

diff --git a/app/src/pages/Protocols/hooks/index.ts b/app/src/pages/Protocols/hooks/index.ts
@@ -206,15 +206,15 @@ export const useRunTimeParameters = (
       displayName: 'Dry Run',
       variableName: 'DRYRUN',
       description: 'Is this a dry or wet run? Wet is true, dry is false',
-      type: 'boolean',
+      type: 'bool',
       default: false,
     },
     {
       value: true,
       displayName: 'Use Gripper',
       variableName: 'USE_GRIPPER',
       description: 'For using the gripper.',
-      type: 'boolean',
+      type: 'bool',
       default: true,
     },
     {
@@ -223,15 +223,15 @@ export const useRunTimeParameters = (
       variableName: 'TIP_TRASH',
       description:
         'to throw tip into the trash or to not throw tip into the trash',
-      type: 'boolean',
+      type: 'bool',
       default: true,
     },
     {
       value: true,
       displayName: 'Deactivate Temperatures',
       variableName: 'DEACTIVATE_TEMP',
       description: 'deactivate temperature on the module',
-      type: 'boolean',
+      type: 'bool',
       default: true,
     },
     {

diff --git a/components/src/molecules/ParametersTable/ParametersTable.stories.tsx b/components/src/molecules/ParametersTable/ParametersTable.stories.tsx
@@ -17,15 +17,15 @@ const runTimeParameters: RunTimeParameter[] = [
     displayName: 'Dry Run',
     variableName: 'DRYRUN',
     description: 'Is this a dry or wet run? Wet is true, dry is false',
-    type: 'boolean',
+    type: 'bool',
     default: false,
   },
   {
     value: true,
     displayName: 'Use Gripper',
     variableName: 'USE_GRIPPER',
     description: 'For using the gripper.',
-    type: 'boolean',
+    type: 'bool',
     default: true,
   },
   {
@@ -34,15 +34,15 @@ const runTimeParameters: RunTimeParameter[] = [
     variableName: 'TIP_TRASH',
     description:
       'to throw tip into the trash or to not throw tip into the trash',
-    type: 'boolean',
+    type: 'bool',
     default: true,
   },
   {
     value: true,
     displayName: 'Deactivate Temperatures',
     variableName: 'DEACTIVATE_TEMP',
     description: 'deactivate temperature on the module',
-    type: 'boolean',
+    type: 'bool',
     default: true,
   },
   {

diff --git a/components/src/molecules/ParametersTable/__tests__/ParametersTable.test.tsx b/components/src/molecules/ParametersTable/__tests__/ParametersTable.test.tsx
@@ -13,7 +13,7 @@ const mockRunTimeParameter: RunTimeParameter[] = [
     variableName: 'TIP_TRASH',
     description:
       'to throw tip into the trash or to not throw tip into the trash',
-    type: 'boolean',
+    type: 'bool',
     default: true,
     value: true,
   },

diff --git a/components/src/molecules/ParametersTable/index.tsx b/components/src/molecules/ParametersTable/index.tsx
@@ -32,7 +32,7 @@ export function ParametersTable({
       case 'int':
       case 'float':
         return minMax
-      case 'boolean':
+      case 'bool':
         return t != null ? t('on_off') : 'On, off'
       case 'str':
         if (count > 2) {

diff --git a/shared-data/js/helpers/__tests__/formatRunTimeParameterValue.test.ts b/shared-data/js/helpers/__tests__/formatRunTimeParameterValue.test.ts
@@ -70,7 +70,7 @@ describe('utils-formatRunTimeParameterValue', () => {
       displayName: 'Deactivate Temperatures',
       variableName: 'DEACTIVATE_TEMP',
       description: 'deactivate temperature on the module',
-      type: 'boolean',
+      type: 'bool',
       default: true,
     } as RunTimeParameter
     const result = formatRunTimeParameterValue(mockData, mockTFunction)
@@ -83,7 +83,7 @@ describe('utils-formatRunTimeParameterValue', () => {
       displayName: 'Dry Run',
       variableName: 'DRYRUN',
       description: 'Is this a dry or wet run? Wet is true, dry is false',
-      type: 'boolean',
+      type: 'bool',
       default: false,
     } as RunTimeParameter
     const result = formatRunTimeParameterValue(mockData, mockTFunction)

diff --git a/shared-data/js/helpers/formatRunTimeParameterValue.ts b/shared-data/js/helpers/formatRunTimeParameterValue.ts
@@ -15,7 +15,7 @@ export const formatRunTimeParameterValue = (
       return suffix !== null
         ? `${defaultValue.toString()} ${suffix}`
         : defaultValue.toString()
-    case 'boolean':
+    case 'bool':
       if (t != null) {
         return Boolean(defaultValue) ? t('on') : t('off')
       } else {

diff --git a/shared-data/js/types.ts b/shared-data/js/types.ts
@@ -614,7 +614,7 @@ interface BooleanParameter {
 }
 
 type NumberParameterType = 'int' | 'float'
-type BooleanParameterType = 'boolean'
+type BooleanParameterType = 'bool'
 type StringParameterType = 'str'
 type RunTimeParameterType =
   | NumberParameter