littlebot
Published on 2025-04-16 / 3 Visits
0

【源码】基于 Svelte 框架的 SDK 与 Web 组件快速搭建项目

项目简介

本项目是一个用于快速搭建 SDK 或者 web components 的种子项目,基于 Svelte 框架开发,提供开箱即用的开发体验,帮助开发者高效开启项目开发。

项目的主要特性和功能

  1. 构建工具支持:同时支持 Rollup 和 Webpack 两种构建工具,满足不同场景下的打包需求。
  2. CSS 处理:使用 node - sass 作为 CSS 预处理器,搭配 postcss 相关插件进行后处理,解决 flexbug 问题、支持未来 CSS 语法、实现 vw 布局。
  3. 代码质量保障:集成 ESLint、Prettier 等代码检测和格式化工具,结合 husky 和 lint - staged 确保代码规范。
  4. 兼容性处理:利用 Babel 及其相关插件和 polyfill 提供对旧版浏览器的兼容性支持。
  5. 文档生成:使用 jsdoc 生成项目文档,虽目前仅解析 readme js,但提供了文档查看路径。

安装使用步骤

前提条件

用户已下载本项目的源码文件。

安装依赖

在项目根目录下执行以下命令安装依赖: bash npx degit 501981732/svelte-sdk-starter demo npm install

开发与构建

使用 Rollup

  • 开发环境: bash npm run rollup:dev
  • 生产构建: bash npm run rollup:build

使用 Webpack

  • 开发环境: bash npm run dev
  • 生产构建: bash npm run build

引入 SDK

在 HTML 文件中引入 SDK: ```html

```

使用示例

javascript let insert = null; window.customTaskSDK({ text: '', insert: new window.customTaskSDK.PromiseToken(function executor(c) { insert = c; }) }); // 某个时刻修改文案 insert({ text: '222' });

查看文档

项目文档路径为:dist/jsdoc/svelte-sdk-starter/1.0.0/index.html

下载地址

点击下载 【提取码: 4003】【解压密码: www.makuang.net】