wireapp/speakingurl

Name: speakingurl

Owner: Wire Swiss GmbH

Description: Generate a slug ? transliteration with a lot of options

Forked from: pid/speakingurl

Created: 2016-10-31 16:39:02.0

Updated: 2017-10-19 08:38:35.0

Pushed: 2016-11-02 13:55:15.0

Homepage: http://pid.github.io/speakingurl/

Size: 1190

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

SpeakingURL

====================================================================================================================================================================================================================================================================================================================================================

Generate a slug with a lot of options; create a so-called Semantic URL or 'Clean URL' or 'Pretty URL' or 'nice-looking URL' or 'Speaking URL' or 'user-friendly URL' or 'SEO-friendly URL' from a string. This module aims to transliterate the input string.

For use in browser and server - no dependencies!

NPM Badge

Installation

npm

install speakingurl --save

Bower

r install --save speakingurl

Component

onent install pid/speakingurl

jamjs

install speakingurl

Ruby on Rails

d to Gemfile
'speakingurl-rails'

Download Package

copy the file speakingurl.min.js to your script directory

CDN/cloudflare

available versions:

• www.cdnjs.com/libraries/speakingurl/
• use //cdnjs.cloudflare.com/ajax/libs/speakingurl/10.0.0/speakingurl.min.js

CDN/maxcdn

available versions:

• www.jsdelivr.com/#!speakingurl
• use //cdn.jsdelivr.net/speakingurl/10.0.0/speakingurl.min.js

Usage

getSlug(input, [options]);

input: {string} to convert

options {object|string} config object or separator string (see below)

• options {object}

  • separator {string} default: '-'
    • char that replaces the whitespaces
  • lang {string} default: 'en' // ISO 639-1 Codes
    • language specific transliteration (
      • 'ar' // Arabic
      • 'az' // Azerbaijani*
      • 'cs' // Czech
      • 'de' // German
      • 'dv' // Divehi
      • 'en' // English
      • 'es' // Spanish
      • 'fa' // Persian
      • 'fr' // French
      • 'gr' // Greek*
      • 'hu' // Hungarian
      • 'it' // Italian
      • 'lt' // Lithuanian*
      • 'lv' // Latvian
      • 'my' // Burmese
      • 'mk' // Macedonian*
      • 'nl' // Dutch
      • 'pl' // Polish
      • 'pt' // Portuguese
      • 'ro' // Romanian
      • 'ru' // Russian
      • 'sk' // Slovak
      • 'sr' // Serbian*
      • 'tr' // Turkish
      • 'uk' // Ukranian
      • 'vn' // Vietnamese
  • symbols {boolean} default: true
    • false -> don't convert symbols
    • true -> convert symbols according to the 'lang' setting
  • maintainCase {boolean} default: false
    • true -> maintain case chars
    • false -> convert all chars to lower case
  • titleCase {boolean|array} default: false
    • true -> convert input string to title-case
    • array -> titlecase = true, but omit the words from in the array
  • truncate {number} default: 0
    • 0 -> don't trim length
    • >= 1 -> trim to max length while not breaking any words
  • uric {boolean} default: false
    • true -> additionally allow chars: “;“, “?“, “:“, “@“, “&“, “=“, “+“, “\$“, “,“, “/”
    • false
  • uricNoSlash {boolean} default: false
    • true -> additionally allow chars: “;“, “?“, “:“, “@“, “&“, “=“, “+“, “\$“, “,”
  • mark {boolean} default: false
    • true -> additionally allow chars: “-“, “_“, “.“, “!“, “~“, “*“, “'“, “(“, “)”
  • custom {object|array} default: {}
    • object -> custom map for translation, overwrites all i.e. { '&': '#', '*': ' star ' }
    • array -> add chars to allowed charMap (see example)

• options {string} separator

notes: default only Base64 chars are allowed (/A-Za-z0-9_-/), setting uric, uricNoSlash or/and mark to true will add the specified chars to the list of allowed characters. The separator-character is always allowed.

Node.js

getSlug = require('speakingurl');

Browser

ipt src="bower_components/speakingurl/speakingurl.min.js"></script>

Ruby on Rails

d to application.js
require speakingurl

Examples

slug;

 = getSlug("Schöner Titel läßt grüßen!? Bel été !");
ole.log(slug); // Output: schoener-titel-laesst-gruessen-bel-ete

 = getSlug("Schöner Titel läßt grüßen!? Bel été !", '*');
ole.log(slug); // Output: schoener*titel*laesst*gruessen*bel*ete

 = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
    separator: '_'
});
ole.log(slug); // Output: schoener_titel_laesst_gruessen_bel_ete

 = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
    uric: true
});
ole.log(slug); // Output: schoener-titel-laesst-gruessen?-bel-ete

 = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
    uricNoSlash: true
});
ole.log(slug); // Output: schoener-titel-laesst-gruessen?-bel-ete

 = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
    mark: true
});
ole.log(slug); // Output: schoener-titel-laesst-gruessen!-bel-ete-!

 = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
    truncate: 20
});
ole.log(slug); // Output: schoener-titel

 = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
    maintainCase: true
});
ole.log(slug); // Output: Schoener-Titel-laesst-gruessen-Bel-ete

 = getSlug("Äpfel & Birnen!", {
    lang: 'de'
});
ole.log(slug); // Output: aepfel-und-birnen

 = getSlug("?????? ????", {
    lang: 'my'
});
ole.log(slug); // Output: myanma-thadak

 = getSlug('???????? ?? ???? ?????', {
    lang: 'dv'
});
ole.log(slug); // Output: miadhakee hd reethi dvhkv

 = getSlug("Apple & Pear!", {
    lang: 'en' // lang: "en" is default, just to clarify
});
ole.log(slug); // Output: apple-and-pear

 = getSlug('Foo & Bar * Baz', {
    custom: {
        '&': ' doo '
    },
    uric:true
});
ole.log(slug); // Output: foo-doo-bar-baz

 = getSlug('Foo ? Bar');
ole.log(slug); // Output: foo-love-bar

 = getSlug('Foo & Bar | (Baz) * Doo', {
    custom: {
        '*': 'Boo'
    },
    mark:true
});
ole.log(slug); // Output: foo-and-bar-or-(baz)-boo-doo

 = getSlug('Foo and Bar or Baz', {
    custom: {
        'and': 'und',
        'or': ''
    }
});
ole.log(slug); // Output: foo-und-bar-baz

 = getSlug('[Knöpfe]', {
    custom: [
        '[',
        ']'
    ]
});
ole.log(slug); // Output: [knoepfe]

 = getSlug('NEXUS4 only $299');
ole.log(slug); // Output: nexus-4-only-usd299

 = getSlug('NEXUS4 only ?299', {
    maintainCase: true
});
ole.log(slug); // Output: NEXUS-4-only-EUR299

 = getSlug('Don\'t drink and drive', {
    titleCase: true
});
ole.log(slug); // Output: Don-t-Drink-And-Drive

 = getSlug('Don\'t drink and drive', {
    titleCase: ['and']
});
ole.log(slug); // Output: Don-t-Drink-and-Drive

 = getSlug('Foo & Bar ? Foo < Bar', {
    lang: false
});
ole.log(slug); // Output: foo-bar-foo-bar

 = getSlug('Foo & Bar ? Foo < Bar', {
    symbols: false
});
ole.log(slug); // Output: foo-bar-foo-bar

 = getSlug('ä?ä', {
    lang: 'tr',
    symbols: false
});
ole.log(slug); // Output: a

createSlug([options])

options: {object|string} config object or separator string (see above)

Create your own specially configured function.

options = {
    maintainCase: true,
    separator: '_'
};

mySlug = require('speakingurl').createSlug(options);
n browser:
ar mySlug = createSlug(options);

slug = mySlug("Schöner Titel läßt grüßen!? Bel été !");
ole.log(slug); // Output: Schoener_Titel_laesst_gruessen_Bel_ete

Create your own specially configured function with title-case feature.

options = {
    titleCase: [
        "a","an","and","as","at","but",
        "by","en","for","if","in","nor",
        "of","on","or","per","the","to","vs"
    ]
};

mySlug = require('speakingurl').createSlug(options);
n browser:
ar mySlug = createSlug(options);

slug = mySlug('welcome to the jungle');
ole.log(slug); // Output: Welcome-to-the-Jungle

Changelog

see CHANGELOG.md

Tests

test

Contribution

rk pid/speakingurl on Github
t clone git@github.com:<YOUR_USER>/speakingurl.git
 speakingurl
m install
d your stuff
d tests
d example for new feature
d release info to CHANGELOG.md
d description/example to README.md
lp
mmit files (speakingurl.min.js,...)
 everything works fine, commit, push to your repository
eate pull request

Release

lp bumpup --patch  # --minor # --major
lp
lp release

Release to RubyGems.org

lp
m build speakingurl-rails.gemspec
m push speakingurl-rails-x.x.x.gem

References

• http://tools.ietf.org/html/rfc3986
• http://en.wikipedia.org/wiki/Transliteration

Use in other environments

• SpeakingURL with AngularJS
• SpeakingURL with Meteor
• SpeakingURL with Ruby on Rails

Ports

• Java https://github.com/Weltraumschaf/speakingurl thanks to@Weltraumschaf

Credits

• @dypsilon
• @simov
• @henrikjoreteg

License

The BSD 3-Clause License (BSD3)

Copyright (c) 2013-2016 Sascha Droste pid@posteo.net All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.