Giter VIP home page Giter VIP logo

sqids-blacklist's Introduction

Sqids Blocklist

Github Actions

This repository is used to manage the default Sqids blocklist.

It contains carefully chosen words that might not be appropriate to accidentally show up in auto-generated Sqids IDs.

Get started

Running the program requires Rust v1.69+. The following will output a complete JSON blocklist. You can also copy it from the output folder.

cargo run

Adding or Adjusting Data

If you'd like to add a list or adjust a list, please submit PRs to the next branch.

The main branch is frozen for this version of Sqids.

Data

Lists of words are located in data folder.

Words are transformed to include these mutations:

  • i1
  • l1
  • o0

So, if the blocklist contains the word "low", it will also contain these variations: "l0w", "1ow" and "10w".

Other character replacements are not included because they're not that obvious when mixed in IDs.

Sqids ID matching that will cause a re-run (in order):

  1. If the blocklisted word is <= 3 characters long, it has to match exactly
  2. If the word has numbers, then match will happen only if ID starts or ends with that mutated word
  3. Otherwise, only if the word is a substring of ID

Most common matches are from 4 letter words.

sqids-blacklist's People

Contributors

4kimov avatar tzvetkoff avatar pastc avatar

Watchers

 avatar

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.