https://github.com/brutus/bash-slugify

Create slugs and rename files — in your shell.
https://github.com/brutus/bash-slugify

bash shell slugify

Last synced: about 2 months ago
JSON representation

Create slugs and rename files — in your shell.

• Host: GitHub
• URL: https://github.com/brutus/bash-slugify
• Owner: brutus
• License: gpl-3.0
• Created: 2015-05-29T17:52:23.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2021-03-25T11:16:36.000Z (over 3 years ago)
• Last Synced: 2024-02-14T21:50:44.139Z (7 months ago)
• Topics: bash, shell, slugify
• Language: Shell
• Size: 25.4 KB
• Stars: 27
• Watchers: 3
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# BASH Slugify

It slugifies strings. In your BASH. Well, I need to clean filenames — like

uploaded images — regularly and this helps me automate it.

## What's happening?

- _Optionally_ convert to upper- or lower case (default: no change).

- _Optionally_ all *special chars* (`[^a-zA-Z0-9]`) are removed or replaced

  (default: `_`).

- _Optionally_ all or some *glue characters* (`[-_.]`) are replaced with spaces.

- Whitespace is consolidated and trimmed.

- All remaining spaces are replaced (default: `-`).

## Examples

    $ ./slugify.sh foo 'Hello World!' Bar

    foo

    Hello-World!

    Bar

    $ ./slugify.sh foo -l 'Hello World!' Bar

    foo

    hello-world!

    bar

    $ ./slugify.sh -e foo 'Hello World!' Bar

    foo-Hello-World!-Bar

    $ ./slugify.sh -exl foo Hello World! Bar

    foo-hello-world-bar

If you use the `-r` switch, arguments are threated as file names to be slugifed

(and renamed). Here's the output if you run it dry (no renaming) in the

directory of this repository — `$ ./slugify.sh -rn -lx *`:

    CHANGELOG.md -> changelog.md

    LICENSE -> license

    README.md -> readme.md

    src -> skipped (no change)

    tests -> skipped (no change)

## Usage

    Slugifies strings or filenames.

    usage: slugify [(l|u)|(x|X)|E|D|U|P|A|S|(c< char>|s)|C< char>|e|r|n|f|v|d|h]… …

    character options

      -l  convert to lowercase

      -u  convert to uppercase

      -x  remove special chars

      -X  replace special chars

    space options

      -D  don't convert dashes to spaces

      -U  don't convert underscores to spaces

      -P  don't convert dots (points) to spaces

      -A  don't remove spaces around dashes and underscores

      -S  don't consolidate multiple spaces

    replacement options

      -c  replace all spaces with this (default: '-')

      -C  replace special chars with this (default: '_')

      -s use underscores for spaces (shortcut for '-c_')

    mode options

      -e  extended — treat all arguments as one string and echo one slug for it

      -r  rename files – treat arguments as filenames and rename them

    rename options

      -E  don't slugify file extensions

      -n  dry run — only show new file names (no renaming)

      -f  force — overwrite existing files

    other options

      -v  verbose output

      -d  debug output

      -h  print help

### Return Values

- `0` all went well

- `1` error parsing arguments

- `2` original string is empty

- `3` slugified string is empty

- `4` original file not found

- `5` slugified file exists

## Development

Tested with [Bats]. Okay just barely…

[bats]: https://github.com/sstephenson/bats