update readme, lint

mongodb · Feb 14, 2025 · 36c3c5a · 36c3c5a
1 parent 6bd672c
commit 36c3c5a
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 6 deletions.
diff --git a/.changeset/chatty-ears-exercise.md b/.changeset/chatty-ears-exercise.md
@@ -88,7 +88,7 @@ e.g.
 ### Test Harnesses
 Exports `getTestUtils`, a util to reliably interact with LG `Code` in a product test suite. For more details, check out the [README](https://github.com/mongodb/leafygreen-ui/tree/main/packages/code#test-harnesses) [LG-4799](https://jira.mongodb.org/browse/LG-4799)
 
-Also exports the constant, `LGIDs` which stores `data-lgid` values.
+Exports `getLgIds`, a util to instantiate an object of `data-lgid` values for a given LG `Code` component instance.
 
 
 ## What's changed?

diff --git a/packages/code/README.md b/packages/code/README.md
@@ -135,7 +135,7 @@ interface LanguageOption {
 ```tsx
 import { getTestUtils } from '@leafygreen-ui/code';
 
-const utils = getTestUtils(lgId?: string); // lgId refers to the custom `data-lgid` attribute passed to `Code`. It defaults to 'lg-code' if left empty.
+const utils = getTestUtils(lgId?: `lg-${string}`); // lgId refers to the custom `data-lgid` attribute passed to `Code`. It defaults to 'lg-code' if left empty.
 ```
 
 #### Single `Code` component

diff --git a/packages/code/src/Code/Code.tsx b/packages/code/src/Code/Code.tsx
@@ -15,6 +15,7 @@ import CopyButton from '../CopyButton/CopyButton';
 import { Panel } from '../Panel';
 import { Syntax } from '../Syntax';
 import { Language } from '../types';
+import { DEFAULT_LGID_ROOT, getLgIds } from '../utils/getLgIds';
 
 import {
   getCodeStyles,
@@ -30,7 +31,6 @@ import {
   DetailedElementProps,
   ScrollState,
 } from './Code.types';
-import { DEFAULT_LGID_ROOT, getLgIds } from '../utils/getLgIds';
 
 //TODO: move to utils
 export function hasMultipleLines(string: string): boolean {

diff --git a/packages/code/src/CodeContext/CodeContext.tsx b/packages/code/src/CodeContext/CodeContext.tsx
@@ -36,7 +36,7 @@ const CodeContextProvider = ({
       isLoading,
       lgids,
     };
-  }, [contents, language, showPanel, isLoading]);
+  }, [contents, language, showPanel, isLoading, lgids]);
 
   return (
     <LeafyGreenProvider darkMode={darkMode}>

diff --git a/packages/code/src/CopyButton/CopyButton.tsx b/packages/code/src/CopyButton/CopyButton.tsx
@@ -20,8 +20,8 @@ import Tooltip, {
 } from '@leafygreen-ui/tooltip';
 
 import { useCodeContext } from '../CodeContext/CodeContext';
-// import { LGIDs } from '../constants';
 
+// import { LGIDs } from '../constants';
 import { COPIED_SUCCESS_DURATION, COPIED_TEXT, COPY_TEXT } from './constants';
 import { getCopyButtonStyles } from './CopyButton.styles';
 import { CopyProps } from './CopyButton.types';

diff --git a/packages/code/src/utils/getTestUtils/getTestUtils.ts b/packages/code/src/utils/getTestUtils/getTestUtils.ts
@@ -3,9 +3,10 @@ import { getByLgId, queryBySelector } from '@lg-tools/test-harnesses';
 import { getTestUtils as getButtonTestUtils } from '@leafygreen-ui/button';
 import { getTestUtils as getSelectTestUtils } from '@leafygreen-ui/select';
 
-import { TestUtilsReturnType } from './getTestUtils.types';
 import { DEFAULT_LGID_ROOT, getLgIds } from '../getLgIds';
 
+import { TestUtilsReturnType } from './getTestUtils.types';
+
 export const getTestUtils = (
   lgId: `lg-${string}` = DEFAULT_LGID_ROOT,
 ): TestUtilsReturnType => {