nss-util

The package is design to IT department of nextsmartship.

版本号组成

node package 版本号由四部分组成：major.minor.patch[-prerelease]，比如：1.0.2-beta.1，其中 prerelease 可选。

• major：代表主版本号，通常在需要提交不能向下兼容的情况下对该版本号进行升级
• minor：代表次版本号，通常在新增功能时才对该版本号进行升级
• patch：代表修复版本号，升级该版本号通常代表修复一些 bug，但没有新增功能或者存在不向下兼容的功能
• prerelease：带有该版本号的包通常表示在测试阶段，尚未稳定，通常不建议用户安装。(该项目 npm run add-version-prerelease 需要 npm version > 6.4.0, eg: from 0.0.1 to 0.0.1-0，以此类推...)

prerelease 说明

alpha、beta、rc

通常我们会看到三种类型的 prerelease，分别是：alpha、beta、RC，如：

1.1.0-alpha.1
1.1.0-beta.1
1.1.0-rc.1

每种类型的 prerelease 都有其特殊的含义，请不要乱用。

• alpha: 代表内部测试版，会有很多 Bug，是比 beta 更早的版本，一般不建议对外发布
• beta: 相对 alpha 版本已有了很大的改进，但还是存在一些缺陷，需要经过多次测试来进一步消除
• rc：Release Candidate 顾名思义就是正式发布的候选版本。和 Beta 版最大的差别在于 Beta 阶段会一直加入新的功能，但是到了 RC 版本，几乎就不会加入新的功能了，而主要着重于除错! RC 版本是最终发放给用户的最接近正式版的版本，发行后改正 bug 就是正式版了，就是正式版之前的最后一个测试版

Clone to local

If you prefer to do it manually with the cleaner git history

git clone [email protected]:NextSmartShip/nss-util.git
cd nss-util
npm i

Usage

The starter contains the following scripts:

• dev - starts dev server
• build - generates the following bundles: CommonJS (.cjs) ESM (.mjs) and IIFE (.iife.js). The name of bundle is automatically taked from package.json name property
• test - starts jest and runs all tests
• test:coverage - starts jest and run all tests with code coverage report
• lint:scripts - lint .ts files with eslint
• lint:styles - lint .css and .scss files with stylelint
• format:scripts - format .ts, .html and .json files with prettier
• format:styles - format .cs and .scss files with stylelint
• format - format all with prettier and stylelint
• prepare - script for setting up husky pre-commit hook
• uninstall-husky - script for removing husky from repository

Acknowledgment

If you found it useful somehow, I would be grateful if you could leave a star in the project's GitHub repository.

Thank you.