config validator

.eslintignore

@@ -2,3 +2,4 @@ node_modules
 node_modules_linux
 
 playwright/envs.js
+tools/marketplace-config-validator/schema.*
\ No newline at end of file

.gitignore

@@ -48,3 +48,6 @@ yarn-error.log*
 /playwright/envs.js
 
 **.dec**
+
+# tools
+tools/marketplace-config-validator/schema.*

.husky/pre-commit

@@ -14,4 +14,8 @@ for file in `git diff --diff-filter=ACMRT --cached --name-only | grep ".svg\$"`
         git add $file
     done
 
+# format svg
+echo 🧿 Running marketplace config validator...
+./deploy/scripts/validate_marketplace_config.sh
+
 echo ✅ All pre-commit jobs are done

deploy/scripts/validate_marketplace_config.sh

+yarn ts-to-zod ./types/client/apps.ts ./tools/marketplace-config-validator/schema.ts
+yarn tsc -p ./tools/marketplace-config-validator/tsconfig.json
+node ./tools/marketplace-config-validator/index.js
\ No newline at end of file

package.json

@@ -115,10 +115,12 @@
     "svgo": "^2.8.0",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
+    "ts-to-zod": "^3.0.0",
     "typescript": "4.9.5",
     "vite-plugin-svgr": "^2.2.2",
     "vite-tsconfig-paths": "^3.5.2",
-    "ws": "^8.11.0"
+    "ws": "^8.11.0",
+    "zod": "^3.21.4"
   },
   "lint-staged": {
     "*.{js,jsx,ts,tsx}": "eslint --cache --fix"

tools/marketplace-config-validator/index.js

+/* eslint-disable no-console */
+const baseGoerliConfig = require('../../configs/marketplace/base-goerli.json') ;
+const ethGoerliConfig = require('../../configs/marketplace/eth-goerli.json') ;
+const { appItemOverviewSchema } = require('./schema.js');
+
+console.log('Checking eth-goerli.json...');
+appItemOverviewSchema.array().parse(ethGoerliConfig);
+console.log('All good!');
+
+console.log('Checking base-goerli.json...');
+appItemOverviewSchema.array().parse(baseGoerliConfig);
+console.log('All good!');

tools/marketplace-config-validator/tsconfig.json

+{
+  "compilerOptions": {
+    "target": "es6",
+    "skipLibCheck": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "isolatedModules": true,
+    "incremental": true,
+    "baseUrl": ".",
+  },
+  "include": ["./**.ts"],
+  "exclude": ["node_modules", "node_modules_linux"],
+}

types/client/apps.ts

-export enum MarketplaceCategoryId {
-  'all',
-  'favorites',
-  'defi',
-  'exchanges',
-  'finance',
-  'games',
-  'marketplaces',
-  'nft',
-  'security',
-  'social',
-  'tools',
-  'yieldFarming',
-}
-
-export type MarketplaceCategoriesIds = keyof typeof MarketplaceCategoryId;
+export type MarketplaceCategoriesIds = 'all' | 'favorites' | 'defi' | 'exchanges' | 'finance' | 'games' | 'marketplaces' | 'nft' |
+'security' | 'social' | 'tools' | 'yieldFarming';
 
 export type MarketplaceCategory = { id: MarketplaceCategoriesIds; name: string }
 
 export type AppItemPreview = {
   id: string;
-  external: boolean;
+  external?: boolean;
   title: string;
   logo: string;
   shortDescription: string;

ui/apps/AppCardLink.tsx

@@ -5,7 +5,7 @@ import React from 'react';
 type Props = {
   id: string;
   url: string;
-  external: boolean;
+  external?: boolean;
   title: string;
 }
 

ui/apps/AppModalLink.tsx

@@ -5,7 +5,7 @@ import React from 'react';
 type Props = {
   id: string;
   url: string;
-  external: boolean;
+  external?: boolean;
   title: string;
 }