SBG-ECOM: v0.0.1

SBG-ECOM: v0.0.1

.github/workflows/sbg-ecom.yml

@@ -0,0 +1,59 @@
+name: sbg-ecom
+
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - packages/sbg-ecom/**
+
+jobs:
+  # test:
+  #   name: 🧪 Test
+  #   runs-on: ubuntu-latest
+
+  #   strategy:
+  #     matrix:
+  #       node-version: [18.x, 20.x]
+
+  #   steps:
+  #     - name: 👍 Checkout
+  #       uses: actions/checkout@v4
+
+  #     - name: ❇️ Setup node.js
+  #       uses: actions/setup-node@v4
+  #       with:
+  #         node-version: ${{ matrix.node-version }}
+  #         cache: 'npm'
+
+  #     - name: 📥 Install Dependencies
+  #       run: npm install
+
+  #     - name: 🧑‍🔬 Tests
+  #       run: "npm run sbg-ecom:test"
+
+  publish:
+    name: 🚀 Publish
+    runs-on: ubuntu-latest
+    # needs: test
+    if: github.ref == 'refs/heads/main'
+
+    steps:
+      - name: 👍 Checkout
+        uses: actions/checkout@v4
+
+      - name: ❇️ Setup node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: 📥 Install Dependencies
+        run: npm install
+
+      - name: 🛠️ Build
+        run: "npm run sbg-ecom:build"
+
+      - name: 🚀 Publish to npm
+        run: "npm publish --access public --workspace=@coremarine/sbg-ecom"
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -2,6 +2,7 @@
 .idea
 .DS_Store
 packages/**/lib/
+imgs/discards
 
 # Logs
 logs

CONTRIBUTING.md

@@ -34,7 +34,7 @@ New packages will be publish when a pull request into `main` branch is accepted.
 
 ### How to create a TypeScript library
 
-1. Copy the `template-library` folder inside packages and paste as a new folder
+1. Copy the `library` folder inside `templates` and paste as a new folder inside `packages` -> `packages/<your-library>`
 2. Look for the keyword `TODO:` in your IDE / Editor inside that folder, this is a hint to places you need to setup.
 3. Setup npm package -> Modify library `package.json` (`packages/<your-library>/package.json`)
     1. `name` to `@coremarine/<your-library>`
@@ -48,16 +48,15 @@ New packages will be publish when a pull request into `main` branch is accepted.
     4. `test`
     5. `test:coverage`
 5. Setup CI/CD (Github Actions)
-    1. Go to `.github/workflows` folder
-    2. Copy `template-library.yml` file and paste as a new yml file `<your-library>.yml`
-    3. Change all TODO:
+    1. Copy `library.yml` file inside `templates` and paste as a new yml file `<your-library>.yml` inside `.github/workflows` folder
+    2. Change all TODO:
 6. Document your library -> Modify `README.md` (`packages/<your-library>/README.md`)
 7. Start with your library by coding in `src` and testing in `tests`
 8. Link your new library in the global / monorepo README
 
 ### How to create a NodeRED component
 
-1. Copy the `template-nodered` folder inside packages and paste as a new folder ending with `-nodered` -> `packages/<your-library>-nodered`
+1. Copy the `nodered` folder inside `templates` and paste as a new folder ending with `-nodered` inside `packages` -> `packages/<your-library>-nodered`
 2. Look for the keyword `TODO:` in your IDE / Editor inside that folder, this is a hint to places you need to setup.
 3. Setup npm package -> Modify library `package.json` (`packages/<your-library>/package.json`)
     1. `name` to `@coremarine/<your-library>`
@@ -70,9 +69,8 @@ New packages will be publish when a pull request into `main` branch is accepted.
     1. `nodered:docker`
     2. `nodered:test`
 5. Setup CI/CD (Github Actions)
-    1. Go to `.github/workflows` folder
-    2. Copy `template-nodered.yml` file and paste as a new yml file `<your-library>-nodered.yml`
-    3. Change all TODO:
+    1. Copy `nodered.yml` file inside `templates` and paste as a new yml file `<your-library>-nodered.yml` inside `.github/workflows` folder
+    2. Change all TODO:
 6. Document your library -> Modify `README.md` (`packages/<your-library>-nodered/README.md`)
 7. Add component dependencies to package `Dockerfile` file
 8. Rename project into package `docker-compose.yml` file

clean_monorepo.sh

@@ -1,5 +1,6 @@
 rm -rf node_modules \
   packages/nmea-parser/dist         packages/nmea-parser/node_modules          packages/nmea-parser/coverage \
   packages/norsub-emru/dist         packages/norsub-emru/node_modules          packages/norsub-emru/coverage \
+  packages/sbg-ecom/dist            packages/sbg-ecom/node_modules             packages/sbg-ecom/coverage \
   packages/septentrio-sbf/dist      packages/septentrio-sbf/node_modules       packages/septentrio-sbf/coverage \
   packages/thelmabiotel-tblive/dist packages/thelmabiotel-tblive/node_modules  packages/thelmabiotel-tblive/coverage

package.json

@@ -60,6 +60,13 @@
     "septentrio-sbf:coverage": "npm run test:coverage --workspace=@coremarine/septentrio-sbf",
     "septentrio-sbf:nodered:docker": "npm run docker --workspace=@coremarine/septentrio-sbf-nodered",
     "septentrio-sbf:nodered:test": "npm run test --workspace=@coremarine/septentrio-sbf-nodered",
+    "sbg-ecom:lint": "npm run lint --workspace=@coremarine/sbg-ecom",
+    "sbg-ecom:format": "npm run format --workspace=@coremarine/sbg-ecom",
+    "sbg-ecom:build": "npm run build --workspace=@coremarine/sbg-ecom",
+    "sbg-ecom:test": "npm run test --workspace=@coremarine/sbg-ecom",
+    "sbg-ecom:coverage": "npm run test:coverage --workspace=@coremarine/sbg-ecom",
+    "sbg-ecom:nodered:docker": "npm run docker --workspace=@coremarine/sbg-ecom-nodered",
+    "sbg-ecom:nodered:test": "npm run test --workspace=@coremarine/sbg-ecom-nodered",
     "thelmabiotel-tblive:lint": "npm run lint --workspace=@coremarine/thelmabiotel-tblive",
     "thelmabiotel-tblive:format": "npm run format --workspace=@coremarine/thelmabiotel-tblive",
     "thelmabiotel-tblive:build": "npm run build --workspace=@coremarine/thelmabiotel-tblive",
@@ -86,7 +93,8 @@
   },
   "ts-standard": {
     "ignore": [
-      "vitest.workspace.ts"
+      "vitest.workspace.ts",
+      "templates"
     ]
   }
 }

packages/nmea-parser-nodered/.gitignore

@@ -11,7 +11,10 @@
 .flows*
 flows_cred.json
 tests/nodered/data/package.json
-
+testing-checklist.md
+TESTS.md
+lines.js
+tests/nodered/tests/*.txt
 # Logs
 logs
 *.log

packages/nmea-parser/.gitignore

@@ -4,6 +4,8 @@
 .DS_Store
 docs
 lib
+tests/*.txt
+*.tss
 
 # Logs
 logs