# @pagasa-parser/formatter-signals

> Generates storm signal images from PAGASA Parser bulletins.

Latest version **0.1.2** (published 2022-04-10) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @pagasa-parser/formatter-signals
pnpm add @pagasa-parser/formatter-signals
yarn add @pagasa-parser/formatter-signals
bun add @pagasa-parser/formatter-signals
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2022-04-10 |
| First published | 2022-02-27 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=13 |
| Dependencies | 4 |
| Unpacked size | 7.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Chlod Alejandro |
| Maintainers | chlodalejandro |
| Keywords | scraper, weather, json, philippines, typhoon |

## Links

- npm: https://www.npmjs.com/package/@pagasa-parser/formatter-signals
- Repository: https://github.com/pagasa-parser/template
- Homepage: https://github.com/pagasa-parser/template#readme
- Issues: https://github.com/pagasa-parser/template/issues
- npm.io page: https://npm.io/package/@pagasa-parser/formatter-signals

## Dependencies (4)

- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.10
- [svgpath](https://npm.io/package/svgpath.md) ^2.5.0
- [scale-that-svg](https://npm.io/package/scale-that-svg.md) ^1.0.5
- [svg-path-parser](https://npm.io/package/svg-path-parser.md) ^1.1.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.1.2 (latest) — 2022-04-10
- 0.1.1 — 2022-04-10
- 0.1.0 — 2022-02-27

## README

# @pagasa-parser/formatter-signals
[![npm version](https://img.shields.io/npm/v/@pagasa-parser/formatter-signals.svg?style=flat-square)](https://www.npmjs.org/package/@pagasa-parser/formatter-signals)
[![npm downloads](https://img.shields.io/npm/dm/@pagasa-parser/formatter-signals.svg?style=flat-square)](http://npm-stat.com/charts.html?package=@pagasa-parser/formatter-signals)

This plugin for [pagasa-parser](https://github.com/pagasa-parser/pagasa-parser) allows for the
creation of colored SVG maps with appropriate legends including a province's current Tropical
Cyclone Warning System level. It is aimed to be a faithful recreation of the PAGASA-provided
signal maps, albeit with a higher (vectorized) quality and configurability.

Some processing is done in different stages of execution:
* Pre-runtime:
  * Initializing static features of the map, such as changing its background color.
  * Building the package for use.
* Runtime:
  * Actual execution and processing of the Bulletin object.
  * Changing the colors of each province on the map to their respective TCWS levels.
  * Cropping the map only to include parts which have raised signals, with extra space for legends.
  * Changing the stroke width for municipalities and provinces for clarity on smaller scales.
  * _(to do)_ Adding the legends and province names.
  * _(to do)_ Rendering the image, if creating a raster file.

## Developing
Make sure to run `node scripts/map-generator.js` to generate the base map. If you're using the npm package, there's no need to perform this step as the base map is prepackaged.

---
_Source: https://npm.io/package/@pagasa-parser/formatter-signals · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._