elliot40404/bonk

The blazingly fast touch alternative with a sprinkle of mkdir written in rust.

Bonk

The blazingly fast touch alternative written in rust. Made for the sole purpose to create files.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

There are many ways to create a file via cli depending on the OS you are on but me currently being on windows, though some command are aliased they don't feel natural (New-Item instead of touch) and I miss using some of the unix commands that I am so used to. Thats how bonk came to be.

Here's why:

• Works on all OS'
• Can Also create directories recursively
• Why not?

(back to top)

Getting Started

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/elliot40404/bonk.git

2. Build and Install the rust binary

   cd bonk
   cargo build --release
   cargo install --path .

or

# install directly from this repo
scoop install https://raw.githubusercontent.com/elliot40404/bonk/master/bonk.json

# Additionally you can add my bucket and install from there
scoop bucket add elliot
scoop install elliot/bonk

cargo install bonky

Note: name of the executable is bonk though the crate is named bonky.

sudo curl -L https://github.com/elliot40404/bonk/releases/latest/download/bonk_linux_x64 -o /usr/local/bin/bonk && sudo chmod +x /usr/local/bin/bonk

Download the binary from the releases page here

(back to top)

Usage

Print Help

bonk -h

bonk --help

Create a file

bonk main.rs

Create a directory

bonk src/

Create a nested file

bonk src/main.rs

Create nested directories

bonk src/bonky/

Create nested file inside nested directories

bonk src/bonky/mod.rs

(back to top)

Roadmap

• Handle Non-UTF8 files/folders
• Add timestamp modification functionality

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

bonk's Issues

bonk will fail to touch existing files

If you bonk a file that has existing content, that content will be truncated by std::fs::File::create().

getting issues of these

some compilation errors are there update these

Errors will panic

Instead of panicing on error, bonk should cleanly exit with status 1.

Help parameters create files

Amy parameters, including help parameters, will be created as files.

❯ ls ./-* -lh
ls: cannot access './-*': No such file or directory

~ took 16ms
❯ bonk --help >/dev/null

~ took 32ms
❯ bonk -h >/dev/null

~ took 32ms
❯ bonk --something >/dev/null

~ took 49ms
❯ ls ./-* -lh
-rw------- 1 u0_a1429 u0_a1429 0 Feb  2 00:18 ./--help
-rw------- 1 u0_a1429 u0_a1429 0 Feb  2 00:18 ./--something
-rw------- 1 u0_a1429 u0_a1429 0 Feb  2 00:18 ./-h

~ took 21ms
❯

Should use Path functions for directory / file manipulation

The hand-rolled string operations should be replaced with functions from std::Path for portability and correctness, especially on non-string Paths.

SCoop-pacakge ! request

i liked how bonk is so useful . and make work so eaasy

it would be good if u add scoop-manifest for window user
scoop.sh is a package -manager for window 🥺

please make it avaible there

Should use std::env::args_os()

Use std::env::args_os() and immediately convert to PathBuf for non-standard strings.

An error occurs when creating a folder with the same name as an existed file.

As shown in the following figure:

Platform: MacOs

Benchmark

Blazingly fast is incomplete without a benchmark 😃

Use mandown for creating manpages from markdown markup

Relevant mandown project: https://gitlab.com/kornelski/mandown

I think zellij is the only project I know that uses this.

URGENT: bonk will delete file contents

Running bonk on an existing file will delete its contents.

$ echo hello >/tmp/hello.txt
$ cat /tmp/hello.txt
hello
$ cargo run /tmp/hello.txt
$ cat /tmp/hello.txt
$

Please see http://github.com/BartMassey/touche for a touch-like inspired by bonk that avoids this sort of problem.