stldo

url-slug

Slug generator with less than 1 KB and no dependencies, RFC 3986 compliant.

  "description": "Lightweight slug generator, RFC 3986 compliant",

  "description": "Slug generator with less than 1 KB and no dependencies, RFC 3986 compliant.",

    "build": "cross-env NODE_ENV=production rollup --config",

    "postversion": "git push && git push --tags",

    "test": "standard --env jest && jest"

  "repository": "https://github.com/stldo/url-slug",

  "author": "stldo (https://github.com/stldo)",

# url-slug [![build status](https://img.shields.io/travis/stldo/url-slug/master)](https://travis-ci.org/stldo/url-slug) [![npm](https://img.shields.io/npm/v/url-slug)](https://www.npmjs.com/package/url-slug)

- __Less than 1kB__ minified and gzipped;

- Uses default JavaScript APIs, __no dependencies__;

- __RFC 3986__ compliant, compatible with URL hosts, paths, queries and fragments;

- Supports __custom dictionaries__ to replace characters;

- Easily __revert slugs__ with useful options.

urlSlug('Sir James Paul McCartney MBE is an English singer-songwriter')

// sir-james-paul-mc-cartney-mbe-is-an-english-singer-songwriter

### urlSlug(string[, options]), convert(string[, options])

Returns `string` value converted to a slug.

| camelCase | Split on camel case occurrences | `true` |

| dictionary | [Chars to be replaced](#dictionary-option-considerations) | `{}` |

| separator | [Character or string](#accepted-separator-characters) used to separate the slug fragments | `'-'` |

| transformer | A built-in transformer or a custom function (`false` to keep the string unchanged) | `LOWERCASE_TRANSFORMER` |

  transformer: urlSlug.UPPERCASE_TRANSFORMER

urlSlug.convert('á é í ó ú Á É Í Ó Ú ç Ç ª º ¹ ² ½ ¼', {

// a_e_i_o_u_A_E_I_O_U_c_C_a_o_1_2_1_2_1_4

urlSlug.convert('Red, red wine, stay close to me…', {

  transformer: urlSlug.TITLECASE_TRANSFORMER

Returns the `slug` value converted to a regular sentence.

| camelCase | Split on camel case occurrences | `false` |

| separator | [Character or string](#accepted-separator-characters) to split the slug (`null` accounts to automatic splitting) | `null` |

| transformer | A built-in transformer or a custom function (`false` to keep the string unchanged) | `false` |

import { revert, TITLECASE_TRANSFORMER } from 'url-slug'

revert('Replace-every_separator.allowed~andSplitCamelCaseToo', {

// Replace every separator allowed and Split Camel Case Too

Custom transformers are expressed by a function that receives two arguments, `fragments`, an array with matching words from a sentence or a slug, and `separator`, which will be the separator string set in `convert()` options. When `revert()` calls the transformer, the `separator` argument will always be a space character (`' '`) — the `separator` option will be used to split the slug. Transformers should always return a string.

This module uses `String.prototype.normalize()` to convert strings to slugs. If

you need to support old browsers (e.g. Internet Explorer), you can use a

polyfill like [unorm](https://github.com/walling/unorm).

		{
		"name": "url-slug",
		"version": "3.0.1",
		"description": "Lightweight slug generator, RFC 3986 compliant",
		"version": "3.0.2",
		"description": "Slug generator with less than 1 KB and no dependencies, RFC 3986 compliant.",
		"main": "dist/index.js",
		@@ -6,0 +6,0 @@ "module": "lib/index.js",

Improved metrics

Worsened metrics