(chore) Miscellaneous tweaks (#55)

This commit makes several tweaks, including: - Destructuring the isLoading boolean and renaming the error property in SWR hooks - Including tests in linting - Changing package descriptions in manifest files
openmrs · Aug 28, 2024 · bdb5a19 · bdb5a19
1 parent 80c0ed9
commit bdb5a19
Show file tree

Hide file tree

Showing 10 changed files with 22 additions and 25 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,3 +1,2 @@
-src/**/*.test.tsx
 src/**/*.spec.tsx
 **/node_modules/**/*
diff --git a/.prettierignore b/.prettierignore
@@ -1,6 +1,4 @@
 dist/
 node_modules/
-**/*.css
-**/*.scss
 **/*.md
 **/*.json
diff --git a/packages/esm-admin-openconceptlab-app/package.json b/packages/esm-admin-openconceptlab-app/package.json
@@ -2,7 +2,7 @@
   "name": "@openmrs/esm-openconceptlab-app",
   "version": "4.0.3",
   "license": "MPL-2.0",
-  "description": "An app to manage the openconceptlab module",
+  "description": "Open Concept Lab management frontend module for O3",
   "browser": "dist/openmrs-esm-openconceptlab-app.js",
   "main": "src/index.ts",
   "source": true,

diff --git a/packages/esm-admin-openconceptlab-app/src/import/import.component.tsx b/packages/esm-admin-openconceptlab-app/src/import/import.component.tsx
@@ -23,13 +23,13 @@ const Import: React.FC = () => {
   const [file, setFile] = useState<File>();
   const [isFileUploading, setIsFileUploading] = useState(false);
 
-  const { data: subscription, isLoading, isError } = useSubscription();
+  const { data: subscription, isLoading, error } = useSubscription();
 
   useEffect(() => {
-    if (!isLoading && !isError) {
+    if (!isLoading && !error) {
       setIsSubscriptionAvailable(!!subscription);
     }
-  }, [isLoading, isError, subscription]);
+  }, [isLoading, error, subscription]);
 
   const onAddFiles = useCallback(
     (evt: React.DragEvent<HTMLInputElement>, { addedFiles }) => {
@@ -138,7 +138,7 @@ const Import: React.FC = () => {
     );
   }
 
-  if (isError) {
+  if (error) {
     showNotification({
       kind: 'error',
       description: t('subscriptionError', 'Error occured while fetching the subscription'),

diff --git a/packages/esm-admin-openconceptlab-app/src/import/import.resource.ts b/packages/esm-admin-openconceptlab-app/src/import/import.resource.ts
@@ -3,15 +3,15 @@ import useSWR from 'swr';
 import type { Import, Subscription } from '../types';
 
 export function useSubscription() {
-  const { data, error, isValidating } = useSWR<{ data: { results: Subscription[] } }, Error>(
+  const { data, error, isLoading, isValidating } = useSWR<{ data: { results: Subscription[] } }, Error>(
     '/ws/rest/v1/openconceptlab/subscription?v=full',
     openmrsFetch,
   );
 
   return {
     data: data?.data?.results[0],
-    isLoading: !data && !error,
-    isError: error,
+    error,
+    isLoading,
     isValidating,
   };
 }

diff --git a/packages/esm-admin-openconceptlab-app/src/previous-imports/previous-imports.component.tsx b/packages/esm-admin-openconceptlab-app/src/previous-imports/previous-imports.component.tsx
@@ -28,7 +28,7 @@ const PreviousImports: React.FC = () => {
   const { t } = useTranslation();
   const [pageSize, setPageSize] = useState(10);
 
-  const { data: prevImports, isLoading, isError } = usePreviousImports();
+  const { data: prevImports, isLoading, error } = usePreviousImports();
   const { results, currentPage, goTo } = usePagination(prevImports, pageSize);
 
   if (isLoading) {
@@ -43,7 +43,7 @@ const PreviousImports: React.FC = () => {
     );
   }
 
-  if (isError) {
+  if (error) {
     showNotification({
       kind: 'error',
       description: t('previousImportsFetchError', 'Error occured while fetching the imports'),
@@ -76,7 +76,7 @@ const PreviousImports: React.FC = () => {
 
   return (
     !isLoading &&
-    !isError && (
+    !error && (
       <Grid className={styles.grid}>
         <Column sm={4} md={8} lg={10}>
           <h3 className={styles.productiveHeading03}>{t('previousImports', 'Previous Imports')}</h3>

diff --git a/packages/esm-admin-openconceptlab-app/src/previous-imports/previous-imports.resource.ts b/packages/esm-admin-openconceptlab-app/src/previous-imports/previous-imports.resource.ts
@@ -3,15 +3,15 @@ import useSWR from 'swr';
 import type { Import } from '../types';
 
 export function usePreviousImports() {
-  const { data, error, isValidating } = useSWR<{ data: { results: Import[] } }, Error>(
+  const { data, error, isLoading, isValidating } = useSWR<{ data: { results: Import[] } }, Error>(
     '/ws/rest/v1/openconceptlab/import?v=full',
     openmrsFetch,
   );
 
   return {
     data: data?.data?.results,
-    isLoading: !data && !error,
-    isError: error,
+    error,
+    isLoading,
     isValidating,
   };
 }
diff --git a/packages/esm-admin-openconceptlab-app/src/subscription/subscription.component.tsx b/packages/esm-admin-openconceptlab-app/src/subscription/subscription.component.tsx
@@ -30,17 +30,17 @@ const Subscription: React.FC = () => {
   const [validationType, setValidationType] = useState<'NONE' | 'FULL'>('FULL');
   const [isSnapshotOptionDisabled, setIsSnapshotOptionDisabled] = useState(false);
 
-  const { data: subscription, isLoading, isError } = useSubscription();
+  const { data: subscription, isLoading, error } = useSubscription();
 
   useEffect(() => {
-    if (!isLoading && !isError) {
+    if (!isLoading && !error) {
       setSubscriptionUrl(subscription?.url || '');
       setToken(subscription?.token || '');
       setIsSubscribedToSnapshot(subscription?.subscribedToSnapshot || false);
       setValidationType(subscription?.validationType || 'FULL');
       setIsSnapshotOptionDisabled(subscription ? isVersionDefinedInUrl(subscription.url) : false);
     }
-  }, [isLoading, isError, subscription]);
+  }, [isLoading, error, subscription]);
 
   const handleChangeSubscriptionUrl = useCallback((event: React.ChangeEvent<HTMLInputElement>) => {
     setSubscriptionUrl(event.target.value);
@@ -189,7 +189,7 @@ const Subscription: React.FC = () => {
     );
   }
 
-  if (isError) {
+  if (error) {
     showNotification({
       kind: 'error',
       description: t('subscriptionError', 'Error occured while fetching the subscription'),

diff --git a/packages/esm-admin-openconceptlab-app/src/subscription/subscription.resource.ts b/packages/esm-admin-openconceptlab-app/src/subscription/subscription.resource.ts
@@ -4,15 +4,15 @@ import isNil from 'lodash-es/isNil';
 import type { Subscription } from '../types';
 
 export function useSubscription() {
-  const { data, error, isValidating } = useSWR<{ data: { results: Subscription[] } }, Error>(
+  const { data, error, isLoading, isValidating } = useSWR<{ data: { results: Subscription[] } }, Error>(
     '/ws/rest/v1/openconceptlab/subscription?v=full',
     openmrsFetch,
   );
 
   return {
     data: data?.data?.results[0],
-    isLoading: !data && !error,
-    isError: error,
+    error,
+    isLoading,
     isValidating,
   };
 }

diff --git a/packages/esm-system-admin-app/package.json b/packages/esm-system-admin-app/package.json
@@ -2,7 +2,7 @@
   "name": "@openmrs/esm-system-admin-app",
   "version": "4.0.3",
   "license": "MPL-2.0",
-  "description": "System Admin page for OpenMRS",
+  "description": "System admin frontend module for O3",
   "browser": "dist/openmrs-esm-system-admin-app.js",
   "main": "src/index.ts",
   "source": true,