Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wooorm/match-casing
Match the case of `value` to that of `base`
https://github.com/wooorm/match-casing
case lower lowercase match sentence upper uppercase
Last synced: 5 days ago
JSON representation
Match the case of `value` to that of `base`
- Host: GitHub
- URL: https://github.com/wooorm/match-casing
- Owner: wooorm
- License: mit
- Created: 2016-09-06T16:11:23.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2022-11-20T11:49:29.000Z (about 2 years ago)
- Last Synced: 2024-12-12T04:50:23.158Z (10 days ago)
- Topics: case, lower, lowercase, match, sentence, upper, uppercase
- Language: JavaScript
- Homepage:
- Size: 53.7 KB
- Stars: 13
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: funding.yml
- License: license
Awesome Lists containing this project
README
# match-casing
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
Match the case of `value` to that of `base`.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`matchCasing(value, base)`](#matchcasingvalue-base)
* [Algorithm](#algorithm)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This package matches the case (lowercase, uppercase, capitalized) of a string to
that of another string.
## When should I use this?
This package is useful if a user wrote some word, and you want to suggest a
replacement, and want to make sure that the suggestion matches that of the
original.
## Install
This package is [ESM only][esm].
In Node.js (version 14.14+, 16.0+), install with [npm][]:
```sh
npm install match-casing
```
In Deno with [`esm.sh`][esmsh]:
```js
import {matchCasing} from 'https://esm.sh/match-casing@2'
```
In browsers with [`esm.sh`][esmsh]:
```html
import {matchCasing} from 'https://esm.sh/match-casing@2?bundle'
```
## Use
```js
import {matchCasing} from 'match-casing'
matchCasing('foo', 'BAZ') // => 'FOO'
matchCasing('foo', 'Baz') // => 'Foo'
matchCasing('foo', 'baz') // => 'foo'
matchCasing('foo', 'BaZ') // => 'foo'
matchCasing('FOO', 'BAZ') // => 'FOO'
matchCasing('FOO', 'Baz') // => 'Foo'
matchCasing('FOO', 'baz') // => 'foo'
matchCasing('FOO', 'BaZ') // => 'FOO'
matchCasing('Foo', 'BAZ') // => 'FOO'
matchCasing('Foo', 'Baz') // => 'Foo'
matchCasing('Foo', 'baz') // => 'foo'
matchCasing('Foo', 'BaZ') // => 'Foo'
matchCasing('’90S', '’twas') // => '’90s'
matchCasing('’N’', 'a') // => '’n’'
```
## API
This package exports the identifier `matchCasing`.
There is no default export.
### `matchCasing(value, base)`
Transform the case in `value` (`string`) to match that of `base` (`string`).
## Algorithm
* if `base` is uppercase, `value` is uppercased
* else, if `base` is lowercase, `value` is lowercased
* else, if the first alphabetic character in `base` is uppercase,
and the rest of `base` is lowercase, uppercase the first alphabetic
character in `value` and lowercase the rest
* else, return `value` unmodified
The third case deals with initial non-alphabetical characters as expected.
## Types
This package is fully typed with [TypeScript][].
It exports no additional types.
## Compatibility
This package is at least compatible with all maintained versions of Node.js.
As of now, that is Node.js 14.14+ and 16.0+.
It also works in Deno and modern browsers.
## Security
This package is safe.
## Related
* [`words/emoji-emotion`](https://github.com/words/emoji-emotion)
— list of emoji rated for valence
* [`wooorm/emoticon`](https://github.com/wooorm/emoticon)
— info on ASCII emoticons
* [`wooorm/strip-skin-tone`](https://github.com/wooorm/strip-skin-tone)
— strip skin-tones from emoji
* [`wooorm.com/checkmoji`](https://wooorm.com/checkmoji/)
— check emoji across platforms
## Contribute
Yes please!
See [How to Contribute to Open Source][contribute].
## License
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/wooorm/match-casing/workflows/main/badge.svg
[build]: https://github.com/wooorm/match-casing/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/match-casing.svg
[coverage]: https://codecov.io/github/wooorm/match-casing
[downloads-badge]: https://img.shields.io/npm/dm/match-casing.svg
[downloads]: https://www.npmjs.com/package/match-casing
[size-badge]: https://img.shields.io/bundlephobia/minzip/match-casing.svg
[size]: https://bundlephobia.com/result?p=match-casing
[npm]: https://docs.npmjs.com/cli/install
[esmsh]: https://esm.sh
[license]: license
[author]: https://wooorm.com
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[typescript]: https://www.typescriptlang.org
[contribute]: https://opensource.guide/how-to-contribute/