better handle readme's

DerGoogler · Jun 26, 2024 · f2ebc24 · f2ebc24
1 parent f64a2ef
commit f2ebc24
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 15 deletions.
diff --git a/Website/src/activitys/ModuleViewActivity/tabs/OverviewTab.tsx b/Website/src/activitys/ModuleViewActivity/tabs/OverviewTab.tsx
@@ -37,21 +37,24 @@ const OverviewTab = () => {
   const { settings } = useSettings();
   const { modules } = useRepos();
   const { id, name, description, versions } = extra;
-  const { antifeatures, screenshots, require, readme: __readme, categories, icon } = extra;
+  const { screenshots, require, readme: __readme, categories, icon, track } = extra;
+
+  // handle when the dev does not define a readme
+  const moduleReadme = __readme || track.readme;
 
   const { filteredCategories } = useCategories(categories);
   const isLowQuality = useLowQualityModule(extra, !settings._low_quality_module);
   const latestVersion = React.useMemo(() => versions[versions.length - 1], [versions]);
   const formatLastUpdate = useFormatDate(latestVersion.timestamp);
   const [readme, setReadme] = React.useState<string | undefined>(undefined);
 
-  const findHardCodedAntifeature = React.useMemo<Module["antifeatures"]>(() => {
-    return [...(antifeatures || []), ...(blacklistedModules.find((mod) => mod.id === id)?.antifeatures || [])];
-  }, [id, antifeatures]);
+  const findHardCodedAntifeature = React.useMemo<Track["antifeatures"]>(() => {
+    return [...(track.antifeatures || []), ...(blacklistedModules.find((mod) => mod.id === id)?.antifeatures || [])];
+  }, [id, track.antifeatures]);
 
   React.useEffect(() => {
-    if (__readme) {
-      fetch(__readme)
+    if (moduleReadme) {
+      fetch(moduleReadme)
         .then((res) => {
           if (res.status === 200) {
             return res.text();
@@ -61,7 +64,7 @@ const OverviewTab = () => {
         })
         .then((text) => setReadme(text));
     }
-  }, [__readme]);
+  }, [moduleReadme]);
 
   return (
     <>

diff --git a/Website/src/components/AntifeaturesButton.tsx b/Website/src/components/AntifeaturesButton.tsx
@@ -8,7 +8,7 @@ import { GestureDetector } from "./onsenui/GestureDetector";
 
 type Props = {
   sx?: SxProps;
-  antifeatures?: Module["antifeatures"];
+  antifeatures?: Track["antifeatures"];
 };
 
 export const AntifeatureButton = (props: Props) => {

diff --git a/Website/src/components/module/DeviceModule.tsx b/Website/src/components/module/DeviceModule.tsx
@@ -62,7 +62,7 @@ const DeviceModule = React.memo<Props>((props) => {
   const boot_complete = SuFile.exist(format("BOOTCOMP"));
   const module_config_file = SuFile.exist(format("CONFINDEX"));
 
-  const findHardCodedAntifeature = React.useMemo<Module["antifeatures"]>(() => {
+  const findHardCodedAntifeature = React.useMemo<Track["antifeatures"]>(() => {
     return blacklistedModules.find((mod) => mod.id === id)?.antifeatures || [];
   }, [id]);
 

diff --git a/Website/src/components/module/ExploreModule.tsx b/Website/src/components/module/ExploreModule.tsx
@@ -24,7 +24,7 @@ interface Props {
 
 const ExploreModule = React.memo<Props>((props) => {
   const { id, name, author, description, track, timestamp, version, versions, versionCode } = props.module;
-  const { cover, antifeatures, verified } = props.module;
+  const { cover, verified } = props.module;
 
   const { context } = useActivity();
   const { strings } = useStrings();
@@ -33,9 +33,9 @@ const ExploreModule = React.memo<Props>((props) => {
 
   const formatLastUpdate = useFormatDate(timestamp ? timestamp : versions[versions.length - 1].timestamp);
 
-  const findHardCodedAntifeature = React.useMemo<Module["antifeatures"]>(() => {
-    return [...(antifeatures || []), ...(blacklistedModules.find((mod) => mod.id === id)?.antifeatures || [])];
-  }, [id, antifeatures]);
+  const findHardCodedAntifeature = React.useMemo<Track["antifeatures"]>(() => {
+    return [...(track.antifeatures || []), ...(blacklistedModules.find((mod) => mod.id === id)?.antifeatures || [])];
+  }, [id, track.antifeatures]);
 
   const handleOpenModule = () => {
     context.pushPage({

diff --git a/Website/src/typings/global.d.ts b/Website/src/typings/global.d.ts
@@ -170,7 +170,6 @@ declare global {
     categories?: string[];
     stars?: number;
     readme?: string;
-    antifeatures?: string | string[];
     verified: boolean;
 
     /**
@@ -183,6 +182,8 @@ declare global {
     type: string;
     added: number;
     source: string;
+    readme?: string;
+    antifeatures?: string | string[];
   }
 
   export interface Version {

diff --git a/Website/src/util/blacklisted-modules.ts b/Website/src/util/blacklisted-modules.ts
@@ -3,7 +3,7 @@ export interface BlacklistedModule {
   source: string;
   hidden: boolean;
   notes: string;
-  antifeatures: Module["antifeatures"];
+  antifeatures: Track["antifeatures"];
 }
 
 export const blacklistedModules: BlacklistedModule[] = [