- Project Overview
- What's Included?
- Installation
- Available Support
- Badges
- Project Supporters
- Author/Maintainer
- Security
- Contributors
- Copyright & Attributions
- License
- Resources
- Community
REPOSITORY DOCUMENTATION
The Bash-Bits Import Module - The most important and magical part of Bash-Bits!
BB-Import is THE library you are going to end up using in EVERY Bash script you write from now on!
It's obviously a utility which imports external code / libraries into your scripts ... it's HOW BB-Import does it which is special. Not just for installing Bash-Bits modules, you can use BB-Import in any of 4 different ways to import ANY script from ANY server on the planet directly into YOUR code!
And that's not even the best bit! Once BB-Import has downloaded that project / repo / script to your local machine, it is cached FOREVER - which means rather than downloading it from the internet every time you want to use your software, BB-Import will download it all once, and from then on will use its locally-cached version unless it's told to go and get a new version.
AND THE NEXT VERSION WILL EVEN KEEP TRACK OF THE LATEST VERSIONS OF ALL OF YOUR IMPORTS AND RECOMMEND UPDATES!! That means you're GUARANTEED to always have the very latest available versions of all of your dependencies, FOREVERMORE (or until you decide to stop using Bash-Bits for some reason ... but why would you do that???)
USAGE EXAMPLES:
#!/usr/bin/env bb-import # SHEBANG INSTALL - Modify your system $PATH
source ~/.bb/bb-import.sh # SOURCE INSTALL - Simple and effective
bb-import bb-ansi # IMPLICIT IMPORT - Official Bash-Bits Modules
bb-import myaccount/myrepo # NAMESPACED IMPORT - Formatted GitHub Project
bb-import https://myserver.com/project # EXPLICIT IMPORT - Custom Download Location
bb-import ../../myfile.sh # RELATIVE IMPORT - Local EnvironmentYou can even specify specific git branches, tags, or versions to import!
bb-import [email protected]
bb-import myaccount/myrepo@mybranch
bb-import https://myserver.com/[email protected]I have to admit that this wasn't my idea. I've modeled BB-Import after the INCREDIBLE
importpw/importproject by Nathan Rajlich, and decided to make a modified version of it a CORE feature of my Bash-Bits project the very moment I laid eyes on it.As always ... I've only been able to do what I do, because I've stood upon the shoulders of giants to do it.
I'll admit, at first glance - especially upon its first release - it might be hard to spot the differences between BB-Import and the project that I based it on, import by Nathan Rajlich. So, I'd like to take a moment to draw your attention to the main points of difference. I'd like to add, the fact that I've done things this way is not at all intended to say that Nathan's solution is wrong or inferior in ANY way - I just saw a way it might be done differently.
BB-Import does not use a server to resolve the location of resources.
BB-Import includes an integrated, but basic logger, to help provide insight into the import process.
It is possible to install BB-Import with a single command in your terminal.
The Branch Reliability Table is a way for you to determine how close to the bleeding edge you're comfortable getting.
If you need stability, then download a branch marked with 🟢
If you're contributing code to the project, you'll want 🔴
| Branch | Stability | Code Age | Reliability |
|---|---|---|---|
master |
latest stable | latest release | 🟢 |
develop |
latest unstable | most recent code | 🔴 |
Repository Files
Repository Documetation
Run the code snippet below in your terminal to setup and install everything automagically - ready to go in 2 minutes!
bash <(curl -sfLS https://raw.githubusercontent.com/bash-bits/bb-import/master/install.sh) |
JetBrains very generously provide me with a free license for their products every month, and you can get one too if you're working on a public, open-source project! I've used JetBrains' IDEs for many years now, and was more than happy to pay for a license every year back when I was working in the corporate sector. Absolutely my first choice in IDEs! |
If sponsorship isn't right for you, but you have found my work to be useful in some way,
would you please consider buying me a coffee to help keep me going?
🔐 Security
While the Bash-Bits project follows good security practices, 100% security can never be guaranteed in any software package. The Bash-Bits Dependency Manager is provided AS IS, and without warranty. You can find more details in the LICENSE file included with this repository.
If you discover any issue regarding the security of this project, please disclose that information responsibly by sending a security advisory. PLEASE DO NOT CREATE AN ISSUE OR DISCUSSION TOPIC. You can read more about this project's security policies HERE
If you'd like to make a contribution, then please see the Bash-Bits Contributor's Guide
It's not just contributions of code that I'm looking for. If you have any ideas or suggestions about how this project may be improved, don't hesitate to open an issue and let me know! Contributions of ALL kinds will be recognised here if they are made part of this project - thanks to the All-Contributors bot.
This project incorporates ideas and / or code crafted by the following talented individuals:
- importpw/import
Copyright © 2018-2020 the Import authors
MIT Licensed
"We see much further, and reach much higher,
only because we stand upon the shoulders of giants"
⚖️ License
Copyright © 2022-2023 Darren (Ragdata) Poulton
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- importpw/import by Nathan Rajlich
![mend-bolt-for-github[bot] avatar](https://avatars.githubusercontent.com/in/16809?v=4 "mend-bolt-for-github[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent