V1

.github/workflows/shellcheck-per-file.yml

@@ -0,0 +1,54 @@
+---
+# The idea here is to run Shellcheck for each file, so violations can be fixed
+# incrementally. As soon as a file has been fixed to pass shellcheck, it should
+# no longer be allowed to fail.
+#
+# Once all files have been fixed, the jobs can all be replaced by one single run
+# that checks all files at once.
+#
+# For discussion and further details see: https://github.com/bpkg/bpkg/issues/78
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  allowed_to_fail:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        file:
+          - bpkg.sh
+          - setup.sh
+          - lib/init/init.sh
+          - lib/install/install.sh
+          - lib/json/JSON.sh
+          - lib/suggest/suggest.sh
+    steps:
+      - uses: actions/checkout@v2
+      - uses: pipeline-components/shellcheck@v0.6.1
+        continue-on-error: true
+        with:
+          directory: ${{ matrix.file }}
+          options: -f gcc -x lib/utils/utils.sh
+
+  must_pass:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        file:
+          - lib/getdeps/getdeps.sh
+          - lib/list/list.sh
+          - lib/package/package.sh
+          - lib/show/show.sh
+          - lib/term/term.sh
+          - lib/update/update.sh
+          - lib/utils/utils.sh
+    steps:
+      - uses: actions/checkout@v2
+      - uses: pipeline-components/shellcheck@v0.6.1
+        with:
+          directory: ${{ matrix.file }}
+          options: -f gcc -x lib/utils/utils.sh

.shellcheckrc

@@ -0,0 +1,16 @@
+# shellcheck disable=SC2034
+
+## Allow: To read lines rather than words, pipe/redirect to a 'while read' loop
+disable=SC2013
+
+## Allow: Declare and assign separately to avoid masking return values
+disable=SC2155
+
+## Allow: Prefer mapfile or read -a to split command output (or quote to avoid splitting)
+disable=SC2207
+
+## Allow: Instead of 'let expr', prefer (( expr ))
+disable=SC2219
+
+## Allow: Not following source
+disable=SC1091

README.md

@@ -4,7 +4,7 @@ _JavaScript has npm, Ruby has Gems, Python has pip and now Shell has bpkg!_
 
 `bpkg` is a lightweight bash package manager. It takes care of fetching the shell scripts, installing them appropriately, setting the execution permission and more.
 
-You can install shell scripts globally (on `/usr/local/bin`) or use them on a _per-project basis_ (on `./deps/`), as a lazy-man "copy and paste".
+You can install shell scripts globally (on `${PREFIX:-/usr/local/bin}`) or use them on a _per-project basis_ (on `${BPKG_DEPS:-./deps/}`), as a lazy-man "copy and paste".
 
 <!-- BEGIN-MARKDOWN-TOC -->
 * [Install](#install)
@@ -17,7 +17,7 @@ You can install shell scripts globally (on `/usr/local/bin`) or use them on a _p
 	* [Packages With Dependencies](#packages-with-dependencies)
 	* [Retrieving package info](#retrieving-package-info)
 * [Package details](#package-details)
-* [package.json](#packagejson)
+* [bpkg.json](#bpkgjson)
 	* [name](#name)
 	* [version (optional)](#version-optional)
 	* [description](#description)
@@ -78,8 +78,8 @@ You use `bpkg` by simply sending commands, pretty much like `npm` or `pip`.
 
 ### Installing packages
 
-Packages can either be global (on `/usr/local/bin` if installed as root or
- `$HOME/.local/bin` otherwize) or local (under `./deps`).
+Packages can either be global (on `${PREFIX:-/usr/local/bin}` if installed as root or
+ `${PREFIX:-$HOME/.local/bin}` otherwize) or local (under `${BPKG_DEPS:-./deps}`).
 
 For example, here's a **global install for the current user** of the [term package][term]:
 
@@ -109,17 +109,16 @@ bpkg install jwerle/suggest.sh@0.0.1 -g
 
 **Note:** to do that the packages **must be tagged releases** on the repository.
 
-You can also *install packages without a `package.json`*.
+You can also *install packages without a `bpkg.json` (or `package.json`)*.
 As long as there is a `Makefile` in the repository it will try to invoke `make install` as long as the `-g` or `--global` flags are set when invoking `bpkg install`.
 
-For example you could install [git-standup](https://github.com/stephenmathieson/git-standup) with an omitted `package.json` because of the `Makefile` and the `install` target found in it.
+For example you could install [git-standup](https://github.com/stephenmathieson/git-standup) with an omitted `bpkg.json` (or `package.json`) because of the `Makefile` and the `install` target found in it.
 
 ```sh
 bpkg install stephenmathieson/git-standup -g
 
-    info: Using latest (master)
-    warn: Package doesn't exist
-    warn: Missing build script
+    warn: bpkg.json doesn`t exist
+    warn: package.json doesn`t exist
     warn: Trying `make install'...
     info: install: `make install'
 cp -f git-standup /usr/local/bin
@@ -131,6 +130,10 @@ You can install a packages dependencies with the `bpkg getdeps` command. These w
 
 _Note: There is no protection against circular dependencies, so be careful!_
 
+### Running packages with `bpkg`
+
+You can run a package script with `bpkg run` which will install your
+package globally and execute it as a command
 
 ### Retrieving package info
 
@@ -157,11 +160,12 @@ bpkg package
 
 Here we lay down some info on the structure of a package.
 
-## package.json
+## bpkg.json
 
-Every package must have a file called `package.json`; it specifies package metadata on the [JSON format][json].
+Every package must have a file called `bpkg.json` (for backward-compatibility
+`package.json` can also be used); it specifies package metadata on the [JSON format][json].
 
-Here's an example of a well-formed `package.json`:
+Here's an example of a well-formed `bpkg.json`:
 
 ```json
 {
@@ -242,7 +246,6 @@ This is a hash of dependencies. The keys are the package names, and the values a
   }
 ```
 
-
 ## Packaging best practices
 
 These are guidelines that we strongly encourage developers to follow.
@@ -252,7 +255,7 @@ These are guidelines that we strongly encourage developers to follow.
 It's nice to have a bash package that can be used in the terminal and also be invoked as a command line function. To achieve this the exporting of your functionality *should* follow this pattern:
 
 ```sh
-if [[ ${BASH_SOURCE[0]} != $0 ]]; then
+if [[ ${BASH_SOURCE[0]} != "$0" ]]; then
   export -f my_script
 else
   my_script "${@}"
@@ -274,6 +277,8 @@ my_script some more args --blah
 
 **bpkg** wouldn't be where it is today without the help of its authors, contributors, and sponsors:
 
+* [@socketsupply](https://github.com/socketsupply) ([socketsupply.co](https://socketsupply.co))
+* [@little-core-labs](https://github.com/little-core-labs)
 * [@littlstar](https://github.com/littlstar) ([littlstar.com](https://littlstar.com))
 * [@spotify](https://github.com/spotify) ([spotify.com](https://spotify.com))
 
@@ -295,15 +300,12 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
 This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
 <a href="graphs/contributors"><img src="https://opencollective.com/bpkg/contributors.svg?width=890&button=false" /></a>
 
-
 ### Backers
 
 Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/bpkg#backer)]
 
 <a href="https://opencollective.com/bpkg#backers" target="_blank"><img src="https://opencollective.com/bpkg/backers.svg?width=890"></a>
 
-
-
 ## License
 
 `bpkg` is released under the **MIT license**.

bpkg-run

@@ -0,0 +1 @@
+lib/run/run.sh

bpkg-source

@@ -0,0 +1 @@
+lib/source/source.sh

bpkg.json

@@ -0,0 +1,11 @@
+{
+  "name": "bpkg",
+  "version": "1.0.0",
+  "description": "Lightweight bash package manager",
+  "global": true,
+  "repo": "bpkg/bpkg",
+  "install": "bash setup.sh",
+  "commands": {
+    "lint": "shellcheck $BPKG_SCRIPT_SOURCES"
+  }
+}

bpkg.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 ## prevent sourcing
-if [[ ${BASH_SOURCE[0]} != $0 ]]; then
+if [[ ${BASH_SOURCE[0]} != "$0" ]]; then
   echo >&2 "error: \`bpkg' cannot be sourced"
   return 1
 fi
@@ -24,7 +24,9 @@ usage () {
 ## commands
 commands () {
   {
-    declare -a local cmds=( $(
+    local cmds
+
+    declare -a cmds=( $(
       bpkg-suggest 'bpkg-' |
       tail -n+2            |
       sed 's/.*\/bpkg-//g' |
@@ -38,11 +40,12 @@ commands () {
 
 ## feature tests
 features () {
-  declare -a local features=(bpkg-json bpkg-suggest)
+  local features
+  declare -a features=(bpkg-json bpkg-suggest)
   for ((i = 0; i < ${#features[@]}; ++i)); do
     local f="${features[$i]}"
     if ! type "${f}"  > /dev/null 2>&1; then
-      error "Missing "${f}" dependency"
+      error "Missing \"${f}\" dependency"
       return 1
     fi
   done
@@ -70,7 +73,7 @@ bpkg () {
       echo "Here are some commands available in your path:"
       echo
       local cmds=($(commands))
-      for cmd in ${cmds[@]}; do
+      for cmd in "${cmds[@]}"; do
         echo "    ${cmd}"
       done
       return 0
@@ -88,9 +91,10 @@ bpkg () {
       else
         echo >&2 "error: \`${arg}' is not a bpkg command."
         {
-          declare -a local res=($(commands))
+          local res
+          declare -a res=($(commands))
 
-          if [ ! -z "${res}" ]; then
+          if [ -n "${res[*]}" ]; then
             echo
             echo  >&2 "Did you mean one of these?"
             found=0

lib/getdeps/getdeps.sh

@@ -10,7 +10,7 @@ usage () {
 ## Read a package property
 bpkg_getdeps () {
   local cwd="$(pwd)"
-  local pkg="${cwd}/package.json"
+  local pkg="${cwd}/bpkg.json"
 
   ## parse flags
   case "$1" in
@@ -22,24 +22,29 @@ bpkg_getdeps () {
 
   ## ensure there is a package to read
   if ! test -f "${pkg}"; then
-    echo 2>&1 "error: Unable to find \`package.json' in $(pwd)"
-    return 1
+    pkg="${cwd}/package.json"
+    if ! test -f "${pkg}"; then
+    echo 2>&1 "error: Unable to find \`bpkg.json' or \`package.json' in $cwd"
+      return 1
+    fi
   fi
 
+  # shellcheck disable=SC2002
   dependencies=$(cat "${pkg}" | bpkg-json -b | grep '\[\"dependencies' | sed "s/\[\"dependencies\",//" | sed "s/\"\]$(printf '\t')\"/@/" | tr -d '"')
-  dependencies=($(echo ${dependencies[@]}))
+  # shellcheck disable=SC2206
+  dependencies=(${dependencies[@]})
 
   ## run bpkg install for each dependency
   for (( i = 0; i < ${#dependencies[@]} ; ++i )); do
     (
       local package=${dependencies[$i]}
-      bpkg install ${package}
+      bpkg install "${package}"
     )
   done
   return 0
 }
 
-if [[ ${BASH_SOURCE[0]} != $0 ]]; then
+if [[ ${BASH_SOURCE[0]} != "$0" ]]; then
   export -f bpkg_getdeps
 else
   bpkg_getdeps "${@}"

lib/init/README.md

@@ -1,7 +1,7 @@
 bpkg-init
 =========
 
-Interactively generate a `package.json` for your [bpkg][bp]. Code, format,
+Interactively generate a `bpkg.json` for your [bpkg][bp]. Code, format,
 and instructions based heavily on [jwerle's][jw] [clib-init][cb].
 
 [bp]: https://github.com/bpkg/bpkg/
@@ -29,30 +29,30 @@ usage
 -----
 
 Simply invoke `bpkg init` and you wil be prompted with a series
-of questions about the generation of your `package.json`. Most options
+of questions about the generation of your `bpkg.json`. Most options
 have sane defaults.
 
-This will walk you through initializing the bpkg `package.json` file.
+This will walk you through initializing the bpkg `bpkg.json` file.
 It will prompt you for the bare minimum that is needed and provide
 defaults.
 
 See github.com/bpkg/bpkg for more information on defining the bpkg
-`package.json` file.
+`bpkg.json` file.
 
-You can press `^C` anytime to quit this prompt. The `package.json` file
+You can press `^C` anytime to quit this prompt. The `bpkg.json` file
 will only be written upon completion.
 
 ```sh
 $ bpkg init
 
-This will walk you through initializing the bpkg `package.json` file.
+This will walk you through initializing the bpkg `bpkg.json` file.
 It will prompt you for the bare minimum that is needed and provide
 defaults.
 
 See github.com/bpkg/bpkg for more information on defining the bpkg
-`package.json` file.
+`bpkg.json` file.
 
-You can press ^C anytime to quit this prompt. The `package.json` file
+You can press ^C anytime to quit this prompt. The `bpkg.json` file
 will only be written upon completion.
 
 name: (bpkg-init)

lib/init/package.json → lib/init/bpkg.json

@@ -1,7 +1,7 @@
 {
   "name": "bpkg-init",
-  "version": "0.0.1",
-  "description": "Initialize a bpkg package.json",
+  "version": "0.1.0",
+  "description": "Initialize a bpkg.json",
   "global": "true",
   "install": "make install",
   "scripts": [