@scribdown/shared 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 GrainFull
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,132 @@
+/**
+ * 平台类型枚举。
+ */
+declare enum PlatformType {
+    BrowserExtension = "browser-extension",
+    VscodeExtension = "vscode-extension"
+}
+/**
+ * 默认主题类型枚举。
+ */
+declare enum ThemeType {
+    Paper = "paper",
+    Sketch = "sketch"
+}
+
+/**
+ * 当前项目展示名称。
+ */
+declare const PROJECT_NAME = "Scribdown";
+/**
+ * 当前项目主页地址（部署在 GitHub Pages 的项目站点，带 /scribdown/ 子路径）。
+ */
+declare const PROJECT_HOMEPAGE_URL = "https://share-man-man.github.io/scribdown/";
+/**
+ * 当前项目固定 Node.js LTS 版本。
+ */
+declare const NODE_LTS_VERSION = "24.15.0";
+/**
+ * 当前项目支持的平台列表。
+ */
+declare const SUPPORTED_PLATFORMS: PlatformType[];
+/**
+ * 当前项目默认主题。
+ */
+declare const DEFAULT_THEME = ThemeType.Paper;
+/**
+ * VS Code 预览命令 ID。
+ */
+declare const OPEN_PREVIEW_COMMAND = "scribdown.openPreview";
+/**
+ * Markdown 语言 ID。
+ */
+declare const MARKDOWN_LANGUAGE_ID = "markdown";
+/**
+ * Scribdown 页面根容器 class。
+ */
+declare const SCRIBDOWN_PAGE_CLASS_NAME = "scribdown-page";
+/**
+ * Scribdown 应用布局容器 class。
+ */
+declare const SCRIBDOWN_APP_CLASS_NAME = "scribdown-app";
+/**
+ * Scribdown Markdown 渲染容器 class。
+ */
+declare const SCRIBDOWN_MARKDOWN_CLASS_NAME = "scribdown-markdown";
+/**
+ * 块级元素源码起始行号的 data 属性名，用于编辑器与预览的双向滚动对齐。
+ */
+declare const SOURCE_LINE_DATA_ATTRIBUTE = "data-source-line";
+/**
+ * 编辑器光标所在源码行对应预览块的高亮 class。
+ */
+declare const SOURCE_LINE_ACTIVE_CLASS_NAME = "scribdown-source-line-active";
+/**
+ * 高亮块位于预览视口外时，提示其方向的边缘弧形闪烁 class。
+ */
+declare const SOURCE_LINE_OFFSCREEN_HINT_CLASS_NAME = "scribdown-source-line-offscreen-hint";
+/**
+ * 边缘提示位于视口顶部（高亮块在视口上方）的修饰 class。
+ */
+declare const SOURCE_LINE_OFFSCREEN_HINT_TOP_CLASS_NAME = "scribdown-source-line-offscreen-hint--top";
+/**
+ * 边缘提示位于视口底部（高亮块在视口下方）的修饰 class。
+ */
+declare const SOURCE_LINE_OFFSCREEN_HINT_BOTTOM_CLASS_NAME = "scribdown-source-line-offscreen-hint--bottom";
+/**
+ * 浮动工具栏容器 class。
+ */
+declare const SCRIBDOWN_TOOLBAR_CLASS_NAME = "scribdown-toolbar";
+/**
+ * 工具栏单个按钮 class。
+ */
+declare const SCRIBDOWN_TOOLBAR_BTN_CLASS_NAME = "scribdown-toolbar-btn";
+/**
+ * 工具栏目录面板 class。
+ */
+declare const SCRIBDOWN_TOOLBAR_TOC_PANEL_CLASS_NAME = "scribdown-toolbar-toc-panel";
+/**
+ * 工具栏「当前章节指示器」class：位于目录按钮左侧，随滚动展示当前可视区所属标题。
+ */
+declare const SCRIBDOWN_TOOLBAR_CURRENT_CLASS_NAME = "scribdown-toolbar-current";
+/**
+ * 工具栏挂载时附加到 container 上的 class，把 container 标记为 TOC + 正文的 flex 容器。
+ */
+declare const SCRIBDOWN_TOC_HOST_CLASS_NAME = "scribdown-toc-host";
+/**
+ * 工具栏挂载时用于包裹 container 已有内容的 wrapper class，作为 flex 流中的正文 item，与 TOC 横向并列。
+ * 自身 flex:1 填满 TOC 之外的剩余宽度，并作为内部滚动层的定位上下文（position:relative）。
+ */
+declare const SCRIBDOWN_CONTENT_AREA_CLASS_NAME = "scribdown-content-area";
+/**
+ * 正文内部滚动层 class：位于 .scribdown-content-area 内，position:absolute + inset:0 铺满父级，
+ * 由它统一承载正文的横向与纵向滚动（外层 page / content-area 均不滚动）。
+ */
+declare const SCRIBDOWN_CONTENT_SCROLL_CLASS_NAME = "scribdown-content-scroll";
+/**
+ * 通用「细 + 主题色」滚动条 class：各滚动容器（目录侧栏、正文滚动层等）显式 opt-in 引入，
+ * 统一标准 scrollbar-* 与 ::-webkit-scrollbar 兜底配色，避免在多个容器选择器上重复罗列。
+ */
+declare const SCRIBDOWN_THIN_SCROLLBAR_CLASS_NAME = "scribdown-scrollbar-thin";
+/**
+ * 工具栏「更多」下拉菜单容器 class。
+ */
+declare const SCRIBDOWN_TOOLBAR_MENU_CLASS_NAME = "scribdown-toolbar-menu";
+/**
+ * 工具栏「更多」下拉菜单单个菜单项 class。
+ */
+declare const SCRIBDOWN_TOOLBAR_MENU_ITEM_CLASS_NAME = "scribdown-toolbar-menu-item";
+/**
+ * 工具栏「更多」下拉菜单内子项分组容器 class（例：宽度选择下拉）。
+ */
+declare const SCRIBDOWN_TOOLBAR_MENU_GROUP_CLASS_NAME = "scribdown-toolbar-menu-group";
+/**
+ * 工具栏「更多」下拉菜单内子项 class（例：宽度具体档位）。
+ */
+declare const SCRIBDOWN_TOOLBAR_MENU_SUB_ITEM_CLASS_NAME = "scribdown-toolbar-menu-sub-item";
+/**
+ * localStorage 中保存页面内容宽度的 key。
+ */
+declare const CONTENT_WIDTH_STORAGE_KEY = "scribdown-content-width";
+
+export { CONTENT_WIDTH_STORAGE_KEY, DEFAULT_THEME, MARKDOWN_LANGUAGE_ID, NODE_LTS_VERSION, OPEN_PREVIEW_COMMAND, PROJECT_HOMEPAGE_URL, PROJECT_NAME, PlatformType, SCRIBDOWN_APP_CLASS_NAME, SCRIBDOWN_CONTENT_AREA_CLASS_NAME, SCRIBDOWN_CONTENT_SCROLL_CLASS_NAME, SCRIBDOWN_MARKDOWN_CLASS_NAME, SCRIBDOWN_PAGE_CLASS_NAME, SCRIBDOWN_THIN_SCROLLBAR_CLASS_NAME, SCRIBDOWN_TOC_HOST_CLASS_NAME, SCRIBDOWN_TOOLBAR_BTN_CLASS_NAME, SCRIBDOWN_TOOLBAR_CLASS_NAME, SCRIBDOWN_TOOLBAR_CURRENT_CLASS_NAME, SCRIBDOWN_TOOLBAR_MENU_CLASS_NAME, SCRIBDOWN_TOOLBAR_MENU_GROUP_CLASS_NAME, SCRIBDOWN_TOOLBAR_MENU_ITEM_CLASS_NAME, SCRIBDOWN_TOOLBAR_MENU_SUB_ITEM_CLASS_NAME, SCRIBDOWN_TOOLBAR_TOC_PANEL_CLASS_NAME, SOURCE_LINE_ACTIVE_CLASS_NAME, SOURCE_LINE_DATA_ATTRIBUTE, SOURCE_LINE_OFFSCREEN_HINT_BOTTOM_CLASS_NAME, SOURCE_LINE_OFFSCREEN_HINT_CLASS_NAME, SOURCE_LINE_OFFSCREEN_HINT_TOP_CLASS_NAME, SUPPORTED_PLATFORMS, ThemeType };

package/dist/index.js

@@ -0,0 +1,77 @@
+// src/enums.ts
+var PlatformType = /* @__PURE__ */ ((PlatformType2) => {
+  PlatformType2["BrowserExtension"] = "browser-extension";
+  PlatformType2["VscodeExtension"] = "vscode-extension";
+  return PlatformType2;
+})(PlatformType || {});
+var ThemeType = /* @__PURE__ */ ((ThemeType2) => {
+  ThemeType2["Paper"] = "paper";
+  ThemeType2["Sketch"] = "sketch";
+  return ThemeType2;
+})(ThemeType || {});
+
+// src/constants.ts
+var PROJECT_NAME = "Scribdown";
+var PROJECT_HOMEPAGE_URL = "https://share-man-man.github.io/scribdown/";
+var NODE_LTS_VERSION = "24.15.0";
+var SUPPORTED_PLATFORMS = [
+  "browser-extension" /* BrowserExtension */,
+  "vscode-extension" /* VscodeExtension */
+];
+var DEFAULT_THEME = "paper" /* Paper */;
+var OPEN_PREVIEW_COMMAND = "scribdown.openPreview";
+var MARKDOWN_LANGUAGE_ID = "markdown";
+var SCRIBDOWN_PAGE_CLASS_NAME = "scribdown-page";
+var SCRIBDOWN_APP_CLASS_NAME = "scribdown-app";
+var SCRIBDOWN_MARKDOWN_CLASS_NAME = "scribdown-markdown";
+var SOURCE_LINE_DATA_ATTRIBUTE = "data-source-line";
+var SOURCE_LINE_ACTIVE_CLASS_NAME = "scribdown-source-line-active";
+var SOURCE_LINE_OFFSCREEN_HINT_CLASS_NAME = "scribdown-source-line-offscreen-hint";
+var SOURCE_LINE_OFFSCREEN_HINT_TOP_CLASS_NAME = "scribdown-source-line-offscreen-hint--top";
+var SOURCE_LINE_OFFSCREEN_HINT_BOTTOM_CLASS_NAME = "scribdown-source-line-offscreen-hint--bottom";
+var SCRIBDOWN_TOOLBAR_CLASS_NAME = "scribdown-toolbar";
+var SCRIBDOWN_TOOLBAR_BTN_CLASS_NAME = "scribdown-toolbar-btn";
+var SCRIBDOWN_TOOLBAR_TOC_PANEL_CLASS_NAME = "scribdown-toolbar-toc-panel";
+var SCRIBDOWN_TOOLBAR_CURRENT_CLASS_NAME = "scribdown-toolbar-current";
+var SCRIBDOWN_TOC_HOST_CLASS_NAME = "scribdown-toc-host";
+var SCRIBDOWN_CONTENT_AREA_CLASS_NAME = "scribdown-content-area";
+var SCRIBDOWN_CONTENT_SCROLL_CLASS_NAME = "scribdown-content-scroll";
+var SCRIBDOWN_THIN_SCROLLBAR_CLASS_NAME = "scribdown-scrollbar-thin";
+var SCRIBDOWN_TOOLBAR_MENU_CLASS_NAME = "scribdown-toolbar-menu";
+var SCRIBDOWN_TOOLBAR_MENU_ITEM_CLASS_NAME = "scribdown-toolbar-menu-item";
+var SCRIBDOWN_TOOLBAR_MENU_GROUP_CLASS_NAME = "scribdown-toolbar-menu-group";
+var SCRIBDOWN_TOOLBAR_MENU_SUB_ITEM_CLASS_NAME = "scribdown-toolbar-menu-sub-item";
+var CONTENT_WIDTH_STORAGE_KEY = "scribdown-content-width";
+export {
+  CONTENT_WIDTH_STORAGE_KEY,
+  DEFAULT_THEME,
+  MARKDOWN_LANGUAGE_ID,
+  NODE_LTS_VERSION,
+  OPEN_PREVIEW_COMMAND,
+  PROJECT_HOMEPAGE_URL,
+  PROJECT_NAME,
+  PlatformType,
+  SCRIBDOWN_APP_CLASS_NAME,
+  SCRIBDOWN_CONTENT_AREA_CLASS_NAME,
+  SCRIBDOWN_CONTENT_SCROLL_CLASS_NAME,
+  SCRIBDOWN_MARKDOWN_CLASS_NAME,
+  SCRIBDOWN_PAGE_CLASS_NAME,
+  SCRIBDOWN_THIN_SCROLLBAR_CLASS_NAME,
+  SCRIBDOWN_TOC_HOST_CLASS_NAME,
+  SCRIBDOWN_TOOLBAR_BTN_CLASS_NAME,
+  SCRIBDOWN_TOOLBAR_CLASS_NAME,
+  SCRIBDOWN_TOOLBAR_CURRENT_CLASS_NAME,
+  SCRIBDOWN_TOOLBAR_MENU_CLASS_NAME,
+  SCRIBDOWN_TOOLBAR_MENU_GROUP_CLASS_NAME,
+  SCRIBDOWN_TOOLBAR_MENU_ITEM_CLASS_NAME,
+  SCRIBDOWN_TOOLBAR_MENU_SUB_ITEM_CLASS_NAME,
+  SCRIBDOWN_TOOLBAR_TOC_PANEL_CLASS_NAME,
+  SOURCE_LINE_ACTIVE_CLASS_NAME,
+  SOURCE_LINE_DATA_ATTRIBUTE,
+  SOURCE_LINE_OFFSCREEN_HINT_BOTTOM_CLASS_NAME,
+  SOURCE_LINE_OFFSCREEN_HINT_CLASS_NAME,
+  SOURCE_LINE_OFFSCREEN_HINT_TOP_CLASS_NAME,
+  SUPPORTED_PLATFORMS,
+  ThemeType
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/enums.ts","../src/constants.ts"],"sourcesContent":["/**\n * 平台类型枚举。\n */\nexport enum PlatformType {\n  BrowserExtension = \"browser-extension\",\n  VscodeExtension = \"vscode-extension\"\n}\n\n/**\n * 默认主题类型枚举。\n */\nexport enum ThemeType {\n  Paper = \"paper\",\n  Sketch = \"sketch\"\n}\n","import { PlatformType, ThemeType } from \"./enums\";\n\n/**\n * 当前项目展示名称。\n */\nexport const PROJECT_NAME = \"Scribdown\";\n\n/**\n * 当前项目主页地址（部署在 GitHub Pages 的项目站点，带 /scribdown/ 子路径）。\n */\nexport const PROJECT_HOMEPAGE_URL = \"https://share-man-man.github.io/scribdown/\";\n\n/**\n * 当前项目固定 Node.js LTS 版本。\n */\nexport const NODE_LTS_VERSION = \"24.15.0\";\n\n/**\n * 当前项目支持的平台列表。\n */\nexport const SUPPORTED_PLATFORMS: PlatformType[] = [\n  PlatformType.BrowserExtension,\n  PlatformType.VscodeExtension\n];\n\n/**\n * 当前项目默认主题。\n */\nexport const DEFAULT_THEME = ThemeType.Paper;\n\n/**\n * VS Code 预览命令 ID。\n */\nexport const OPEN_PREVIEW_COMMAND = \"scribdown.openPreview\";\n\n/**\n * Markdown 语言 ID。\n */\nexport const MARKDOWN_LANGUAGE_ID = \"markdown\";\n\n/**\n * Scribdown 页面根容器 class。\n */\nexport const SCRIBDOWN_PAGE_CLASS_NAME = \"scribdown-page\";\n\n/**\n * Scribdown 应用布局容器 class。\n */\nexport const SCRIBDOWN_APP_CLASS_NAME = \"scribdown-app\";\n\n/**\n * Scribdown Markdown 渲染容器 class。\n */\nexport const SCRIBDOWN_MARKDOWN_CLASS_NAME = \"scribdown-markdown\";\n\n/**\n * 块级元素源码起始行号的 data 属性名，用于编辑器与预览的双向滚动对齐。\n */\nexport const SOURCE_LINE_DATA_ATTRIBUTE = \"data-source-line\";\n\n/**\n * 编辑器光标所在源码行对应预览块的高亮 class。\n */\nexport const SOURCE_LINE_ACTIVE_CLASS_NAME = \"scribdown-source-line-active\";\n\n/**\n * 高亮块位于预览视口外时，提示其方向的边缘弧形闪烁 class。\n */\nexport const SOURCE_LINE_OFFSCREEN_HINT_CLASS_NAME = \"scribdown-source-line-offscreen-hint\";\n\n/**\n * 边缘提示位于视口顶部（高亮块在视口上方）的修饰 class。\n */\nexport const SOURCE_LINE_OFFSCREEN_HINT_TOP_CLASS_NAME =\n  \"scribdown-source-line-offscreen-hint--top\";\n\n/**\n * 边缘提示位于视口底部（高亮块在视口下方）的修饰 class。\n */\nexport const SOURCE_LINE_OFFSCREEN_HINT_BOTTOM_CLASS_NAME =\n  \"scribdown-source-line-offscreen-hint--bottom\";\n\n/**\n * 浮动工具栏容器 class。\n */\nexport const SCRIBDOWN_TOOLBAR_CLASS_NAME = \"scribdown-toolbar\";\n\n/**\n * 工具栏单个按钮 class。\n */\nexport const SCRIBDOWN_TOOLBAR_BTN_CLASS_NAME = \"scribdown-toolbar-btn\";\n\n/**\n * 工具栏目录面板 class。\n */\nexport const SCRIBDOWN_TOOLBAR_TOC_PANEL_CLASS_NAME =\n  \"scribdown-toolbar-toc-panel\";\n\n/**\n * 工具栏「当前章节指示器」class：位于目录按钮左侧，随滚动展示当前可视区所属标题。\n */\nexport const SCRIBDOWN_TOOLBAR_CURRENT_CLASS_NAME = \"scribdown-toolbar-current\";\n\n/**\n * 工具栏挂载时附加到 container 上的 class，把 container 标记为 TOC + 正文的 flex 容器。\n */\nexport const SCRIBDOWN_TOC_HOST_CLASS_NAME = \"scribdown-toc-host\";\n\n/**\n * 工具栏挂载时用于包裹 container 已有内容的 wrapper class，作为 flex 流中的正文 item，与 TOC 横向并列。\n * 自身 flex:1 填满 TOC 之外的剩余宽度，并作为内部滚动层的定位上下文（position:relative）。\n */\nexport const SCRIBDOWN_CONTENT_AREA_CLASS_NAME = \"scribdown-content-area\";\n\n/**\n * 正文内部滚动层 class：位于 .scribdown-content-area 内，position:absolute + inset:0 铺满父级，\n * 由它统一承载正文的横向与纵向滚动（外层 page / content-area 均不滚动）。\n */\nexport const SCRIBDOWN_CONTENT_SCROLL_CLASS_NAME = \"scribdown-content-scroll\";\n\n/**\n * 通用「细 + 主题色」滚动条 class：各滚动容器（目录侧栏、正文滚动层等）显式 opt-in 引入，\n * 统一标准 scrollbar-* 与 ::-webkit-scrollbar 兜底配色，避免在多个容器选择器上重复罗列。\n */\nexport const SCRIBDOWN_THIN_SCROLLBAR_CLASS_NAME = \"scribdown-scrollbar-thin\";\n\n/**\n * 工具栏「更多」下拉菜单容器 class。\n */\nexport const SCRIBDOWN_TOOLBAR_MENU_CLASS_NAME = \"scribdown-toolbar-menu\";\n\n/**\n * 工具栏「更多」下拉菜单单个菜单项 class。\n */\nexport const SCRIBDOWN_TOOLBAR_MENU_ITEM_CLASS_NAME =\n  \"scribdown-toolbar-menu-item\";\n\n/**\n * 工具栏「更多」下拉菜单内子项分组容器 class（例：宽度选择下拉）。\n */\nexport const SCRIBDOWN_TOOLBAR_MENU_GROUP_CLASS_NAME =\n  \"scribdown-toolbar-menu-group\";\n\n/**\n * 工具栏「更多」下拉菜单内子项 class（例：宽度具体档位）。\n */\nexport const SCRIBDOWN_TOOLBAR_MENU_SUB_ITEM_CLASS_NAME =\n  \"scribdown-toolbar-menu-sub-item\";\n\n/**\n * localStorage 中保存页面内容宽度的 key。\n */\nexport const CONTENT_WIDTH_STORAGE_KEY = \"scribdown-content-width\";\n"],"mappings":";AAGO,IAAK,eAAL,kBAAKA,kBAAL;AACL,EAAAA,cAAA,sBAAmB;AACnB,EAAAA,cAAA,qBAAkB;AAFR,SAAAA;AAAA,GAAA;AAQL,IAAK,YAAL,kBAAKC,eAAL;AACL,EAAAA,WAAA,WAAQ;AACR,EAAAA,WAAA,YAAS;AAFC,SAAAA;AAAA,GAAA;;;ACNL,IAAM,eAAe;AAKrB,IAAM,uBAAuB;AAK7B,IAAM,mBAAmB;AAKzB,IAAM,sBAAsC;AAAA;AAAA;AAGnD;AAKO,IAAM;AAKN,IAAM,uBAAuB;AAK7B,IAAM,uBAAuB;AAK7B,IAAM,4BAA4B;AAKlC,IAAM,2BAA2B;AAKjC,IAAM,gCAAgC;AAKtC,IAAM,6BAA6B;AAKnC,IAAM,gCAAgC;AAKtC,IAAM,wCAAwC;AAK9C,IAAM,4CACX;AAKK,IAAM,+CACX;AAKK,IAAM,+BAA+B;AAKrC,IAAM,mCAAmC;AAKzC,IAAM,yCACX;AAKK,IAAM,uCAAuC;AAK7C,IAAM,gCAAgC;AAMtC,IAAM,oCAAoC;AAM1C,IAAM,sCAAsC;AAM5C,IAAM,sCAAsC;AAK5C,IAAM,oCAAoC;AAK1C,IAAM,yCACX;AAKK,IAAM,0CACX;AAKK,IAAM,6CACX;AAKK,IAAM,4BAA4B;","names":["PlatformType","ThemeType"]}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@scribdown/shared",
+  "version": "0.1.0",
+  "description": "Scribdown 跨端共享的常量、枚举与命名约定。",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/share-man-man/scribdown.git",
+    "directory": "packages/shared"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "lint": "eslint .",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}