Skip to content

imports.md

Latest commit

 

History

History
32 lines (21 loc) · 2.08 KB

imports.md

File metadata and controls

32 lines (21 loc) · 2.08 KB

⬇️ Imports

bb-import offers 4 different types of import:

Name Example Description
Implicit Import + bb-import bb-ansi An Implicit Import is used to import official Bash-Bits modules from GitHub
Namespaced Import + bb-import my-organisation/my-repo A Namespaced Import can be used to import files from ANY GitHub repo
Explicit Import https://example.com/my-project An Explicit Import can be used to import files from ANY live server
Relative Import ../../file.sh Relative Imports are used to import files from your local filesystem
  • Any of these import types can also be used to import a particular git branch, tag or version of a file by adding an @ symbol along with the name, tag or version. EG: bb-import bb-ansi@1.3.0

⭐ Compatible Project Format

Here's the catch you all knew was coming - but it's not a very big one ...

In order to use bb-import to download your project using either an Implicit or Namespaced import, your repo needs to be in a specific format AND hosted at GitHub. The bare minumum is this:

your-org/your-repo
└── src
    └── your-repo.sh

You CAN configure bb-import for hosting providers other than GitHub, by changing the IMPORT_SERVER environment variable - however, the format restriction will still apply.

If you take a look at any of the official Bash-Bits modules, you'll be able to see how flexible this format really can be.

NOTE: The Explicit Import and the Relative Import do NOT need to conform to this format - you can use these import types to import ANY file you like!

^ Top