clean up branches: merge v3 into master branch

.github/workflows/npm-publish.yml

@@ -9,92 +9,8 @@ on:
       - '*.*.*'
 
 jobs:
-  build-alt-win32:
-    name: Build alt-node Win32
-    runs-on: windows-2019
-    needs: [test]
-    steps:
-      - uses: actions/checkout@v2
-        name: Checkout
-        with:
-          submodules: true
-          lfs: true
-
-      - uses: actions/setup-node@v1
-        name: Setup Node.js 14.x
-        with:
-          node-version: 14.x
-
-      - uses: actions/cache@v2
-        id: cache
-        env:
-            cache-name: cache-node-modules
-        with:
-            key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
-            path: |
-                ~/.npm
-                node_modules
-            restore-keys: |
-                ${{ runner.os }}-build-${{ env.cache-name }}-
-
-      - name: Install Dependencies
-        if: steps.cache.outputs.cache-hit != 'true'
-        run: npm install
-
-      - name: Build
-        run: npm run build-alt
-
-      - name: Upload built script
-        uses: actions/upload-artifact@v2
-        with:
-            name: alt-compiled-win32
-            path: compiled
-            if-no-files-found: error
-
-  build-alt-unix:
-    name: Build alt-node Unix
-    runs-on: ubuntu-20.04
-    needs: [test]
-    steps:
-      - uses: actions/checkout@v2
-        name: Checkout
-        with:
-          submodules: true
-          lfs: true
-
-      - uses: actions/setup-node@v1
-        name: Setup Node.js 14.x
-        with:
-          node-version: 14.x
-
-      - uses: actions/cache@v2
-        id: cache
-        env:
-            cache-name: cache-node-modules
-        with:
-            key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
-            path: |
-                ~/.npm
-                node_modules
-            restore-keys: |
-                ${{ runner.os }}-build-${{ env.cache-name }}-
-
-      - name: Install Dependencies
-        if: steps.cache.outputs.cache-hit != 'true'
-        run: npm install
-
-      - name: Build
-        run: npm run build-alt
-
-      - name: Upload built script
-        uses: actions/upload-artifact@v2
-        with:
-            name: alt-compiled-unix
-            path: compiled
-            if-no-files-found: error
-
   test:
-    name: Build & Test (NAPI)
+    name: Build & Test
     runs-on: windows-2019
     strategy:
       matrix:
@@ -127,13 +43,16 @@ jobs:
         if: steps.cache.outputs.cache-hit != 'true'
         run: npm install
 
+      - run: npm run build
+        name: Build
+
       - run: npm test
-        name: Build & Test
+        name: Test
 
   publish-npm:
-    needs: [test, build-alt-win32, build-alt-unix]
+    needs: [test]
     runs-on: windows-2019
-    name: Build (NAPI) & Publish (ALL) Node Package Registry
+    name: Build & Publish to Node Package Registry
     steps:
       - uses: actions/checkout@v2
         name: Checkout
@@ -166,17 +85,8 @@ jobs:
       - run: npm run build
         name: Build
 
-      - name: Download alt-compiled-win32
-        uses: actions/download-artifact@v2
-        with:
-            name: alt-compiled-win32
-            path: compiled
-
-      - name: Download alt-compiled-unix
-        uses: actions/download-artifact@v2
-        with:
-            name: alt-compiled-unix
-            path: compiled
+      - run: npm run types
+        name: Generate type definitions
 
       - name: Extract version
         id: version

.github/workflows/test.yml

@@ -12,7 +12,7 @@ on:
 
 jobs:
   test:
-    name: Build & Test (NAPI)
+    name: Build & Test
     runs-on: windows-2019
     strategy:
       matrix:
@@ -45,5 +45,8 @@ jobs:
         if: steps.cache.outputs.cache-hit != 'true'
         run: npm install
 
+      - run: npm run build
+        name: Build
+
       - run: npm test
-        name: Build & Test
+        name: Test

.gitignore

@@ -17,4 +17,6 @@ cache
 jsconfig.json
 new.cfg
 compiled
-binding.gyp
+binding.gyp
+dist
+dist-types

.npmignore

@@ -13,4 +13,7 @@ server.log
 update.json
 .vscode
 .github
-deps/alt-node
+deps/alt-node
+src
+dist/*.d.ts
+dist-types

.vscode/tasks.json

@@ -10,7 +10,7 @@
 			},
 			"problemMatcher": [],
 			"label": "npm: build",
-			"detail": "node-gyp rebuild"
+			"detail": "rollup -c"
 		}
 	]
 }

README.md

@@ -6,25 +6,30 @@
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/aec7d7510bb34f138b70c304818945e4)](https://www.codacy.com/gh/Timo972/cfg-reader/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Timo972/cfg-reader&utm_campaign=Badge_Grade)
 [![Latest Build](https://github.com/Timo972/cfg-reader/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/Timo972/cfg-reader/actions/workflows/npm-publish.yml)
 
+## Deprecation notice
+⚠️ alt:V has moved to toml configuration files, so this package is obsolete
+
 ## License and copyright notice
 
 [alt-config (MIT)](https://github.com/altmp/alt-config)
 
 ## Important
-Keep in mind this module is a native addon and its important to reinstall if you change your node version.  
 - supported node version >= 12
 - Since v2.1.0 you can use this module for the alt:V nodejs version and default nodejs version at the same time.
 ---
 ## Installation (works for alt:V too)
 
 ```bash
-npm i --save cfg-reader
+npm i --save cfg-reader@latest
 ```
 ---
-## Differences between v1
+## Differences between v2
+The cfg-reader is now a full typescript port of the open source alt-config parser from the altMP Team.  
+
+## Breaking changes
+- Config::save() returns Promise<void>
+- Config::getOfType() uses generics and only accepts key as argument
 
-The cfg-reader is now using the open source alt-config parser from the altMP Team.  
-It should be way faster than my own parser in v1.
 ## How to use
 
 ```js
@@ -34,15 +39,16 @@ const val = myCfg.get("test");
 //with the get method you can easiely filter the lines you need
 ```
 
-```js
-const { Config, Type } = require("cfg-reader");
+```ts
+import { Config, Type } = from "cfg-reader";
 const testCfg = new Config("test.cfg");
 // If you know which type the value you want to get has you can use
 // getOfType(key: string, type: number).
 // It directly converts the value to the specific type
 // and does not have to iterate over all possible types.
 // -> little faster
-testCfg.getOfType("test", Type.String);
+const myString = testCfg.getOfType<string>("test");
+// typeof myString === "string";
 ```
 
 ## API
@@ -70,6 +76,8 @@ const config = new require('cfg-reader').Config('config.cfg');
 // import { Config } from 'cfg-reader';
 // const config = new Config('config.cfg');
 const con = mysql.createConnection(config.get('mysql'));
+// or
+const con = mysql.createConnection(config.config.mysql);
 ...
 ```