mirror of
https://github.com/garraflavatra/alphabets.git
synced 2025-07-18 17:34:05 +00:00
Upgrade documentation site
This commit is contained in:
29
docs/about/alternatives.md
Normal file
29
docs/about/alternatives.md
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
title: Alternatives to Alphabets
|
||||
---
|
||||
|
||||
Know more alternatives? Please open an
|
||||
[issue](https://github.com/garraflavatra/alphabet.js/issues/new) or
|
||||
[pull request](https://github.com/garraflavatra/alphabet.js)!
|
||||
{: .notice--info}
|
||||
|
||||
## [alphabet](https://www.npmjs.com/package/alphabet)
|
||||
|
||||
(whithout trailing `s`)
|
||||
|
||||
I do not say this package doesn't work. I think it will work perfectly, but it
|
||||
has less features:
|
||||
{: .notice--warning}
|
||||
|
||||
Seems a good alternative, right? But:
|
||||
|
||||
* It only supports the Latin alphabet.
|
||||
* It is larger. (The size is equal to this package's size, but this package
|
||||
includes more.)
|
||||
* It is only [CommonJS](https://en.wikipedia.org/wiki/CommonJS) and not
|
||||
[ECMAScript](https://en.wikipedia.org/wiki/ECMAScript) etc.
|
||||
* When did the author last update it? Right.
|
||||
<figure>
|
||||
<img src="/images/competitors/alphabet-last-publish.png" alt="Last updated: 6 years ago">
|
||||
<figcaption>Hmmm...</figcaption>
|
||||
</figure>
|
44
docs/about/why.md
Normal file
44
docs/about/why.md
Normal file
@ -0,0 +1,44 @@
|
||||
---
|
||||
title: Why would I use this?
|
||||
---
|
||||
|
||||
I have seen developers doing this:
|
||||
|
||||
```js
|
||||
const alphabet = 'abcdefghijklmnopqrstuvwxyz'.split('');
|
||||
```
|
||||
|
||||
Or worse:
|
||||
|
||||
```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 ugly, it makes your code less readable
|
||||
(read: ugly) and it's simply not something you should want to have in your
|
||||
code! Instead, you should do it like so:
|
||||
|
||||
```js
|
||||
import { latin } from 'alphabets';
|
||||
// or
|
||||
const alphabets = require('alphabets');
|
||||
```
|
||||
|
||||
Much cleaner, right? That's why I made this package.
|
||||
|
||||
## Why not?
|
||||
|
||||
I see very few reasons not to use this package.
|
||||
|
||||
### But doesn't it cost me performance?
|
||||
|
||||
No. This package is only <800 bytes so it should not cost you any performance.
|
||||
Neither via [CDN](/usage/installation/#cdn) nor if you use a bundler like
|
||||
webpack, Parcel or Rollup.
|
||||
|
||||
### Why not making an array on my own?
|
||||
|
||||
It's a choice. This whole package is **opinionated**. *I* think you should not
|
||||
do `const alphabet = 'abcdefghijklmnopqrstuvwxyz'.split('');` in your code. *I*
|
||||
think you should use a package for that. Do you think it's OK to define your own
|
||||
alphabet array? Do that!
|
Reference in New Issue
Block a user