Format code to pass new format checks (#34)

* Create .prettierignore

* Update package.json with format scripts

* add prettier dep

* pull

* format files

* add format checks

* remove unneeded prettierignore file

.github/workflows/quality-checks.yml

@@ -24,4 +24,13 @@ jobs:
       - name: Run Unit Tests
         run: yarn jest
 
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup
+        uses: Optum/react-hooks/.github/actions/setup@main
+
+      - name: Run format checks
+        run: yarn format:check
+
 

babel.config.js

@@ -1,6 +1,3 @@
 module.exports = {
-    presets: [
-      ['@babel/preset-env', {targets: {node: 'current'}}],
-      '@babel/preset-typescript'
-    ],
-};
+  presets: [['@babel/preset-env', {targets: {node: 'current'}}], '@babel/preset-typescript']
+};

hooks/useCommonContext/index.ts

@@ -1 +1 @@
-export * from './useCommonContext';
+export * from './useCommonContext';

hooks/useCommonContext/useCommonContext.ts

@@ -1,11 +1,14 @@
 export function useCommonContext<T>(...contextHooks: (() => T)[]): T {
-  const context = contextHooks.reduce((prev, useContext) => {
-    try {
-      return useContext();
-    } catch {
-      return prev;
-    }
-  }, undefined as T | undefined);
+  const context = contextHooks.reduce(
+    (prev, useContext) => {
+      try {
+        return useContext();
+      } catch {
+        return prev;
+      }
+    },
+    undefined as T | undefined
+  );
 
   if (!context) {
     throw new Error('contexts not available');

hooks/useFocus/index.ts

@@ -1 +1 @@
-export * from './useFocus';
+export * from './useFocus';

hooks/useLoadData/index.ts

@@ -1,2 +1,2 @@
-export * from './useLoadData'
-export * from './types';
+export * from './useLoadData';
+export * from './types';

hooks/useLoadData/useLoadData.test.ts

@@ -385,61 +385,61 @@ describe('useLoadData', () => {
   });
 
   it('should re-invoke fetchData when fetchWhenDepsChange with an initial promise with normal dep', async () => {
-      const {result} = renderHook(() => {
-        const [dep, setDep] = useState<any>('a');
-        const loadedData = useLoadData(getSuccess, [dep], {fetchWhenDepsChange: true});
-
-        return {loadedData, setDep};
-      });
-      expect(result.current.loadedData.isInProgress).toBe(true);
-
-      await waitFor(() => expect(result.current.loadedData.isInProgress).toBe(false));
-      expect(getSuccess).toHaveBeenCalledWith('a');
-      expect(getSuccess).toHaveBeenCalledTimes(1);
-
-      await act(() => result.current.setDep('b'));
-      await waitFor(() => expect(result.current.loadedData.isInProgress).toBe(false));
-      expect(getSuccess).toHaveBeenCalledTimes(2);
-
-      expect(getSuccess).toHaveBeenCalledWith('b');
+    const {result} = renderHook(() => {
+      const [dep, setDep] = useState<any>('a');
+      const loadedData = useLoadData(getSuccess, [dep], {fetchWhenDepsChange: true});
+
+      return {loadedData, setDep};
     });
-
-    it('should re-invoke fetchData when fetchWhenDepsChange with an initial promise with finished dependency', async () => {
-      const {result} = renderHook(() => {
-        const [dep, setDep] = useState<any>({...successfulResponse, result: 'a'});
-        const loadedData = useLoadData(getSuccess, [dep], {fetchWhenDepsChange: true});
-
-        return {loadedData, setDep};
-      });
-      expect(result.current.loadedData.isInProgress).toBe(true);
-
-      await waitFor(() => expect(result.current.loadedData.isInProgress).toBe(false));
-      expect(getSuccess).toHaveBeenCalledWith('a');
-      expect(getSuccess).toHaveBeenCalledTimes(1);
-
-      await act(() => result.current.setDep({...successfulResponse, result: 'b'}));
-      await waitFor(() => expect(result.current.loadedData.isInProgress).toBe(false));
-      expect(getSuccess).toHaveBeenCalledTimes(2);
-      expect(getSuccess).toHaveBeenCalledWith('b');
+    expect(result.current.loadedData.isInProgress).toBe(true);
+
+    await waitFor(() => expect(result.current.loadedData.isInProgress).toBe(false));
+    expect(getSuccess).toHaveBeenCalledWith('a');
+    expect(getSuccess).toHaveBeenCalledTimes(1);
+
+    await act(() => result.current.setDep('b'));
+    await waitFor(() => expect(result.current.loadedData.isInProgress).toBe(false));
+    expect(getSuccess).toHaveBeenCalledTimes(2);
+
+    expect(getSuccess).toHaveBeenCalledWith('b');
+  });
+
+  it('should re-invoke fetchData when fetchWhenDepsChange with an initial promise with finished dependency', async () => {
+    const {result} = renderHook(() => {
+      const [dep, setDep] = useState<any>({...successfulResponse, result: 'a'});
+      const loadedData = useLoadData(getSuccess, [dep], {fetchWhenDepsChange: true});
+
+      return {loadedData, setDep};
     });
-
-    it('should re-invoke fetchData when fetchWhenDepsChange with an initial promise with pending dependency', async () => {
-      const {result} = renderHook(() => {
-        const [dep, setDep] = useState<any>(pendingResponse);
-        const loadedData = useLoadData(getSuccess, [dep], {fetchWhenDepsChange: true});
-
-        return {loadedData, setDep};
-      });
-      expect(result.current.loadedData.isInProgress).toBe(true);
-      await act(() => result.current.setDep({...successfulResponse, result: 'a'}));
-
-      await waitFor(() => expect(result.current.loadedData.isInProgress).toBe(false));
-      expect(getSuccess).toHaveBeenCalledWith('a');
-      expect(getSuccess).toHaveBeenCalledTimes(1);
-
-      await act(() => result.current.setDep({...successfulResponse, result: 'b'}));
-      await waitFor(() => expect(result.current.loadedData.isInProgress).toBe(false));
-      expect(getSuccess).toHaveBeenCalledTimes(2);
-      expect(getSuccess).toHaveBeenCalledWith('b');
+    expect(result.current.loadedData.isInProgress).toBe(true);
+
+    await waitFor(() => expect(result.current.loadedData.isInProgress).toBe(false));
+    expect(getSuccess).toHaveBeenCalledWith('a');
+    expect(getSuccess).toHaveBeenCalledTimes(1);
+
+    await act(() => result.current.setDep({...successfulResponse, result: 'b'}));
+    await waitFor(() => expect(result.current.loadedData.isInProgress).toBe(false));
+    expect(getSuccess).toHaveBeenCalledTimes(2);
+    expect(getSuccess).toHaveBeenCalledWith('b');
+  });
+
+  it('should re-invoke fetchData when fetchWhenDepsChange with an initial promise with pending dependency', async () => {
+    const {result} = renderHook(() => {
+      const [dep, setDep] = useState<any>(pendingResponse);
+      const loadedData = useLoadData(getSuccess, [dep], {fetchWhenDepsChange: true});
+
+      return {loadedData, setDep};
     });
+    expect(result.current.loadedData.isInProgress).toBe(true);
+    await act(() => result.current.setDep({...successfulResponse, result: 'a'}));
+
+    await waitFor(() => expect(result.current.loadedData.isInProgress).toBe(false));
+    expect(getSuccess).toHaveBeenCalledWith('a');
+    expect(getSuccess).toHaveBeenCalledTimes(1);
+
+    await act(() => result.current.setDep({...successfulResponse, result: 'b'}));
+    await waitFor(() => expect(result.current.loadedData.isInProgress).toBe(false));
+    expect(getSuccess).toHaveBeenCalledTimes(2);
+    expect(getSuccess).toHaveBeenCalledWith('b');
+  });
 });

hooks/useOptionalDependency/index.ts

@@ -1 +1 @@
-export * from './useOptionalDependency';
+export * from './useOptionalDependency';

hooks/useRetry/index.ts

@@ -1 +1 @@
-export * from './useRetry';
+export * from './useRetry';

package.json

@@ -7,7 +7,10 @@
   "sideEffects": false,
   "scripts": {
     "build": "tsc --project tsconfig.json",
-    "prepack": "yarn build"
+    "prepack": "yarn build",
+    "format": "yarn format:nowrite --write",
+    "format:nowrite": "prettier --ignore-path .gitignore \"**/*.+(js|ts|tsx|html|css|scss|json)\"",
+    "format:check": "yarn format:nowrite --list-different"
   },
   "files": [
     "build/**"
@@ -25,7 +28,7 @@
     "eslint": "^8.28.0",
     "jest": "^27.2.1",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.3.2",
+    "prettier": "^3.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "ts-jest": "^27.0.5",

prettier.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  singleQuote: true,
+  printWidth: 120,
+  bracketSpacing: false,
+  arrowParens: 'always',
+  tabWidth: 2,
+  trailingComma: 'none',
+  endOfLine: 'auto'
+};

test-setup.js

@@ -1,4 +1,4 @@
 const noop = () => {};
-if(typeof window !== 'undefined') {
-    Object.defineProperty(window, 'scrollTo', {value: noop, writable: true})
-}
+if (typeof window !== 'undefined') {
+  Object.defineProperty(window, 'scrollTo', {value: noop, writable: true});
+}

tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "module": "Node16",
-    "moduleResolution":"Node16",
+    "moduleResolution": "Node16",
     "preserveSymlinks": true,
     "rootDir": ".",
     "outDir": "build/cjs",

yarn.lock

@@ -1851,7 +1851,7 @@ __metadata:
     eslint: ^8.28.0
     jest: ^27.2.1
     npm-run-all: ^4.1.5
-    prettier: ^2.3.2
+    prettier: ^3.2.5
     react: ^18.2.0
     react-dom: ^18.2.0
     ts-jest: ^27.0.5
@@ -5888,12 +5888,12 @@ __metadata:
   languageName: node
   linkType: hard
 
-"prettier@npm:^2.3.2":
-  version: 2.8.7
-  resolution: "prettier@npm:2.8.7"
+"prettier@npm:^3.2.5":
+  version: 3.2.5
+  resolution: "prettier@npm:3.2.5"
   bin:
-    prettier: bin-prettier.js
-  checksum: fdc8f2616f099f5f0d685907f4449a70595a0fc1d081a88919604375989e0d5e9168d6121d8cc6861f21990b31665828e00472544d785d5940ea08a17660c3a6
+    prettier: bin/prettier.cjs
+  checksum: 2ee4e1417572372afb7a13bb446b34f20f1bf1747db77cf6ccaf57a9be005f2f15c40f903d41a6b79eec3f57fff14d32a20fb6dee1f126da48908926fe43c311
   languageName: node
   linkType: hard