Merge branch 'release/3.57.0'

README.md

@@ -76,16 +76,16 @@ For more information on how to use the following functions, please see [characte
 
 ## Changelogs
 
-### [v3.56.4](https://github.com/purocean/yn/releases/tag/v3.56.4) 2023-07-23
+### [v3.57.0](https://github.com/purocean/yn/releases/tag/v3.57.0) 2023-07-31
 
-[Windows](https://github.com/purocean/yn/releases/download/v3.56.4/Yank-Note-win-x64-3.56.4.exe) | [macOS arm64](https://github.com/purocean/yn/releases/download/v3.56.4/Yank-Note-mac-arm64-3.56.4.dmg) | [macOS x64](https://github.com/purocean/yn/releases/download/v3.56.4/Yank-Note-mac-x64-3.56.4.dmg) | [Linux AppImage](https://github.com/purocean/yn/releases/download/v3.56.4/Yank-Note-linux-x86_64-3.56.4.AppImage) | [Linux deb](https://github.com/purocean/yn/releases/download/v3.56.4/Yank-Note-linux-amd64-3.56.4.deb)
+[Windows](https://github.com/purocean/yn/releases/download/v3.57.0/Yank-Note-win-x64-3.57.0.exe) | [macOS arm64](https://github.com/purocean/yn/releases/download/v3.57.0/Yank-Note-mac-arm64-3.57.0.dmg) | [macOS x64](https://github.com/purocean/yn/releases/download/v3.57.0/Yank-Note-mac-x64-3.57.0.dmg) | [Linux AppImage](https://github.com/purocean/yn/releases/download/v3.57.0/Yank-Note-linux-x86_64-3.57.0.AppImage) | [Linux deb](https://github.com/purocean/yn/releases/download/v3.57.0/Yank-Note-linux-amd64-3.57.0.deb)
 
-1. feat: upgrade Electron to 22.3.17
-2. feat: optimize the popup position of context menu when space is limited
-3. feat: add file-related operations to the context menu of file tabs
-4. feat: Prompt whether to create a new file when switching to a non-existent file
-5. feat(plugin): add `file-tabs.close-tabs` Action
-6. feat(plugin): add extension methods to the context menu of file tabs
+1. feat: introducing the $seq method in the macro to generate sequential numbers like Figure-1, Figure-2.
+2. feat: added configuration to hide the main window upon startup.
+3. feat: implemented a configuration option to automatically add to-dos to the completion time.
+4. feat: implemented size restriction for generated historical version files.
+5. feat: enhanced scrolling behavior for the details tag when clicked.
+6. fix: resolved the issue of extra blank lines at the end of copied code blocks.
 
 [More release notes](https://github.com/purocean/yn/releases)
 

README_ZH-CN.md

@@ -76,16 +76,16 @@
 
 ## 更新日志
 
-### [v3.56.4](https://github.com/purocean/yn/releases/tag/v3.56.4) 2023-07-23
+### [v3.57.0](https://github.com/purocean/yn/releases/tag/v3.57.0) 2023-07-31
 
-[Windows](https://github.com/purocean/yn/releases/download/v3.56.4/Yank-Note-win-x64-3.56.4.exe) | [macOS arm64](https://github.com/purocean/yn/releases/download/v3.56.4/Yank-Note-mac-arm64-3.56.4.dmg) | [macOS x64](https://github.com/purocean/yn/releases/download/v3.56.4/Yank-Note-mac-x64-3.56.4.dmg) | [Linux AppImage](https://github.com/purocean/yn/releases/download/v3.56.4/Yank-Note-linux-x86_64-3.56.4.AppImage) | [Linux deb](https://github.com/purocean/yn/releases/download/v3.56.4/Yank-Note-linux-amd64-3.56.4.deb)
+[Windows](https://github.com/purocean/yn/releases/download/v3.57.0/Yank-Note-win-x64-3.57.0.exe) | [macOS arm64](https://github.com/purocean/yn/releases/download/v3.57.0/Yank-Note-mac-arm64-3.57.0.dmg) | [macOS x64](https://github.com/purocean/yn/releases/download/v3.57.0/Yank-Note-mac-x64-3.57.0.dmg) | [Linux AppImage](https://github.com/purocean/yn/releases/download/v3.57.0/Yank-Note-linux-x86_64-3.57.0.AppImage) | [Linux deb](https://github.com/purocean/yn/releases/download/v3.57.0/Yank-Note-linux-amd64-3.57.0.deb)
 
-1. feat: 升级 Electron 到 22.3.17
-2. feat: 优化当空间不够时上下文菜单弹出位置
-3. feat: 文件选项卡上下文菜单增加文件相关操作
-4. feat: 切换到一个不存在的文件时，提示是否创建
-5. feat(plugin): 增加 `file-tabs.close-tabs` Action
-6. feat(plugin): 增加文件选项卡上下文菜单拓展方法
+1. feat: 宏增加 `$seq` 方法，用于生成如 `图-1`、`图-2` 这样的序号
+2. feat: 增加启动隐藏主窗口的配置
+3. feat: 增加勾选待办是否自动添加完成时间的配置
+4. feat: 限制生成历史版本文件的大小
+5. feat: 优化点击 `details` 标签时滚动行为
+6. fix: 修复拷贝代码块内容末尾有多余空行的问题
 
 [更多发布说明](https://github.com/purocean/yn/releases)
 

help/FEATURES.md

@@ -641,6 +641,7 @@ If the expression needs to contain [\= or =\], please enter `[\=` or `=\]` to es
 - application version: [= $ctx.version =]
 - current document name: [= $doc.basename =]
 - current time:  [= $ctx.lib.dayjs().format('YYYY-MM-DD HH:mm') =]
+- sequence: [= $seq`Figure-` =] | [= $seq`Figure-` =] | [= $seq`Figure-` =] | [= $seq`Table-` =] | [= $seq`Table-` =]
 - qualifier escape:  [= '[\= =\]' =]
 - Arithmetic:  [= (1 + 2) / 2 =]
 - reference file (support 3 levels of nesting, you can use Front Matter variable defined in the target document):
@@ -680,6 +681,7 @@ variable name | type | description
 `$afterMacro` | `(fn: (src: string) => string) => Result` | Define a macro-replaced callback function that can be used for further processing of the replaced text.
 `$noop` | `() => Result` | no operation, Used for holding text space
 `$doc` | `object` | Current document information
+`$seq` | `(label: string) => Result` | Sequence
 `$doc.basename` | `string` | File name of current document (no suffix)
 `$doc.name` | `string` | File name of current document
 `$doc.path` | `string` | Current document path

help/FEATURES_ZH-CN.md

@@ -641,6 +641,7 @@ Front Matter 中的 `define` 字段可以定义一些文本替换映射。支持
 - 应用版本：[= $ctx.version =]
 - 当前文档名: [= $doc.basename =]
 - 当前时间: [= $ctx.lib.dayjs().format('YYYY-MM-DD HH:mm') =]
+- 计数器: [= $seq`图-` =] | [= $seq`图-` =] | [= $seq`图-` =] | [= $seq`表-` =] | [= $seq`表-` =]
 - 限定符转义: [= '[\= =\]' =]
 - 四则运算: [= (1 + 2) / 2 =]
 - 引用文件（支持最多嵌套 3 层，可使用目标文档中定义的 Front Matter 变量)
@@ -679,6 +680,7 @@ Front Matter 中的 `define` 字段可以定义一些文本替换映射。支持
 `$export` | `(key: string, val: any) => Result` | 定义一个本文档可以使用的变量
 `$noop` | `() => Result` | 无操作函数，可用于文本占位使用
 `$afterMacro` | `(fn: (src: string) => string) => Result` | 定义一个宏替换后的回调函数，可用于对替换后的文本进行进一步处理。
+`$seq` | `(label: string) => Result` | 文档内部计数器
 `$doc` | `object` | 当前文档信息
 `$doc.basename` | `string` | 当前文档文件名（无后缀）
 `$doc.name` | `string` | 当前文档文件名

package.json

@@ -1,6 +1,6 @@
 {
   "name": "yank.note",
-  "version": "3.56.4",
+  "version": "3.57.0",
   "description": "Yank Note: A highly extensible Markdown editor, designed for productivity.",
   "main": "dist/main/app.js",
   "license": "AGPL-3.0",
@@ -103,7 +103,7 @@
     "crypto-js": "^3.3.0",
     "dom-to-image": "^2.6.0",
     "electron": "22.3.17",
-    "electron-builder": "^24.4.0",
+    "electron-builder": "^23.6.0",
     "electron-notarize": "^1.2.2",
     "eslint": "^7.11.0",
     "eslint-plugin-import": "^2.20.2",

src/main/app.ts

@@ -234,7 +234,11 @@ const createWindow = () => {
   win && win.loadURL(getUrl())
   restoreWindowBounds()
   win.on('ready-to-show', () => {
-    win!.show()
+    if (config.get('hide-main-window-on-startup', false)) {
+      hideWindow()
+    } else {
+      win!.show()
+    }
     skipBeforeUnloadCheck = false
   })
 

src/main/server/file.ts

@@ -86,16 +86,23 @@ function writeHistoryZip (zip: AdmZip, zipFilePath: string) {
 }
 
 async function writeHistory (filePath: string, content: any) {
-  const limit = Math.min(10000, config.get('doc-history.number-limit', 500))
+  let limit = Math.min(10000, config.get('doc-history.number-limit', 500))
   if (limit < 1) {
     return
   }
 
   const historyFilePath = getHistoryFilePath(filePath)
 
   let zip: AdmZip
+  let tooLarge = false
 
   if ((await fs.pathExists(historyFilePath))) {
+    const stats = await fs.stat(historyFilePath)
+    if (stats.size > 1024 * 1024 * 5) { // 5M
+      console.log('history file too large, limit max versions.', historyFilePath, stats.size)
+      tooLarge = true
+    }
+
     zip = readHistoryZip(historyFilePath)
   } else {
     zip = new AdmZip()
@@ -105,7 +112,12 @@ async function writeHistory (filePath: string, content: any) {
 
   zip.addFile(dayjs().format('YYYY-MM-DD HH-mm-ss') + ext, content)
 
-  orderBy(zip.getEntries(), x => x.entryName, 'desc').slice(limit).forEach(entry => {
+  const entries = zip.getEntries()
+  if (tooLarge) {
+    limit = Math.min(limit, Math.floor(entries.length / 3 * 2))
+  }
+
+  orderBy(entries, x => x.entryName, 'desc').slice(limit).forEach(entry => {
     if (!entry.comment) {
       zip.deleteFile(entry)
     }
@@ -376,14 +388,17 @@ export function historyList (repo: string, path: string) {
     const historyFilePath = getHistoryFilePath(filePath)
 
     if (!(await fs.pathExists(historyFilePath))) {
-      return []
+      return { list: [], size: 0 }
     }
 
+    const stats = await fs.stat(historyFilePath)
     const zip = readHistoryZip(historyFilePath)
-    return orderBy(zip.getEntries(), x => x.entryName, 'desc').map(x => ({
+    const list = orderBy(zip.getEntries(), x => x.entryName, 'desc').map(x => ({
       name: x.entryName,
       comment: x.comment
     }))
+
+    return { list, size: stats.size }
   }, path)
 }
 

src/renderer/components/DocHistory.vue

@@ -3,7 +3,7 @@
     <div class="history-wrapper" v-if="currentDoc" @click.stop>
       <div class="history">
         <div class="versions-wrapper" v-if="versions && versions.length">
-          <div v-if="listType === 'all'" class="clear" @click="clearVersions">{{$t('doc-history.clear')}}</div>
+          <div v-if="listType === 'all'" class="clear" @click="clearVersions">{{$t('doc-history.clear')}}({{sizeText}})</div>
           <GroupTabs class="tabs" :tabs="getListTypes()" v-model="listType" />
           <div class="versions" v-if="xVersions && xVersions.length">
             <div
@@ -100,6 +100,7 @@ const getListTypes = () => [
 const currentDoc = ref<Doc | null>(null)
 const currentVersion = ref<Version>()
 const versions = ref<Version[] | null>([])
+const size = ref(0)
 const content = ref('')
 const displayType = ref<'content' | 'diff'>('content')
 const listType = ref<'all' | 'marked'>('all')
@@ -116,6 +117,11 @@ const xVersions = computed(() => {
   return versions.value
 })
 
+const sizeText = computed(() => {
+  const val = Math.round(size.value / 1024)
+  return val > 1024 ? `${Math.round(val / 1024)}M` : `${val}K`
+})
+
 function show (doc?: Doc) {
   doc ??= currentFile.value!
   currentDoc.value = doc
@@ -133,12 +139,22 @@ function show (doc?: Doc) {
 function hide () {
   currentDoc.value = null
   versions.value = null
+  size.value = 0
 }
 
 async function fetchVersions () {
   try {
     versions.value = null
-    versions.value = (currentDoc.value ? await fetchHistoryList(currentDoc.value) : []).map(({ name: value, comment }) => {
+    size.value = 0
+
+    let list: any[] = []
+    if (currentDoc.value) {
+      const data = await fetchHistoryList(currentDoc.value!)
+      list = data.list
+      size.value = data.size
+    }
+
+    versions.value = list.map(({ name: value, comment }) => {
       const arr = value.split('.')
       const name = arr[0]
       const encrypted = isEncrypted({ type: 'file', path: value })

src/renderer/others/setting-schema.ts

@@ -316,7 +316,15 @@ const schema: SettingSchema = ({
     },
     'keep-running-after-closing-window': {
       defaultValue: !isMacOS,
-      title: 'T_setting-panel.keep-running-after-closing-window',
+      title: 'T_setting-panel.schema.keep-running-after-closing-window',
+      type: 'boolean',
+      group: 'other',
+      format: 'checkbox',
+      required: true,
+    },
+    'hide-main-window-on-startup': {
+      defaultValue: false,
+      title: 'T_setting-panel.schema.hide-main-window-on-startup',
       type: 'boolean',
       group: 'other',
       format: 'checkbox',

src/renderer/plugins/markdown-code-copy.ts

@@ -93,7 +93,7 @@ export default {
             h('div', { class: 'p-mcc-language' }, token.info),
             h(
               'div',
-              { class: 'p-mcc-copy-btn copy-text', 'data-text': code, title: ctx.i18n.t('copy-code') },
+              { class: 'p-mcc-copy-btn copy-text', 'data-text': code.replace(/\n$/, ''), title: ctx.i18n.t('copy-code') },
               h(SvgIcon, { name: 'clipboard', style: 'pointer-events: none' })
             ),
           ]))

src/renderer/plugins/markdown-macro.ts

@@ -31,6 +31,17 @@ const globalVars = {
   $noop: noop,
 }
 
+function createSeq () {
+  const counters: Record<string, number> = {}
+  return function (str = '') {
+    if (!counters[str]) {
+      counters[str] = 0
+    }
+    counters[str]++
+    return `${str}${counters[str]}`
+  }
+}
+
 function lineCount (str: string) {
   let s = 1
   const len = str.length
@@ -309,6 +320,7 @@ export default {
         const vars: Record<string, any> = { ...globalVars, ...env.attributes }
 
         vars.$include = include.bind(null, { ...options, belongDoc: file, count: 0, vars })
+        vars.$seq = createSeq()
         vars.$doc = {
           basename: file.name ? file.name.substring(0, file.name.lastIndexOf('.')) : '',
           ...ctx.lib.lodash.pick(env.file, 'name', 'repo', 'path', 'content', 'status')

src/renderer/plugins/switch-todo.ts

@@ -13,8 +13,12 @@ export default {
         checked = !lineText.match(/^\s*[-+*]\s+\[x\]/)
       }
 
+      const doneStr = ctx.setting.getSetting('editor.todo-with-time', true)
+        ? `[x] ~~${ctx.lib.dayjs().format('YYYY-MM-DD HH:mm')}~~`
+        : '[x]'
+
       const value = checked
-        ? lineText.replace('[ ]', `[x] ~~${ctx.lib.dayjs().format('YYYY-MM-DD HH:mm')}~~`)
+        ? lineText.replace('[ ]', doneStr)
         : lineText.replace(/(\[x\] ~~[\d-: ]+~~|\[x\])/, '[ ]')
 
       if (value !== lineText) {
@@ -68,5 +72,16 @@ export default {
 
       return false
     })
+
+    ctx.setting.changeSchema(schema => {
+      schema.properties['editor.todo-with-time'] = {
+        defaultValue: true,
+        title: 'T_setting-panel.schema.editor.todo-with-time',
+        type: 'boolean',
+        format: 'checkbox',
+        group: 'editor',
+        required: true,
+      }
+    })
   }
 } as Plugin

src/renderer/plugins/sync-scroll.ts

@@ -62,7 +62,7 @@ export default {
 
     function clickScroll (e: MouseEvent) {
       const _target = e.target as HTMLElement
-      if (['button', 'div', 'img', 'input', 'canvas'].includes(_target.tagName.toLowerCase())) {
+      if (['button', 'div', 'img', 'input', 'canvas', 'details', 'summary'].includes(_target.tagName.toLowerCase())) {
         return
       }
 

src/renderer/support/api.ts

@@ -162,7 +162,7 @@ export async function deleteFile (file: FileItem): Promise<ApiResult<any>> {
   return fetchHttp(`/api/file?path=${encodeURIComponent(path)}&repo=${encodeURIComponent(repo)}`, { method: 'DELETE' })
 }
 
-export async function fetchHistoryList (file: PathItem): Promise<{name: string, comment: string}[]> {
+export async function fetchHistoryList (file: PathItem): Promise<{size: number, list: {name: string, comment: string}[]}> {
   const { path, repo } = file
   const { data } = await fetchHttp(`/api/history/list?path=${encodeURIComponent(path)}&repo=${encodeURIComponent(repo)}`)
   return data

src/renderer/types.ts

@@ -300,6 +300,7 @@ export interface BuildInSettings {
   'editor.enable-preview': boolean,
   'editor.font-family': string,
   'editor.complete-emoji': boolean,
+  'editor.todo-with-time': boolean,
   'render.md-html': boolean,
   'render.md-breaks': boolean,
   'render.md-linkify': boolean,
@@ -325,6 +326,7 @@ export interface BuildInSettings {
   'extension.registry': RegistryHostname,
   'extension.auto-upgrade': boolean,
   'keep-running-after-closing-window': boolean,
+  'hide-main-window-on-startup': boolean,
   'plantuml-api': string,
 }
 

src/share/i18n/languages/en.ts

@@ -348,7 +348,6 @@ const data = {
     'add': 'Add %s',
     'delete-warning': 'Are you sure you want to remove this node?',
     'error-choose-repo-path': 'Please choose repository path',
-    'keep-running-after-closing-window': 'Keep Running after Closing Window',
     'tabs': {
       'repos': 'Repositories',
       'appearance': 'Appearance',
@@ -378,6 +377,7 @@ const data = {
         'enable-preview': 'Enable Preview - Open new files using temporary tabs, double click the tab to change',
         'font-family': 'Font Family',
         'complete-emoji': 'Complete Emoji - Input : to display emoji list',
+        'todo-with-time': 'Add time when checking todo',
       },
       'render': {
         'md-html': 'Enable HTML',
@@ -431,6 +431,8 @@ const data = {
         'match-placeholder': '%foo%',
         'replace-placeholder': '%foo% -> BAR',
       },
+      'hide-main-window-on-startup': 'Hide Main Window on Startup',
+      'keep-running-after-closing-window': 'Keep Running after Closing Window',
     }
   },
   'quick-open': {

src/share/i18n/languages/zh-CN.ts

@@ -349,7 +349,6 @@ const data: BaseLanguage = {
     'add': '添加%s',
     'delete-warning': '确定要删除吗？',
     'error-choose-repo-path': '请选择储存位置',
-    'keep-running-after-closing-window': '关闭窗口后保持运行',
     'schema': {
       'repos': {
         'repos': '仓库',
@@ -369,6 +368,7 @@ const data: BaseLanguage = {
         'enable-preview': '开启预览 - 打开新文件使用临时标签，双击标签以更改',
         'font-family': '字体',
         'complete-emoji': '自动补全 Emoji - 输入 : 时显示 Emoji 列表',
+        'todo-with-time': '勾选待办事项时自动添加时间',
       },
       'render': {
         'md-html': '启用 HTML',
@@ -422,6 +422,8 @@ const data: BaseLanguage = {
         'match-placeholder': '%foo%',
         'replace-placeholder': '%foo% -> BAR',
       },
+      'keep-running-after-closing-window': '关闭窗口后保持运行',
+      'hide-main-window-on-startup': '启动时隐藏主窗口',
     },
     'tabs': {
       'repos': '仓库',