liquid-labs / liquid-labs/bash-rollup

Enable 'bash-rollup-always-inline' flag

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Shell
Stars
0
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Overview

By default, bash-rollup will only include a file once. Sometimes, you really do want to 'inline' code.

Deliverables

  • Enable a bash-rollup-always-inline' flag which can be included after sourceandimport` statements. If present, then skip the "is this file included" check and always include the file contents in place.
  • Once included via an always inline, then anything included by tracing through the always inlined script is always inlined. I.e., the 'always inline' flag is sticky for all sub-includes.
  • Emit a warning with line number and line text if a recursively 'always inlined' include is not explicitly marked. E.g.:
    WARNING: 'source foo.sh' @ line 25 in './inlinable.sh' is being processed with 'always inline' implied, but it is not explicitly set.
    

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the code that parses and processes source and import statements, then trace how included files are tracked. Verify that the flag forces repeated inclusion, propagates through sub-includes, and emits the specified warning with the line number and source text when a recursive include is not explicitly marked.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.