accommodate subpar GNU design choices by joshunrau · Pull Request #20 · DouglasNeuroInformatics/libnest

joshunrau · 2025-03-20T00:22:52Z

https://unix.stackexchange.com/questions/63979/shebang-line-with-usr-bin-env-command-argument-fails-on-linux

Summary by CodeRabbit

Refactor
- Modernized CLI startup scripts to streamline execution of production, build, and development commands.
- Enhanced command handling by enabling additional options for improved flexibility.
- Transitioned to asynchronous module loading for build and development workflows, promoting more efficient task execution.

coderabbitai · 2025-03-20T00:22:59Z

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request refactors multiple CLI scripts, transitioning their execution from a Node.js environment to a shell script wrapper. The changes adjust the shebang lines to use /bin/sh, remove dynamic module registrations in the scripts, and introduce shell variables for directory handling. The shell scripts now invoke Node.js with appropriate flags to execute the corresponding JavaScript files. Additionally, some JavaScript files update their module registration and asynchronous import strategies, and the CLI command definitions are enhanced with explicit executable file paths and relaxed unknown option constraints.

Changes

File(s)	Change Summary
`src/cli/bin/libnest`, `src/cli/bin/libnest-build`, `src/cli/bin/libnest-dev`	Changed shebang from Node.js to `/bin/sh`; removed SWC dynamic imports; added shell variables (`DIR`, `PARENT_DIR`); now call Node with flags (e.g., `--enable-source-maps`, `--watch`) and pass any arguments.
`src/cli/libnest-build.js`	Added import of `node:module` and registered `@swc-node/register/esm`; switched static import of `buildProd` to an asynchronous dynamic import.
`src/cli/libnest-dev.js`	Registered `@swc-node/register/esm` via `node:module`; moved the `program` declaration after registration; removed explicit type annotation from the action callback signature.
`src/cli/libnest.js`	Updated CLI command definitions to allow unknown options and include an `executableFile` property with resolved paths; adjusted asynchronous import for `resolveAbsoluteImportPath`.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant S as Shell Script
    participant N as Node Process
    U->>S: Execute script (libnest / libnest-build / libnest-dev)
    S->>S: Determine DIR and PARENT_DIR
    S->>N: Run "node --enable-source-maps [target].js" "$@"
    N-->>S: Execution result
    S-->>U: Output result

sequenceDiagram
    participant U as User
    participant CLI as CLI Program (libnest.js)
    participant B as Build Wrapper (libnest-build)
    participant D as Dev Wrapper (libnest-dev)
    U->>CLI: Invoke command (build or dev)
    alt Build Command
        CLI->>B: Execute build script (node .../bin/libnest-build)
    else Dev Command
        CLI->>D: Execute dev script (node .../bin/libnest-dev)
    end
    B/D-->>CLI: Return result
    CLI-->>U: Display output

Poem

I'm a little bunny with code so new,
Hopping through scripts with a fresh point of view.
Switching shebangs and paths with a happy twist,
Shell wrappers and async flows can’t be missed.
In every change, a playful prance,
Celebrating progress with a jolly dance!
🐰✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06876aa and 243be15.

📒 Files selected for processing (6)

src/cli/bin/libnest (1 hunks)
src/cli/bin/libnest-build (1 hunks)
src/cli/bin/libnest-dev (1 hunks)
src/cli/libnest-build.js (1 hunks)
src/cli/libnest-dev.js (1 hunks)
src/cli/libnest.js (2 hunks)

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2025-03-20T00:24:11Z

🎉 This PR is included in version 2.3.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

gdevenyi · 2025-03-20T13:50:27Z

This is not "GNU Design choices" this is trying to rely on non-POSIX features in OSX not present in all Unix systems.

gdevenyi · 2025-03-20T13:50:41Z

The POSIX env specification, https://pubs.opengroup.org/onlinepubs/9699919799/utilities/env.html

gdevenyi · 2025-03-20T13:57:19Z

It appears that that GNU extension "-S" is available on Mac, though I am unable to confirm a real system.

https://www.gnu.org/software/coreutils/manual/html_node/env-invocation.html#g_t_002dS_002f_002d_002dsplit_002dstring-usage-in-scripts

Ref:
https://apple.stackexchange.com/questions/297533/does-macos-have-usr-bin-env

joshunrau added 5 commits March 19, 2025 20:07

fix: use shell script for libnest build

90f88fd

fix: use shell script for libnest-dev

e6afee3

fix: use shell script for libnest

52cd37d

fix: register swc

a06bdac

fix: specify exe

243be15

joshunrau merged commit 5994e1f into main Mar 20, 2025
0 of 2 checks passed

github-actions bot added the released label Mar 20, 2025

coderabbitai bot mentioned this pull request Jul 23, 2025

fix: adjust shell scripts to remove dependency on coreutils #61

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

accommodate subpar GNU design choices#20

accommodate subpar GNU design choices#20
joshunrau merged 5 commits intomainfrom
dev

joshunrau commented Mar 20, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Mar 20, 2025 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

github-actions bot commented Mar 20, 2025

Uh oh!

gdevenyi commented Mar 20, 2025

Uh oh!

gdevenyi commented Mar 20, 2025

Uh oh!

gdevenyi commented Mar 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

joshunrau commented Mar 20, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

github-actions bot commented Mar 20, 2025

Uh oh!

gdevenyi commented Mar 20, 2025

Uh oh!

gdevenyi commented Mar 20, 2025

Uh oh!

gdevenyi commented Mar 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

joshunrau commented Mar 20, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 20, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)