refactor: ♻️ adjusting mock settings configuration

Author: haydenull

.gitignore

@@ -8,4 +8,4 @@ dist-ssr
 .cache
 
 # mock settings may contain sensitive tokens
-src/mock/settings.json
+mocks/settings.local.json

CONTRIBUTING.md

@@ -9,6 +9,7 @@
 Follow the steps below to run it locally for first time.
 
 1. Copy `.env.example` to `.env`
-2. Turn on the HTTP APIs Server of Logseq
-3. Install dependencies: `pnpm install`
-4. Run `pnpm dev`
+2. Copy `mocks/settings.example.json` to `settings.local.json`
+3. Turn on the HTTP APIs Server of Logseq
+4. Install dependencies: `pnpm install`
+5. Run `pnpm dev`

src/mock/ganttData.json renamed to mocks/ganttData.json

@@ -0,0 +1,59 @@
+{
+  "disabled": true,
+  "theme": "auto",
+  "lightThemeType": "green",
+  "homePage": "dashboard",
+  "defaultView": "month",
+  "weekStartDay": 0,
+  "weekHourStart": 0,
+  "weekHourEnd": 24,
+  "defaultDuration": {
+    "value": 0.5,
+    "unit": "h"
+  },
+  "defaultDurationUnit": "h",
+  "logKey": {
+    "id": "Daily Log",
+    "bgColor": "#047857",
+    "textColor": "#fff",
+    "borderColor": "#047857",
+    "enabled": true
+  },
+  "journal": {
+    "id": "Journal",
+    "bgColor": "#047857",
+    "textColor": "#fff",
+    "borderColor": "#047857",
+    "enabled": true
+  },
+  "projectList": [
+    {
+      "id": "logseq-plugin-agenda/2.15.0",
+      "bgColor": "#b8e986",
+      "textColor": "#4a4a4a",
+      "borderColor": "#047857",
+      "enabled": true
+    }
+  ],
+  "calendarList": [],
+  "subscriptionList": [],
+  "pomodoro": {
+    "pomodoro": 25,
+    "shortBreak": 5,
+    "longBreak": 15,
+    "autoStartBreaks": false,
+    "autoStartPomodoros": false,
+    "longBreakInterval": 4,
+    "commonPomodoros": [
+      10,
+      15,
+      20,
+      25,
+      40
+    ]
+  },
+  "initialized": true,
+  "ignoreTag": null,
+  "todoist": {},
+  "language": "zh-hans"
+}

mocks/settings.example.json

@@ -1,17 +1,19 @@
-import { genToolbarPomodoro, updatePomodoroInfo } from '@/helper/pomodoro'
-import { PomodoroConfig, usePomodoro } from '@haydenull/use-pomodoro'
+import { type PomodoroConfig, usePomodoro } from '@haydenull/use-pomodoro'
 import { ConfigProvider, Tooltip } from 'antd'
 import dayjs from 'dayjs'
 import React, { useEffect, useMemo, useRef, useState } from 'react'
 import { AiOutlinePoweroff, AiOutlineQuestionCircle } from 'react-icons/ai'
 import { MdOutlineRunningWithErrors } from 'react-icons/md'
 import { RiExternalLinkLine } from 'react-icons/ri'
+
+import { genToolbarPomodoro, updatePomodoroInfo } from '@/helper/pomodoro'
+
 import InerruptionModal from '../components/InerruptionModal'
 import { transformBlockToEvent } from '../helper/transform'
 import useTheme from '../hooks/useTheme'
 import { getInitialSettings } from '../util/baseInfo'
 import { ANTD_THEME_CONFIG } from '../util/constants'
-import { IEvent } from '../util/events'
+import type { IEvent } from '../util/events'
 import { navToBlock } from '../util/logseq'
 import { notification } from '../util/util'
 

src/apps/PomodoroApp.tsx

@@ -50,7 +50,7 @@ if (isDevelopment) {
       apiServer: import.meta.env.VITE_LOGSEQ_API_SERVER,
       apiToken: import.meta.env.VITE_LOGSEQ_API_TOKEN,
     },
-    settings: await import('@/mock/settings.json'),
+    settings: window.mockSettings,
   })
   renderApp()
   // renderPomodoroApp('pomodoro')

src/main.tsx

@@ -1,8 +1,9 @@
 /// <reference types="vite/client" />
 
+type IInterruption = import('./helper/pomodoro').IInterruption
 interface Window {
-  faizNavigate: (e: any) => void
-  logseqAppUserConfigs: any
+  faizNavigate: (e: unknown) => void
+  logseqAppUserConfigs: unknown
   currentApp: 'app' | 'pomodoro' | 'modal'
   currentPomodoro: {
     uuid?: string
@@ -11,7 +12,8 @@ interface Window {
     }
   }
   unmountPomodoroApp: () => void
-  interruptionMap: Map<number, any>
+  interruptionMap: Map<number, IInterruption[]>
+  mockSettings: Record<string, unknown>
 }
 
 interface ImportMetaEnv {

src/vite-env.d.ts

@@ -20,5 +20,5 @@
       "@/*": ["./src/*"],
     }
   },
-  "include": ["./src"]
+  "include": ["./src", "./vite.config.ts"]
 }

tsconfig.json

@@ -3,30 +3,38 @@ import { resolve } from 'path'
 import { defineConfig } from 'vite'
 
 // https://vitejs.dev/config/
-export default defineConfig({
-  plugins: [
-    react(),
-    // usePluginImport({
-    //   libraryName: "antd",
-    //   libraryDirectory: "es",
-    //   style: "css",
-    // }),
-  ],
-  resolve: {
-    alias: {
-      '@': resolve(__dirname, 'src'),
+export default defineConfig(async ({ command, mode }) => {
+  return {
+    plugins: [
+      react(),
+      // usePluginImport({
+      //   libraryName: "antd",
+      //   libraryDirectory: "es",
+      //   style: "css",
+      // }),
+    ],
+    resolve: {
+      alias: {
+        '@': resolve(__dirname, 'src'),
+      },
+    },
+    base: './',
+    build: {
+      target: 'esnext',
+      // minify: "esbuild",
     },
-  },
-  base: './',
-  build: {
-    target: 'esnext',
-    // minify: "esbuild",
-  },
-  css: {
-    preprocessorOptions: {
-      less: {
-        javascriptEnabled: true,
+    css: {
+      preprocessorOptions: {
+        less: {
+          javascriptEnabled: true,
+        },
       },
     },
-  },
+    define: {
+      mockSettings:
+        mode === 'production'
+          ? await import('./mocks/settings.example.json')
+          : await import('./mocks/settings.local.json'),
+    },
+  }
 })