https://github.com/adalinesimonian/syshik
Searches for text obscured using homoglyphs or other text trickery
https://github.com/adalinesimonian/syshik
javascript js nodejs search string-matching string-search text-search ts typescript
Last synced: about 2 months ago
JSON representation
Searches for text obscured using homoglyphs or other text trickery
- Host: GitHub
- URL: https://github.com/adalinesimonian/syshik
- Owner: adalinesimonian
- License: isc
- Created: 2021-07-29T00:13:38.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T05:51:56.000Z (over 2 years ago)
- Last Synced: 2025-01-08T04:52:44.366Z (over 1 year ago)
- Topics: javascript, js, nodejs, search, string-matching, string-search, text-search, ts, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/syshik
- Size: 835 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# syshik
_[(from сыщик, pronounced Sih-sheek; IPA: [ˈsɨɕːɪk])](https://en.wiktionary.org/wiki/%D1%81%D1%8B%D1%89%D0%B8%D0%BA)_
Search utility for text obscured using homoglyphs or other text trickery
> **Note:** Requires [ES module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) and [`String.prototype.normalize`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize) support.
## Installation
```js
yarn add syshik
```
## Usage
```js
import syshik from 'syshik'
// or
import { find } from 'syshik'
const text = 'No one knows that I live in |\\/|𝚘𝝄𝕟 𐒴ⅰ𝕧ҽʀ'
const matches = syshik.find(text, 'moon river')
// matches => ['|\\/|𝚘𝝄𝕟 𐒴ⅰ𝕧ҽʀ']
```
## Contributing
Found patterns or homoglyphs that are not supported? Found a bug?
- [Create an issue](https://github.com/adalinesimonian/syshik/issues/new)
- [Contribute a PR](https://github.com/adalinesimonian/syshik/compare)
## Licence
ISC (see [LICENCE](LICENCE))