geohey-javascript-sdk

GeoHey JavaScript SDK ======= GeoHey JavaScript SDK是一个面向移动互联网时代，遵循移动优先、向下兼容、保持轻量原则的地图SDK。

Usage no npm install needed!

<script type="module">
  import geoheyJavascriptSdk from 'https://cdn.skypack.dev/geohey-javascript-sdk';
</script>

README

GeoHey JavaScript SDK

GeoHey JavaScript SDK是一个面向移动互联网时代，遵循移动优先、向下兼容、保持轻量原则的地图SDK。

文档

http://dist.geohey.com/g-js/latest/doc/index.html

如何编译

执行build目录下的gulp任务。

  • 监视自动编译 npm run dev

  • 编译debug库 npm run build

  • 编译release库 npm run min

  • 编译模块 gulp build-xxx

  • 清理debug库和release库 gulp clean

  • 生成文档 gulp doc

  • SDK打包 gulp zip

  • 清理SDK gulp clean-zip

  • Release（包括release库、所有模块、文档） npm run release

发布新版本

修改完代码后需要更新版本号： 修改package.json中的version字段，同时要修改src/Start.js和src/Start-esm.js中的G.version变量 然后执行

cd g-js
npm run release
npm publish    # 需要登录npm账号

如何使用JSHint确保代码基本质量

  1. 以Sublime为例，安装JSHint插件
  2. 对代码文件调用JSHint快捷键检查代码质量

如何编写文档

  1. 在doc目录下添加markdown文件
  2. 修改build/config.js文件，添加新加的markdown文件
  3. 运行 gulp doc 生成文档，文档位于dist/doc下

如有必要，修改build/doc-template下的模板HTML(master.html)。

ES6

项目有一个es6分支，将所有代码都改成es6模块化的实现，已经完成，但是没有做详细的测试