fdncred / nu_plugin_file

A nushell plugin that will inspect a file and return information based on it's magic number.

nu_plugin_file

This nushell plugin will open files to inspect them and report back a little information. It uses magic bytes to determine many file formats. The core code was "borrowed" from a spacedrive crate that I thought looked interesting.

Usage:

❯ help file
View file format information

Usage:
  > file <filename>

Flags:
  -h, --help - Display the help message for this command

Parameters:
  filename <string>: full path to file name to inspect

Examples:
  Get format information from file
  > file some.jpg
  ╭──────────────┬──────────╮
  │ description  │ Image    │
  │ format       │ jpg      │
  │ magic_offset │ 0        │
  │ magic_length │ 2        │
  │ magic_bytes  │ [FF, D8] │
  ╰──────────────┴──────────╯

Installation

1. clone repo git clone https://github.com/fdncred/nu_plugin_file.git
2. install with cargo cargo install --path .
3. register with nushell register /path/to/nu_plugin_file
4. inspect a file file some.jpg

nu_plugin_file's Issues

panic! when not given full path

when file is given the path of a file relative to the working directory, it panics:

~> "hello world!" | save example.txt
~> file example.txt
thread 'plugin runner (primary)' panicked at src/main.rs:88:66:
called `Result::unwrap()` on an `Err` value: Os { code: 2, kind: NotFound, message: "No such file or directory" }
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
Error:   × Failed to receive response to plugin call from `file`
   ╭─[entry #3:1:1]
 1 │ file example.txt
   · ──┬─
   ·   ╰── while waiting for this operation to complete
   ╰────
  help: try restarting the plugin with `plugin use 'file'`
~> file ~/example.txt
╭──────────────┬──────╮
│ description  │ Text │
│ format       │ txt  │
│ magic_offset │      │
│ magic_length │      │
│ magic_bytes  │      │
╰──────────────┴──────╯
~> file /home/sweglord227/example.txt
╭──────────────┬──────╮
│ description  │ Text │
│ format       │ txt  │
│ magic_offset │      │
│ magic_length │      │
│ magic_bytes  │      │
╰──────────────┴──────╯

this is caught on line 88 by .unwrap(). the if else chain misses the case where it is only given the relative path, and not a full path.

working on a pull request for this now. might be up tonight or tomorrow

Does this violate Spacedrive's license?

Spacedrive is mentioned in the README, and it looks like most of the functional code of this is taken from SpaceDrive, but I don't see any proper attribution. More importantly, Spacedrive is licensed AGPL, which would require this plugin to also be AGPL.