dp-easy-storage

Localized persistent storage

Usage no npm install needed!

<script type="module">
  import dpEasyStorage from 'https://cdn.skypack.dev/dp-easy-storage';
</script>

README

easy-storage

项目介绍

基于 TypeScript 的前端数据缓存&持久化工具库。其中包含：

  • Rollup 进行库文件打包
  • Karma + Jasmin 进行单元测试
  • Webpack 进行demo开发
  • Vuepress 进行文档编写

Quick start

Install Dependencies

$ npm i

Build

$ npm run build
  • 使用 Rollup 构建 Typescript 源代码，生成UMD、ESM标准bundle

Release

$ npm run release
  • 自动打包构建
  • 自动提交文件到git，并生成相对应的release-tag
  • 自动发布代码到npm仓库

Unit test

$ npm run test
  • 使用 Karma + Webpack + Jasmin 构建 Typescript 单元测试
  • 直接使用 Typescript 编写单元测试
  • 只有以 *.test.ts 的测试代码会被执行

Demo debug

$ npm run start
  • 使用 Webpack 构建的一个 Web App Demo，可以进行快速开发和调试

Docs

$ npm run docs
  • 使用 Vuepress 编写文档

Directory structure

|- demo
|    |- src/
|    |- index.html  
|- docs
|    |- README.md
│    |- .vuepress
│       |- config.js
|- script/
|    |- build.js
|    |- release.js
|    |- utils.js
|- src/
|- tests/
|- tsconfig.json
|- karma.conf.js
|- webpack.config.js
|- package.json
  • demo: Demo页面目录
    • src: Demo页面源码
    • index.html: 入口页面
  • docs: 文档目录
    • README.md: 文档介绍
    • .vuepress: 配置
  • script: 工具脚本
    • build.js: 构建脚本
    • release.js: 发布脚本
    • utils: shell 工具
  • src: 项目源码
  • tests: 单元测试目录
  • tsconfig.json: typescript配置文件
  • karma.conf.js: karma配置文件，用于单元测试
  • webpack.config.js: webpack 配置文件，用于运行或构建 demo 项目