介绍
NeosJS 是一套面向网站快速开发的工具集,官网 docs.neosjs.com。它覆盖了从前端工具函数、网络请求、数据存储、媒体与图像处理,到 Vue 组件、Electron 桌面端与工程化开发工具的完整链路。所有包都以 @neosjs/* 的形式发布到 npm,彼此独立、可单独升级。
设计理念
- 按需安装:每个能力都是一个独立的 npm 包,用哪个装哪个,不会引入多余依赖。
- TypeScript 优先:各包均提供完整的类型定义,开发过程中享有类型提示与静态检查。
- Vue 3 生态友好:组件与插件面向 Vue 3 设计;同时大量基础库与框架无关,可在任意 JavaScript / TypeScript 项目中使用。
生态总览
工具库
| 模块 | 说明 | 文档 |
|---|---|---|
utils | 前端通用工具函数库:类型判断、格式化、DOM、颜色、数组 / 对象 / 字符串工具等 | utils |
emitter | 事件订阅 / 发布器,支持多窗口同步消息 | emitter |
exponential-backoff | 指数退避重试,对失败操作按指数递增间隔重试 | exponential-backoff |
timer-logger | 高性能计时器日志,支持浏览器与 Node.js | timer-logger |
web-worker | 简化 Web Worker 的创建与使用 | web-worker |
watermark | 通用水印生成,给页面某个区域加上水印 | watermark |
intro | 轻量级、无依赖的新手引导插件 | intro |
logger | 基于 Pino 的生产级结构化日志库,支持 Node.js、浏览器与 Vue 3 | logger |
网络请求
| 模块 | 说明 | 文档 |
|---|---|---|
request | 基于 axios 的二次封装,内置缓存、请求去重、失败重试 | request |
数据存储
| 模块 | 说明 | 文档 |
|---|---|---|
indexeddb | 简单易用、高性能的 IndexedDB 封装,支持多 Store 管理 | indexeddb |
node-db | Node.js 端数据库操作 | node-db |
sqlite | SQLite 数据库 | sqlite |
媒体与图像
| 模块 | 说明 | 文档 |
|---|---|---|
html-to-pdf | 高性能 HTML 转 PDF,支持中文、分页、水印、页眉页脚 | html-to-pdf |
pdf-viewer | 基于 PDF.js 封装的 Vue 3 PDF 预览器 | pdf-viewer |
screen-shot | 屏幕截图 | screen-shot |
cropper | 图片裁剪 | cropper |
merge-images | 将多个图像合并成一个图像 | merge-images |
recorder | H5 录音 | recorder |
graffiti | H5 涂鸦 | graffiti |
videojs-player | 基于 Video.js 的视频播放器 | videojs-player |
Vue 组件
| 模块 | 说明 | 文档 |
|---|---|---|
components | Vue 3 业务组件库 | 组件总览 |
Electron 桌面端
开发工具
| 模块 | 说明 | 文档 |
|---|---|---|
create-app | 脚手架,快速创建 Vue 3 应用并自动配置项目 | create-app |
eslint-config | NeosJS 的 ESLint 配置 | eslint-config |
release | 通用 CLI,自动执行版本控制与包发布相关任务 | release |
conventional-changelog | conventional-changelog 的 Conventional Commits preset | conventional-changelog |
unplugin-build-message | 将编译信息打印到终端 | unplugin-build-message |
vitepress-theme | NeosJS 的 VitePress 主题(本文档站所用主题) | vitepress-theme |