Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kemokemo/furit
This tool finds unreferenced images from text files such as markdown.
https://github.com/kemokemo/furit
checker cli go golang
Last synced: 1 day ago
JSON representation
This tool finds unreferenced images from text files such as markdown.
- Host: GitHub
- URL: https://github.com/kemokemo/furit
- Owner: kemokemo
- License: mit
- Created: 2020-06-28T15:05:58.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-11T23:24:42.000Z (about 1 year ago)
- Last Synced: 2024-06-21T06:47:32.159Z (5 months ago)
- Topics: checker, cli, go, golang
- Language: Go
- Homepage:
- Size: 48.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# furit ( Find Unreferenced Images in Text files )
[](https://opensource.org/licenses/MIT) [](https://github.com/kemokemo/furit/actions/workflows/test-and-build.yml)
This tool finds unreferenced images from text files such as markdown.
## Install
### Homebrew
```sh
brew install kemokemo/tap/furit
```
### Scoop
First, add my scoop-bucket.
```sh
scoop bucket add kemokemo-bucket https://github.com/kemokemo/scoop-bucket.git
```
Next, install this app by running the following.
```sh
scoop install furit
```
### Binary
Get the latest version from [the release page](https://github.com/kemokemo/furit/releases/latest), and download the archive file for your operating system/architecture. Unpack the archive, and put the binary somewhere in your `$PATH`.
## Usage
```sh
$ furit -h
Usage: furit [...] <1st path> <2nd path>...
you can set mutiple paths to search invalid images.
-d, -delete:
delete unlinked image files (with confirmation)
-f, -force:
delete unlinked image files without prompting for confirmation
-s, -settings:
specify the settings file path to exclude files etc..
-t, -type:
specify the target text format (markdown, html are available)
-h, -help:
display help
-v, -version:
display version
```
### Example
```sh
$ furit content
content/posts/assets/some_screen.bmp
content/posts/assets/logo.gif
$ echo $?
1
```
This tool looks recursively for the folder you specify, finds links to images in the text it finds, and enumerates the unreferenced image files from text.
If any unreferenced images were found, it returns `1` as an `ExitCode`. This is also true for the deletion operation described below.
```sh
$ furit -d content
content/posts/assets/some_screen.bmp
content/posts/assets/logo.gif
Are you sure to delete these unlinked images? [y/n]: n
the file deletion process has been canceled by user input
```
If you want to delete any unreferenced images found by this tool while checking them, just specify the `-d` flag.
```sh
$ furit -d -f content
content/posts/assets/some_screen.bmp
content/posts/assets/logo.gif
```
You can also specify the `-f` flag if you want to run the process of deletion automatically without confirmation. In that case, the list of files to be deleted will still be printed.
If the deletion fails, it returns an `ExitCode` other than `0` and `1`.
## Supported
### Text format
The following text are supported.
- Markdown
- HTML
### Image format
The following image extensions are supported. They are not case insensitive.
- png
- jpg, jpeg
- bmp
- gif
- tif, tiff
- emf
## Notes
If you use `img` tag in markdown files to specify the image size, please convert to the html files and use `html` type option.
## License
[MIT](https://github.com/kemokemo/furit/blob/main/LICENSE)
## Author
[kemokemo](https://github.com/kemokemo)