metar-taf-parser 1.0.0 → 1.1.0

package/LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) 2021 Alexander Harding
+Copyright (c) 2022 Alexander Harding
+Copyright 2021 Jean-Kevin KPADEY
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,42 +1,36 @@
-# metar-taf-parser
+# ✈️ [metar-taf-parser](https://aeharding.github.io/metar-taf-parser)
 
-This is a port of [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser) to typescript. It's fully typed and tested with i18n support, and can run on Node or the browser.
+This is a port of [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser) to Typescript. It's dependency-free, fully typed, tested, has i18n support, and can run on Node or the browser.
 
-## Example
+[Check out the demo here](https://aeharding.github.io/metar-taf-parser)
 
-⚠️ This project is an active work in progress. These examples do not currently work.
+## Installation
 
-### Parse METAR
+```sh
+yarn add metar-taf-parser
+# or
+npm i --save metar-taf-parser
+```
 
-```ts
-import { parseMetar } from 'metar-taf-parser'
+## Usage
 
-// Get the raw METAR/TAF strings in your preferred way
-// For example: https://www.aviationweather.gov/dataserver
-const { metar } = await myService.getAirportData('KMSN')
+### Parse a METAR
 
-// Readily serializable
-const metarResult = parseMetar(metar)
+```ts
+import { parseMetar } from 'metar-taf-parser'
 
-// Your code here 🚀
+const metar = parseMetar(rawMetarString)
 ```
 
-### Parse TAF
+### Parse a TAF
 
 ```ts
 import { parseTAF } from 'metar-taf-parser'
 
-// Get the raw METAR/TAF strings in your preferred way
-// For example: https://www.aviationweather.gov/dataserver
-const { taf } = await myService.getAirportData('KMSN')
-
-// Readily serializable
-const tafResult = parseTAF(taf)
-
-// Your code here 🚀
+const taf = parseTAF(rawTAFString)
 ```
 
-### i18n
+## i18n
 
 ```ts
 import { parseMetar } from 'metar-taf-parser'
@@ -51,4 +45,12 @@ const metarResult = parseMetar(metar, { locale: de })
 
 ### Example site
 
-Please see [the example site README.md](example/README.md).
+Please see [the example site README.md](example/README.md).
+
+## Contributing
+
+This project is intended to provide feature parity with [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser) and will only accept PRs to maintain feature parity or to fix inconsistencies with that project.
+
+## Acknowledgment
+
+This software port was made possible due to the fantastic work of [@mivek](https://github.com/mivek) in [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser). If you like this project, please [consider buying @mivek a coffee](https://ko-fi.com/mivek).

package/dist/commons/i18n.js

@@ -5,11 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.format = exports._ = void 0;
 const en_1 = __importDefault(require("../locale/en"));
-const get_1 = __importDefault(require("lodash/get"));
+const helpers_1 = require("../helpers/helpers");
 const errors_1 = require("./errors");
 exports.default = en_1.default;
 function _(path, lang) {
-    const translation = (0, get_1.default)(lang, path);
+    const translation = (0, helpers_1.resolve)(lang, path);
     if (!translation || typeof translation !== "string")
         throw new errors_1.TranslationError(path);
     return translation;

package/dist/helpers/helpers.d.ts

@@ -2,3 +2,9 @@
  * Split behaving similar to Python's implementation
  */
 export declare function pySplit(string: string, separator: string, n?: number): string[];
+/**
+ * Access nested object properties by string path
+ *
+ * https://stackoverflow.com/a/22129960
+ */
+export declare function resolve(obj: any, path: string | string[], separator?: string): unknown;

package/dist/helpers/helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pySplit = void 0;
+exports.resolve = exports.pySplit = void 0;
 /**
  * Split behaving similar to Python's implementation
  */
@@ -21,3 +21,13 @@ function pySplit(string, separator, n) {
     return out;
 }
 exports.pySplit = pySplit;
+/**
+ * Access nested object properties by string path
+ *
+ * https://stackoverflow.com/a/22129960
+ */
+function resolve(obj, path, separator = ".") {
+    const properties = Array.isArray(path) ? path : path.split(separator);
+    return properties.reduce((prev, curr) => prev === null || prev === void 0 ? void 0 : prev[curr], obj);
+}
+exports.resolve = resolve;

package/dist/model/model.d.ts

@@ -84,9 +84,9 @@ export interface IAbstractWeatherCode extends IAbstractWeatherContainer, ITime {
     trends: IAbstractTrend[];
 }
 export interface IMetar extends IAbstractWeatherCode {
-    temperature: number;
-    dewPoint: number;
-    altimeter: number;
+    temperature?: number;
+    dewPoint?: number;
+    altimeter?: number;
     nosig: boolean;
     auto: boolean;
     runwaysInfo: IRunwayInfo[];

package/dist/parser/parser.js

@@ -49,8 +49,6 @@ function parseDeliveryTime(timeString) {
         hour: +timeString.slice(2, 4),
         minute: +timeString.slice(4, 6),
     };
-    // TODO
-    // abstractWeatherCode.time = new Date()
 }
 /**
  * This function parses the array containing the remark and concat the array into a string
@@ -224,7 +222,6 @@ class MetarParser extends AbstractParser {
                 trendParts[i].startsWith(this.AT)) {
                 const trendTime = {
                     type: enum_1.TimeIndicator[trendParts[i].slice(0, 2)],
-                    // TODO implement time
                     hour: +trendParts[i].slice(2, 4),
                     minute: +trendParts[i].slice(4, 6),
                 };
@@ -244,18 +241,7 @@ class MetarParser extends AbstractParser {
      */
     parse(input) {
         const metarTab = this.tokenize(input);
-        const metar = Object.assign(Object.assign({}, parseDeliveryTime(metarTab[1])), { station: metarTab[0], message: input, 
-            // wind: IWind,
-            // visibility?: Visibility,
-            // verticalVisibility: number,
-            // windShear: IWindShear,
-            cavok: false, remark: "", remarks: [], clouds: [], weatherConditions: [], 
-            // airport: IAirport,
-            trends: [], 
-            // temperature: number,
-            // dewPoint: number,
-            // altimeter: number,
-            nosig: false, auto: false, runwaysInfo: [] }); // TODO remove cast
+        const metar = Object.assign(Object.assign({}, parseDeliveryTime(metarTab[1])), { station: metarTab[0], message: input, cavok: false, remark: "", remarks: [], clouds: [], weatherConditions: [], trends: [], nosig: false, auto: false, runwaysInfo: [] });
         let index = 2;
         while (index < metarTab.length) {
             if (!super.generalParse(metar, metarTab[index])) {
@@ -272,8 +258,8 @@ class MetarParser extends AbstractParser {
                         weatherConditions: [],
                         clouds: [],
                         times: [],
+                        remarks: [],
                     };
-                    // TODO - remove casting
                     index = this.parseTrend(index, trend, metarTab);
                     metar.trends.push(trend);
                 }

package/package.json

@@ -1,7 +1,16 @@
 {
   "name": "metar-taf-parser",
-  "version": "1.0.0",
-  "description": "Parse METAR and TAF files",
+  "version": "1.1.0",
+  "description": "Parse METAR and TAF reports",
+  "homepage": "https://aeharding.github.io/metar-taf-parser",
+  "keywords": [
+    "aviation",
+    "weather",
+    "metar",
+    "taf",
+    "report",
+    "deserialize"
+  ],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "author": "Alexander Harding <2166114+aeharding@users.noreply.github.com>",
@@ -16,7 +25,7 @@
     "start": "node --experimental-specifier-resolution=node --loader ts-node/esm lib",
     "check-types": "tsc --noEmit",
     "check-formatting": "prettier --check '**/*.{js,json,css,md,scss,tsx,ts}'",
-    "watch": "watch 'yarn build' lib",
+    "watch": "watch 'yarn build' src",
     "test": "jest --coverage",
     "test-watch": "jest --watch --coverage",
     "prepublishOnly": "yarn build"
@@ -28,10 +37,7 @@
   "devDependencies": {
     "@babel/preset-env": "^7.16.11",
     "@babel/preset-typescript": "^7.16.7",
-    "@types/fs-extra": "^9.0.12",
     "@types/jest": "^27.4.1",
-    "@types/lodash": "^4.14.181",
-    "fs-extra": "^10.0.0",
     "jest": "^27.5.1",
     "prettier": "^2.6.2",
     "ts-jest": "^27.1.4",
@@ -39,9 +45,5 @@
     "tsc-alias": "^1.6.6",
     "typescript": "^4.4.2",
     "watch": "^1.0.2"
-  },
-  "dependencies": {
-    "lodash": "^4.17.21",
-    "po2json": "^0.4.5"
   }
 }