Giter VIP home page Giter VIP logo

slug's Introduction

slug

Deno library for converting arbitrary strings into valid slugs

import { slug } from "https://deno.land/x/slug/mod.ts";

console.log(slug("some string")); // some-string
console.log(slug("some string", "_")); // some_string
console.log(slug("I ♥ UNICODE")); // i-love-unicode
console.log(slug("I ♥ UNICODE", { lower: false })); // I-love-UNICODE

Options

slug("some ƒÚÑķÝ and ☢ string", {
  replacement: "-", // replace spaces with replacement character (defaults to `-`)
  remove: /[^\w\s$*_+~.()'"!\-:@]+/g, // remove characters that match regex (defaults to `/[^\w\s$*_+~.()'"!\-:@]+/g`)
  lower: true, // convert to lower case (defaults to `true`)
  strict: false, // strip special characters except replacement (defaults to `false`)
  locale: "vi", // language code of the locale to use (defaults to `vi`)
  trim: true, // trim leading and trailing replacement chars (defaults to `true`)
  extends: { "☢": "nuclear" }, // extend default unicode character set (defaults to `{}`)
}); // some-funky-and-nuclear-string

Propers

Heavily inspired by: Slug and Slugify

slug's People

Contributors

lino-levan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

slug's Issues

slug function does not accept partial options object

Hello and sorry to be creating your first GH issue. Thank you for the library.

When trying to use v1.0.0 in the manner shown here, passing a partial options object, I am encountering a TS compiler error because the options argument (here) is typed as string | SlugOptions rather than string | Partial<SlugOptions> as would be expected given that this input is merged with the default options object here.

Screen Shot 2022-11-27 at 6 33 08 AM

I encountered other issues while addressing this. In the code, SlugOptions is not exported so I was not able to easily work around the issue using { lower: true } as SlugOptions. And in the repo, I could not find a license file or a CONTRIBUTING.md file. Please let me know if you would like me to create separate issues for any of these.

I take no offense if you decide to delete this issue or if you do not reply. Just figured I'd give the feedback. Thanks again for the library.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.