Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moltinginstar/cuppy
A lightweight currency display component with automatic inflation adjustment.
https://github.com/moltinginstar/cuppy
cpi currency-converter currency-formatter dollars inflation inflation-calculator intl money no-dependencies npm typescript
Last synced: about 19 hours ago
JSON representation
A lightweight currency display component with automatic inflation adjustment.
- Host: GitHub
- URL: https://github.com/moltinginstar/cuppy
- Owner: moltinginstar
- License: mit
- Created: 2024-01-20T17:38:07.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-12-21T11:20:57.000Z (1 day ago)
- Last Synced: 2024-12-21T11:23:01.693Z (1 day ago)
- Topics: cpi, currency-converter, currency-formatter, dollars, inflation, inflation-calculator, intl, money, no-dependencies, npm, typescript
- Language: TypeScript
- Homepage: http://moltinginstar.com/cuppy
- Size: 896 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
cuppy
A lightweight currency display component with automatic inflation adjustment.
[](https://opensource.org/licenses/MIT)
[](CODE_OF_CONDUCT.md)
[](https://www.npmjs.com/package/@cuppy/core)
[](https://www.npmjs.com/package/@cuppy/core)
Cuppy is a zero-dependency TypeScript library for declaratively formatting monetary values across your webpage. It supports automatic adjustment of historical currency amounts for inflation based on the Consumer Price Index. (“Cuppy” is how “CPI” would be pronounced if economics was any fun.)
## Installation
Using a package manager:
```bash
npm i @cuppy/core @cuppy/cpi-u
```
or
```bash
yarn add @cuppy/core @cuppy/cpi-u
```
or
```bash
pnpm add @cuppy/core @cuppy/cpi-u
```
## Usage
```html
25_400_000_000
```
```ts
import cuppy from "@cuppy/core";
import cpiU from "@cuppy/cpi-u";
// Set global defaults
cuppy.options.hint = "to";
cuppy.options.currencyStyle = "code";
cuppy.options.numberStyle = "compactShort";
cuppy.options.useGrouping = false;
cuppy.options.maxDigits = 3;
cuppy.options.yearFormatter = (value, year) => `${value} in ${year}`;
cuppy.options.inlineHintFormatter = (value, hint) => `${value} (${hint})`;
// Load inflation dataset
cuppy.dataset(cpiU);
// Format all Cuppies on the page!
cuppy();
```
## Documentation
For more information, see the respective READMEs for each package:
- [@cuppy/core](core/README.md)
- [@cuppy/cpi-u](datasets/cpi-u/README.md)
- [@cuppy/demo](demo/README.md)
- [Dataset updater](scripts/update-datasets/README.md)
## Roadmap
At the moment Cuppy only supports U.S. dollars and the [Consumer Price Index for All Urban Consumers (CPI-U)](datasets/cpi-u) dataset. However, it is flexible enough to accomodate new currencies and inflation datasets via plugins.
There are a few different directions Cuppy could go in the future. One possibility is to retrieve the inflation data from an API instead of bundling it with the library. This would allow automatic updates of the inflation data without requiring end users to update their version of Cuppy.
Another high-impact improvement would be treeshaking support for datasets. Currently, the entire inflation dataset is bundled with the library even if only a subset of the data is used (which I imagine is the case for most users).
However, my main focus for the near future is refining the mobile experience with a more accessible alternative to tooltips, and on the code quality front, improving test coverage and code organization.
## Contributing
If you like the idea and want to help make it better, please consider contributing! It can be as simple as opening an issue to report a bug or suggest an improvement, or as involved as implementing a new feature or fixing a bug yourself. For more information, see [CONTRIBUTING.md](CONTRIBUTING.md).
## License
Cuppy is licensed under the [MIT License](LICENSE).