sj-utility-lib

shangjian utility library

Usage no npm install needed!

<script type="module">
  import sjUtilityLib from 'https://cdn.skypack.dev/sj-utility-lib';
</script>

README

sj_util_lib

shangjian utility library

Build Setup

install dependencies

npm install

serve with hot reload at localhost:8080

npm run dev

build for production with minification

npm run build

add new utility

npm run generate {{category}} {{name}}

npm run generate sort salarySort

editing

文件生成在 /src/utils/{{categoty}}/{{name}}.js 并会自动添加至build列表中.

函数文件应有一个default export作为输出,可在文件中定义其他对default export不产生影响的辅助数据,构建多个函数时创建多个函数文件。

函数的说明文档即函数的JSDoc,请保证输出函数及其JSDoc位于文件顶部。

使用到的JSDoc字段目前有@description,@params,@return@example。JSDoc参考:(http://usejsdoc.org/)

publish

  1. 确保修改package.json 中的版本号
  2. build
  3. publish