bash-base - npm Package Compare versions

Comparing version 2.3.1 to 2.3.2

CHANGELOG.md

@@ -0,1 +1,17 @@
+## [2.3.2](https://github.com/zhang-hongjie/bash-base/compare/v2.3.1...v2.3.2) (2020-09-01)
+
+
+### Bug Fixes
+
+* generate livedoc when release ([4c4814b](https://github.com/zhang-hongjie/bash-base/commit/4c4814b012e32eff18669176dc59b2019b53c69a))
+* generate livedoc when release ([3b08cf9](https://github.com/zhang-hongjie/bash-base/commit/3b08cf9a536d63484ef2812d5cb5573c04bf839c))
+* generate livedoc when release ([0a6b5a8](https://github.com/zhang-hongjie/bash-base/commit/0a6b5a8021d240e10cbba7489f5489a86e9987e7))
+* generate livedoc when release ([16632af](https://github.com/zhang-hongjie/bash-base/commit/16632af3a59de3a00ef875ddc051722d1136c13e))
+* generate livedoc when release ([0e75d57](https://github.com/zhang-hongjie/bash-base/commit/0e75d57130e8aad888b8784e106070068d54aa1d))
+* generate livedoc when release ([588d310](https://github.com/zhang-hongjie/bash-base/commit/588d310b2f80f664a45133f804590487d237930b))
+* generate livedoc when release ([d14f445](https://github.com/zhang-hongjie/bash-base/commit/d14f445aed2980f9feed38ad3a3622baf40fb4bc))
+* generate livedoc when release ([a44f297](https://github.com/zhang-hongjie/bash-base/commit/a44f297852e67b96a9544244159c2eded3cba03a))
+* generate livedoc when release ([ea07630](https://github.com/zhang-hongjie/bash-base/commit/ea0763050c997bcb6ed252d1f101c825b3258878))
+* generate livedoc when release ([ec82649](https://github.com/zhang-hongjie/bash-base/commit/ec82649998ad97e97e3eb2ad51a0bd28b0f281f1))
+
 ## [2.3.1](https://github.com/zhang-hongjie/bash-base/compare/v2.3.0...v2.3.1) (2020-09-01)
@@ -2,0 +18,0 @@

CONTRIBUTING.md

@@ -26,12 +26,24 @@ # How to contribute
 
-- Works with bash, docker, git
-- BDD test with [ShellSpec](https://shellspec.info)
-- Code coverage with [Kcov](http://simonkagstrom.github.io/kcov/index.html) and [codecov]()
-- Audit shell script with [shellcheck](https://www.shellcheck.net/)
-- Format shell script with [shfmt](https://github.com/mvdan/sh)
+- Works with docker, git
+- Bash best practices
+    - Audit shell script with [shellcheck](https://www.shellcheck.net/)
+    - Format shell script with [shfmt](https://github.com/mvdan/sh)
+    
+- BDD
+    - BDD test with [ShellSpec](https://shellspec.info)
+    - Code coverage with [Kcov](http://simonkagstrom.github.io/kcov/index.html) and [codecov](https://codecov.io)
+    - 100% coverage
+
 - Respect [Semantic Versioning 2.0.0](https://semver.org/) and [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/)
-- Help input commit message 
-    - CLI: with [Husky](https://github.com/typicode/husky) and [Commitizen](http://commitizen.github.io/cz-cli)
-    - IntelliJ IDEA: plugin [Git Commit Template](https://plugins.jetbrains.com/plugin/9861-git-commit-template)
-- Audit commit message with [Commitlint](https://commitlint.js.org) and [Commitsar](https://commitsar.tech)
+    - Help input commit message 
+        - CLI: with [Husky](https://github.com/typicode/husky) and [Commitizen](http://commitizen.github.io/cz-cli)
+        - IntelliJ IDEA: plugin [Git Commit Template](https://plugins.jetbrains.com/plugin/9861-git-commit-template)
+    - Audit commit message with [Commitlint](https://commitlint.js.org) for local and [Commitsar](https://commitsar.tech) for CI/CD pipeline
+    
+- LiveDoc:
+    - The comment of functions respect the [man page](https://en.wikipedia.org/wiki/Man_page) standards and conventions and use the 5 basic sections (NAME, SYNOPSIS, DESCRIPTION, EXAMPLES, SEE ALSO) 
+    - Format and audit the comment by bash-base function `doc_lint_script_comment`
+    - Generate docs/references.md from function comments by bash-base function `doc_comment_to_markdown`
+    - Generate man page bash-base.1 from docs/references.md by [pandoc](https://pandoc.org)
+    
 - Automatically release a new version with [semantic release](https://semantic-release.gitbook.io/) if need:
@@ -41,5 +53,9 @@ - Analyser the commit message to decide the new version
     - Generate CHANGELOG.md
+    - Build docker image
+    - lint man-styled script comment
+    - Generate docs/references.md and man/bash-base.1
     - Tag and Release on Github
     - Push new release to [npm Registry](https://www.npmjs.com)
     - Push new release to [docker hub](https://hub.docker.com)
+    
 - CICD Workflow config with [NPM](https://docs.npmjs.com/about-npm/) and [Github actions](https://docs.github.com/en/actions)
@@ -46,0 +62,0 @@

package.json

 {
   "name": "bash-base",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "description": "A common lib for creating bash script easily.",
@@ -18,3 +18,6 @@ "private": false,
   "directories": {
-    "man": "man"
+    "man": "man",
+    "doc": "docs",
+    "example": "example",
+    "test": "spec"
   },
@@ -25,3 +28,4 @@ "scripts": {
     "shfmt": "docker run --rm -v \"$(pwd)\":/bash-base -w /bash-base mvdan/shfmt -l -w src/*.sh scripts/*.sh example/*.sh",
-    "lint": "npm run shellcheck && npm run shfmt",
+    "lint:comment": "./scripts/lint-comment.sh",
+    "lint": "npm run shellcheck && npm run shfmt && npm run lint:comment",
     "test": "docker run -it --rm -v \"$(pwd)\":/bash-base -w /bash-base shellspec/shellspec:master-kcov --shell bash spec/*.sh",
@@ -28,0 +32,0 @@ "test:focus": "docker run -it --rm -v \"$(pwd)\":/bash-base -w /bash-base shellspec/shellspec:master-kcov --shell bash --focus spec/*.sh #execute only fIt/fDescribe",

README.md

@@ -28,20 +28,19 @@ # Welcome to [bash-base](https://zhang-hongjie.github.io/bash-base)
 
- you can let YVM (Yarn Version Manager) manage it for you doing :
+#### Import bash-base directly from github during every execution
 
-- `curl -fsSL https://raw.githubusercontent.com/tophat/yvm/master/scripts/install.sh | bash`
-- `yvm install`
-- `yvm use`
+Simply write in console or script:
 
-Or you can install direct a yarn version using the command :
-
-```bash
-curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version [version]
+If to import latest version:
 ```
+source <(curl -fsSL https://raw.githubusercontent.com/zhang-hongjie/bash-base/master/src/bash-base.sh)
+or
+eval "$(curl -fsSL https://raw.githubusercontent.com/zhang-hongjie/bash-base/master/src/bash-base.sh)"
+```
 
-- install [NVM (Node Version Manager)](https://github.com/creationix/nvm)
-
-```bash
-curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.2/install.sh | bash
-curl -o- https://raw.githubusercontent.com/zhang-hongjie/bash-base/v2.2.12/bash-base.sh | bash
+If to import specific version:
 ```
+source <(curl -fsSL https://raw.githubusercontent.com/zhang-hongjie/bash-base/v2.3.1/src/bash-base.sh)
+or
+eval "$(curl -fsSL https://raw.githubusercontent.com/zhang-hongjie/bash-base/v2.3.1/src/bash-base.sh)
+```
 
@@ -54,4 +53,17 @@ ### Install from NPM
 ```
-Then you can find it in `/usr/local/bin/bash-base`
 
+verify the installation
+```
+man bash-base
+```
+
+or simply write in your script:
+```
+# install bash-base from npmjs only if not installed:
+bash-base 2>/dev/null || npm install -g bash-base
+
+# import it
+source bash-base
+```
+
 ### Install from docker
@@ -70,2 +82,3 @@
 ```
+
 ### Example
@@ -75,13 +88,8 @@ See [example](example) folder
 ### Reference
-See [reference](docs/reference.md)
+See [reference](docs/references.md)
 
 ## Contributing
-
 See [How to contribute](CONTRIBUTING.md)
 
-
 ## License
-
 [MIT](https://opensource.org/licenses/MIT).
-
-

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

278947

increased by0.95%

Number of lines in readme file

92

increased by9.52%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes