mirror of
https://github.com/garraflavatra/alphabets.git
synced 2024-11-27 22:26:24 +01:00
108 lines
4.0 KiB
Markdown
108 lines
4.0 KiB
Markdown
# Alphabets
|
|
|
|
Alphabets contains many different alphabets for many different use cases.
|
|
|
|
[](https://www.npmjs.com/package/alphabets)
|
|
|
|
- [Included alphabets](#included-alphabets)
|
|
- [How to use](#how-to-use)
|
|
- [JS module](#js-module)
|
|
- [JSON file](#json-file)
|
|
- [Motivation](#motivation)
|
|
- [Questions and bugs](#questions-and-bugs)
|
|
- [Copyright](#copyright)
|
|
|
|
## Included alphabets
|
|
|
|
See below for [usage instructions](#how-to-use).
|
|
|
|
| Export name | Alphabet |
|
|
|------------------|------------------|
|
|
| `danish` | [Danish](https://en.wikipedia.org/wiki/Danish_orthography), same as Norwegian |
|
|
| `faroese` | [Faroese](https://en.wikipedia.org/wiki/Faroese_orthography) |
|
|
| `greek` | [Greek](https://en.wikipedia.org/wiki/Greek_alphabet) |
|
|
| `icelandic` | [Icelandic](https://en.wikipedia.org/wiki/Icelandic_orthography) |
|
|
| `latin` | [Latin](https://en.wikipedia.org/wiki/Latin_alphabet) (abcdefg etc.) |
|
|
| `nato` | [NATO phonetic alphabet](https://en.wikipedia.org/wiki/NATO_phonetic_alphabet) |
|
|
| `norwegian` | [Norwegian](https://en.wikipedia.org/wiki/Danish_and_Norwegian_alphabet), same as Danish |
|
|
| `polish` | [Polish](https://en.wikipedia.org/wiki/Polish_alphabet) |
|
|
| `russian` | [Russian](https://en.wikipedia.org/wiki/Russian_alphabet) |
|
|
| `swedish` | [Swedish](https://en.wikipedia.org/wiki/Swedish_alphabet) |
|
|
| `ukrainian` | [Ukrainian](https://en.wikipedia.org/wiki/Ukrainian_alphabet) |
|
|
|
|
## How to use
|
|
|
|
### JS module
|
|
|
|
Install the [alphabets npm module](https://www.npmjs.com/package/alphabets) using your preferred package manager:
|
|
|
|
* npm: `npm install alphabets`
|
|
* Yarn: `yarn add alphabets`
|
|
* pnpm: `pnpm add alphabets`
|
|
|
|
You can also use it with [Deno](https://deno.land/) by importing `https://deno.land/x/alphabets/alphabets.mjs`.
|
|
|
|
Replace `<alphabetYouWantToUse>` with an [alphabet identifier](#included-alphabets) this package exports:
|
|
|
|
```js
|
|
import { <alphabetYouWantToUse> } from 'alphabets';
|
|
```
|
|
|
|
Deno:
|
|
|
|
```js
|
|
import { <alphabetYouWantToUse> } from 'https://deno.land/x/alphabets/alphabets.mjs';
|
|
```
|
|
|
|
or:
|
|
|
|
```js
|
|
const alphabets = require('alphabets');
|
|
console.log(alphabets.<alphabetYouWantToUse>);
|
|
```
|
|
|
|
### JSON file
|
|
|
|
Or load the JSON file with alphabets directly from a CDN:
|
|
|
|
* https://cdn.jsdelivr.net/npm/alphabets@2/alphabets.json
|
|
* https://unpkg.com/alphabets@2/alphabets.json
|
|
|
|
## Motivation
|
|
|
|
I have seen [code like this](https://github.com/search?q=%27abcdefghijklmnopqrstuvwxyz%27.split%28%27%27%29+language%3AJavaScript&type=code&l=JavaScript):
|
|
|
|
```js
|
|
const alphabet = 'abcdefghijklmnopqrstuvwxyz'.split('');
|
|
```
|
|
|
|
Or [even worse](https://github.com/search?q=%5B%22a%22%2C+%22b%22%2C+%22c%22%2C+%22d%22%2C+%22e%22%2C+%22f%22%2C+%22g%22%2C+%22h%22%2C+%22i%22%2C+%22j%22%2C+%22k%22%2C+%22l%22%2C+%22m%22%2C+%22n%22%2C+%22o%22%2C+%22p%22%2C+%22q%22%2C+%22r%22%2C+%22s%22%2C+%22t%22%2C+%22u%22%2C+%22v%22%2C+%22w%22%2C+%22x%22%2C+%22y%22%2C+%22z%22%5D+language%3AJavaScript&type=code&l=JavaScript):
|
|
|
|
```js
|
|
const alphabet = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z"];
|
|
```
|
|
|
|
My opinion about this: it's verbose, ugly, and it pollutes your code. Instead, why not [do it like this](#how-to-use):
|
|
|
|
```js
|
|
import { latin } from 'alphabets';
|
|
|
|
for (const glyph of latin) {/* ... */}
|
|
```
|
|
|
|
This is much cleaner and more idiomatic.
|
|
|
|
## Questions and bugs
|
|
|
|
Did you find a mistake in an alphabet, or another bug? Please [report it](https://github.com/garraflavatra/alphabets/issues/new) — thank you! I'll try to fix it as soon as possible.
|
|
|
|
You may use the same issue form for questions, too.
|
|
|
|
## Copyright
|
|
|
|
(c) 2021-2023 [Romein van Buren](mailto:romein@vburen.nl). Licensed under the MIT license.
|
|
|
|
For the full copyright and license information, please see the [`LICENSE.md`](./LICENSE.md) file that was distributed with this source code.
|
|
|
|
[](https://www.smartyellow.nl)
|