Skip to content

Commit

Permalink
chore: apply Prettier formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
ZRktty committed Aug 22, 2024
1 parent 733f9e9 commit 3110a87
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
run_install: false
- uses: actions/setup-node@v4
with:
node-version: "lts/*"
node-version: 'lts/*'
cache: pnpm
- name: Install dependencies
run: pnpm install --frozen-lockfile
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

## Description

A case-insensitive accent folding functions to replace accented characters with their unaccented equivalents
A case-insensitive accent folding functions to replace accented characters with their unaccented equivalents
or hightlight matched terms in a string, ignoring accents.



## Installation

Install with npm:
Expand All @@ -21,20 +19,22 @@ or with pnpm:
pnpm install accent-folding
```

or even with yarn:
or even with yarn:

```shell
yarn add accent-folding
```

## Public Methods

### `replace`

Replaces accented characters in a string with their unaccented equivalents.

#### Key Features:
- Handles various Unicode characters, including fullwidth ASCII
- Preserves original string formatting in the output

- Handles various Unicode characters, including fullwidth ASCII
- Preserves original string formatting in the output

```js
import AccentFolding from 'accent-folding';
Expand All @@ -45,6 +45,7 @@ af.replace('Fulanilo López'); // --> "Fulanilo Lopez"
```

### `highlightMatch`

Highlights matched terms in a string, ignoring accents.

#### Key Features:
Expand All @@ -60,7 +61,6 @@ Highlights matched terms in a string, ignoring accents.
- Search functionality in applications where accents should be ignored
- Highlighting matched terms in search results


```js
import AccentFolding from 'accent-folding';

Expand Down
4 changes: 2 additions & 2 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
- [x] Documentation: Detailed examples and use cases.

## What's `next`

- [x] chore: Add code quality tools like ESlint, EditorConfig & Prettier
- [x] add `replace` method for replacing accents with it's unaccented equivalents without wrapping
- [x] Add coverage reporting

## Future Plans

- [ ] Add TypeScript support
- [ ] Add support for CommonJS


0 comments on commit 3110a87

Please sign in to comment.