mycoboco / quokka Goto Github PK

View Code? Open in Web Editor NEW

1.0 2.0 0.0 723 KB

an interactive file renamer

Home Page: http://code.woong.org/quokka

License: Other

Shell 0.06% JavaScript 99.94%

quokka's Introduction

quokka: an interactive file renamer

quokka is an interactive file renamer, which helps to rename multiple files in a systematic manner.

It provides a set of rules:

to change letter case (#case)
to delete characters at a specified position (#delete)
to change file extensions (#extension)
to insert a text into a specified position (#insert)
to remove a text (#remove)
to replace a text (#replace)
to serialize file names (#serialize)
to strip a set of characters off (#strip) and
to import lines of a file for insertion (#import)

with options for fine control. You can combine these rules as you want by adding them into the rule chain. Editing each rule and the rule chain is performed interactively as you do in a shell prompt. The following, for example, shows how to rename files' extensions to .node using quokka:

where > indicates a quokka's prompt and #extension before it shows the user is editing the #extension rule. Typing help lists what commands quokka accepts in general and in a specific rule mode. (In fact, quokka displays characters in color for better readability.)

Even if its source code contains some stuff related to MS Windows, it currently supports and is tested only for Unix-like environments. For now, nothing is guaranteed for MS Windows.

INSTALL.md explains how to build and install the program. For the copyright issues, see the accompanying LICENSE.md file.

Among libraries used, alphanum.js has been modified to meet quokka's needs; it has been modified to behave in a more similar way to ls -v and to return the sorted array instead of nothing. If you need to replace that module with, say, a updated one, it is necessary to apply these changes properly.

Usage Tips

A few useful tips follow below.

Sort files in a natural order

The -v option makes quokka behave in the same way as ls -v when sorting file names; it affects how numbers in file names are handled. Without the option, quokka performs lexicographic comparison which puts, say, img10 before img2 because 1 has a smaller code than 2 has. This looks natural to most (if not all) programmers, but ordinary users would like to place 10 after 2, which the -v option does.

Control the sorting order

quokka can accept file names to rename from an external file given through the -f option. For example, you can edit the file obtained from redirection of ls -t -1 (where -t for sorting by modification time and -1 for displaying only file names) and give it to quokka with the -f option.

One-line multiple-command

quokka is designed to accept multiple commands in a line. For example, you can change files' extensions to docx by this one-line input:

   > #extension change to docx done rename

instead of these multiple lines:

   > #extension
   #extension> change to docx
   #extension> done
   > rename

The thing is that the newline character does not differ from other white-spaces in separating commands.

Names with embedded spaces

The earlier versions of quokka used quotation for spaces embedded in file names. This approach made troubles with readline's auto-completion supported by node.js, and had me choose to escape spaces with a leading backslash. Since the backslash character is now used for escaping spaces, it is necessary to escape backslashes themselves. For example,

   #replace> replace \  .

makes quokka replace a space with a period (note the space after \), and

   #strip> strip \\

does quokka strip off all instances of \. In most cases, the smart auto-completion explained below helps you not to forget escaping spaces.

Smart auto-completion

The recent versions of quokka support the smart auto-completion that is smart in the sense that it is aware of the input context and suggests appropriate words. For example, pressing a tab key after HDTV when quokka expects arguments for the replace command shows every partial string starting with HDTV in file names to rename. This helps you to avoid annoying use of your mouse to copy characters from your terminal screen.

If you have a question or suggestion, do not hesitate to contact me via email (woong.jun at gmail.com) or web (http://code.woong.org/).

quokka's People

Contributors

Stargazers

Watchers

quokka's Issues

implement "import" feature

implement "strip" feature

possible problems from import command need to be considered

The import command reads lines from an external file to insert into file names, which might lead to problematic cases that require special handling like:

arbitrary byte sequence inserted into file names
white-spaces not correctly in the current version (handling them consistently is filed as another ticket)

add FAQs

Necessary to add FAQs document.

one-line explanation for commands would be helpful

Because there are no extra explanations for supported commands (rule modes), users are not easy to figure out what job a certain command performs unless they enter that mode; for example, what is the difference of 'delete' than 'remove'?

separate "extension" from quokka.js

To aid introduction of new features to quokka, it is necessary to separate functions that implement features from the main code, quokka.js.

implement "delete" feature

improve the import command

It would be useful for imported lines to be parsed with a field separator like a tab before inserted into file names, which is easy to implement.

handle spaces in a consistent way

Even if all kinds of spaces distinguish commands from their arguments or other commands, escaping with backslashes applies only to a normal space, for example, when constructing a list for auto-completion. This should be fixed so that all white-spaces have to be dealt with in a consistent way.

replace wcwidth.js with the published one

wcwidth.js now published on npm. It is necessary to replace the file with the npm package.

refactor code

apply new coding style
change directory structure

smart auto-completion needed

The current auto-completion for quokka always lists up commands available even when arguments for a command (strings from file names in most cases) are requested.

It would be more useful if proper candidates show up depending on user input.

implement "case" feature

-n option needs to override -v option

When a user run quokka with the -v option by an alias set or a shell script as specified in INSTALL.md, it becames impossible to keep the original order of file names with the -n option because -n is active only when there is no -v.

auto-completion needs to change according to skipping extensions

Even when extensions are being skipped by setting "skip extension", auto-completion includes characters from extensions, which sometimes confuses users.

implement "serialize" feature

unexpected output from auto-completion

$ quokka 20131217-160115.avi
> #extension change to aot[tab]

(no space after aot) gives

> #extension change to aot31217-160115.avi

the none property added to colors.js may be able to be implemented with no touch on the file.
since alphanum.js is not a npm module, it should be kept in lib/ not in node_modules/.

#delete> #delete from position 20 until end

/home/mycoboco/script/quokka/src/quokka.js:733
            cset.cmd(t.cmd).func(t.param);
                            ^
TypeError: Cannot call method 'func' of undefined