Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Use the #!/usr/bin/env bash shebang #74

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ $ shdoc < lib.sh > doc.md
_Source_ [examples/readme-example.sh](examples/readme-example.sh)<br />
_Output_: [examples/readme-example.md](examples/readme-example.md)<br/><br/>
~~~bash
#!/bin/bash
#!/usr/bin/env bash
# @file libexample
# @brief A library that solves some common problems.
# @description
Expand Down Expand Up @@ -153,7 +153,7 @@ file.
**Example**

```bash
#!/bin/bash
#!/usr/bin/env bash
# @name MyLibrary
```

Expand All @@ -167,7 +167,7 @@ A brief line about the project. Can be specified once in the beginning of the fi

**Example**
```bash
#!/bin/bash
#!/usr/bin/env bash
# @brief A library to solve a few problems.
```

Expand All @@ -180,7 +180,7 @@ A multiline description of the project/section/function.

**Example**
```bash
#!/bin/bash
#!/usr/bin/env bash
# @description A long description of the library.
# Second line of the project description.

Expand Down
2 changes: 1 addition & 1 deletion examples/readme-example.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash
# @file libexample
# @brief A library that solves some common problems.
# @description
Expand Down
2 changes: 1 addition & 1 deletion tests/run_tests
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash

set -euo pipefail

Expand Down
2 changes: 1 addition & 1 deletion tests/testcases/@function-declaration.test.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash

tests:put input <<EOF
# @name Project Name
Expand Down
2 changes: 1 addition & 1 deletion tests/testcases/@[email protected]
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash

tests:put input <<EOF
# @name Project Name
Expand Down
2 changes: 1 addition & 1 deletion tests/testcases/@option.test.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash
# @file test/testcases/@optional-arguments.test.sh
# @author Pierre-Yves Landuré < contact at biapy dot fr >
# @brief Test cases for @option keyword with options.
Expand Down
2 changes: 1 addition & 1 deletion tests/testcases/@see.test.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash
# @file test/testcases/@see.test.sh
# @author Pierre-Yves Landuré < contact at biapy dot fr >
# @brief Test cases for @see keyword.
Expand Down
2 changes: 1 addition & 1 deletion tests/testcases/@set.test.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash

tests:put input <<EOF
# @name Project Name
Expand Down
2 changes: 1 addition & 1 deletion tests/testcases/@stderr.test.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash
# @file test/testcases/@stderr.test.sh
# @author Pierre-Yves Landuré < contact at biapy dot fr >
# @brief Test cases for @stderr keyword.
Expand Down
2 changes: 1 addition & 1 deletion tests/testcases/@stdin.test.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash
# @file test/testcases/@stdin.test.sh
# @author Pierre-Yves Landuré < contact at biapy dot fr >
# @brief Test cases for @stdin keyword.
Expand Down
2 changes: 1 addition & 1 deletion tests/testcases/@stdout.test.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash
# @file test/testcases/@stdout.test.sh
# @author Pierre-Yves Landuré < contact at biapy dot fr >
# @brief Test cases for @stdout keyword.
Expand Down
2 changes: 1 addition & 1 deletion tests/testcases/[email protected]
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash

tests:put input <<EOF
# @description Same, as \`tests:eval\`, but writes stdout into given variable and
Expand Down
2 changes: 1 addition & 1 deletion tests/testcases/function-tags.test.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash

tests:put input <<EOF
# @description Multiline description goes here and
Expand Down
4 changes: 2 additions & 2 deletions tests/testcases/global-tags.test.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
#!/usr/bin/env bash

tests:put input <<EOF
#!/bin/bash
#!/usr/bin/env bash
#
# @file Title of file script
# @brief Small description of the script.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
#!/usr/bin/env bash

tests:put input <<EOF
#!/bin/bash
#!/usr/bin/env bash

# @description a desc for fn1
fn1() {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
#!/usr/bin/env bash

tests:put input <<EOF
#!/bin/bash
#!/usr/bin/env bash

# @description a desc for fn1
# @see fn2()
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
#!/usr/bin/env bash

tests:put input <<EOF
#!/bin/bash
#!/usr/bin/env bash

# @arg \$1 string fn var.
# @stdout result of fn
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash

tests:put input <<EOF
#!/sbin/sh
Expand Down
2 changes: 1 addition & 1 deletion tests/testcases/numbered-arguments.test.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash
# @file test/testcases/@numbered-arguments.test.sh
# @author Pierre-Yves Landuré < contact at biapy dot fr >
# @brief Test cases for @arg keyword.
Expand Down
2 changes: 1 addition & 1 deletion tests/testcases/table-of-contents.test.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash

tests:put input <<EOF
# @description example function 1
Expand Down