metar-taf-parser 1.0.0 → 1.0.1

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,11 +1,9 @@
 # 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 fully typed and tested with i18n support, and can run on Node or the browser.
 
 ## Example
 
-⚠️ This project is an active work in progress. These examples do not currently work.
-
 ### Parse METAR
 
 ```ts
@@ -13,7 +11,7 @@ import { parseMetar } from 'metar-taf-parser'
 
 // Get the raw METAR/TAF strings in your preferred way
 // For example: https://www.aviationweather.gov/dataserver
-const { metar } = await myService.getAirportData('KMSN')
+// const { metar } = await myService.getAirportData('KMSN')
 
 // Readily serializable
 const metarResult = parseMetar(metar)
@@ -28,7 +26,7 @@ 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')
+// const { taf } = await myService.getAirportData('KMSN')
 
 // Readily serializable
 const tafResult = parseTAF(taf)
@@ -47,8 +45,16 @@ const { metar } = await myService.getAirportData('KMSN')
 const metarResult = parseMetar(metar, { locale: de })
 ```
 
+## 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.
+
 ## Development
 
 ### Example site
 
-Please see [the example site README.md](example/README.md).
+Please see [the example site README.md](example/README.md).
+
+## 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/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,6 +1,6 @@
 {
   "name": "metar-taf-parser",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Parse METAR and TAF files",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",