jorge-cab / cli_utils_rs Goto Github PK

View Code? Open in Web Editor NEW

0.0 1.0 0.0 12 KB

My rewrite of basic cli utilities using Rust

Rust 100.00%

cli_utils_rs's Introduction

cli-utils-rs

My rewrite of basic cli utilities using Rust

cli_utils_rs's People

Contributors

Watchers

cli_utils_rs's Issues

Implement `cat`

As a user, I want to display the contents of a file so that I can read it in the terminal.

Ex:

cat ./story.txt

Out -> "Once upon a time..."

Test reading from a file, handling of non-existent files, and empty files.

Add missing unit tests for `cat`

After #6 now make the unit tests for cat this might involve refactoring some of the code to make it viable and achieve as much code coverage as possible.

Implement most basic grep logic

Make grep be able to search in a certain file a certain string.

Ex:
grep Title ./books
-> Title1

grep hello ./greetings
-> hello there

[Spike] Look into how to unit test using mock files

There is a library for this

There seems to be a bunch of boiler plate code for this

Is there a way to make it easy?

Implement `ls`

As a user, I want to list the files in a directory so that I can see what it contains.

Ex:

ls
-> Myfile1.txt bin hello.txt

Test listing files

[Spike] Start looking into how features work.

What are feature in Cargo.toml? Example here: https://github.com/uutils/coreutils/blob/ac5684dc8d26b3ac6f27f610dfdd38cac0e79822/Cargo.toml#L24C1-L34

Can they be used to improve the project?

Implement sort util

Implement the sort util to sort out the lines contained within a file

Command selector logic

The user can now select the util they want to use. It will be the first argument.

Ex:

cargo run echo asdf

out: asdf

cargo run grep asdf

-> executes grep logic

add unit tests

Refactor code into multiple well defined modules

Currently everything is within the lib.rs file. We want to

Refactor Tests
Refactor Run Functions
Refactor General logic Ex: bin_selector

Changes pass the Unit tests

Add `ls` unit tests

As title

[Spike] Understand how find really works in Linux

Currently I'm not sure how to use find so implementing it myself will be hard, this Spike is to get familiar with the command

Make the basic `echo` logic

To start off the project when running cargo run we should be able to handle:

Basic Output
Given: echo asdf
Then: asdf
Quoted String
Given: echo "asdf"
Then: asdf

Acceptance Criteria

The above works as defined
Unit tests

Refactor to use custom error type

Refactor to use a custom error type in general in the rewrite to give us more flexibility and robustness with Error handling.

Implement at least the following types:

MissingFilePath
FileReadError
InvalidCommand
NoArgumentsReceived

Confirm tests are still working

`grep` unit tests

as title