TheMagician
/
nextfile
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add README.md

This commit is contained in:
The Magician 2023-12-12 16:26:05 +00:00
parent e8844a2437
commit 3f173d2335
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# nextfile
`nextfile` is a Lua library used to generate the "next" filename in a sequence.
## Installation
`nextfile` is published on [LuaRocks](https://luarocks.org), use `luarocks install nextfile` to install it.
## Usage
The `nextfile` library actually contains two exported modules, `nextfile` and `prevfile`.
`prevfile` scans the files in a directory and returns the "most recent" filename according to a ["human sort"](https://en.wikipedia.org/wiki/Natural_sort_order) algorithm.
`prevfile` is also leveraged by `nextfile`, which then gives the "next file" according to the following rules:
- If the previous filename is entirely numeric, then the next file is the next number. For example, if the previous file were "500.jpg", then the next file would be "501.jpg".
- If the previous filename ends in a letter, then the next file will bump it to the next letter. For example, if the previous file were "200a.png", the next file would be "200b.png".
By default, `nextfile` will give the next file the same file extension as the previous file; there is a second optional parameter for specifying the file extension.