SEPTENTRIO-SBF: v1.0.0

core-marine-dev · May 20, 2024 · 654be3b · 654be3b
2 parents 362862e + a7e6d05
commit 654be3b
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 20 deletions.
diff --git a/.github/workflows/septentrio-sbf.yml b/.github/workflows/septentrio-sbf.yml
@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
   push:
     paths:
-      - septentrio-sbf/**
+      - packages/septentrio-sbf/**
 
 jobs:
   test:
@@ -17,10 +17,10 @@ jobs:
 
     steps:
       - name: 👍 Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: ❇️ Setup node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
@@ -39,10 +39,10 @@ jobs:
 
     steps:
       - name: 👍 Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: ❇️ Setup node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 20
           registry-url: 'https://registry.npmjs.org'
@@ -54,6 +54,6 @@ jobs:
         run: "npm run septentrio-sbf:build"
 
       - name: 🚀 Publish to npm
-        run: "npm publish --access public --workspace=@coremarine/sbf-parser"
+        run: "npm publish --access public --workspace=@coremarine/septentrio-sbf"
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/package.json b/package.json
@@ -53,11 +53,11 @@
     "norsub-emru:test:coverage": "npm run test:coverage --workspace=@coremarine/norsub-emru",
     "norsub-emru:nodered:docker": "npm run docker --workspace=@coremarine/norsub-emru-nodered",
     "norsub-emru:nodered:test": "npm run test --workspace=@coremarine/norsub-emru-nodered",
-    "septentrio-sbf:lint": "npm run lint --workspace=@coremarine/sbf-parser",
-    "septentrio-sbf:format": "npm run format --workspace=@coremarine/sbf-parser",
-    "septentrio-sbf:build": "npm run build --workspace=@coremarine/sbf-parser",
-    "septentrio-sbf:test": "npm run test --workspace=@coremarine/sbf-parser",
-    "septentrio-sbf:coverage": "npm run test:coverage --workspace=@coremarine/sbf-parser",
+    "septentrio-sbf:lint": "npm run lint --workspace=@coremarine/septentrio-sbf",
+    "septentrio-sbf:format": "npm run format --workspace=@coremarine/septentrio-sbf",
+    "septentrio-sbf:build": "npm run build --workspace=@coremarine/septentrio-sbf",
+    "septentrio-sbf:test": "npm run test --workspace=@coremarine/septentrio-sbf",
+    "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",
     "thelmabiotel-tblive:lint": "npm run lint --workspace=@coremarine/thelmabiotel-tblive",

diff --git a/packages/septentrio-sbf/README.md b/packages/septentrio-sbf/README.md
@@ -70,7 +70,7 @@ This is important
 First of all, import the parser
 
 ```typescript
-import { SBFParser } from 'sbf-parser'
+import { SBFParser } from '@coremarine/septentrio-sbf'
 ```
 
 ### 2. Creating an instance
@@ -87,7 +87,7 @@ SBFParser([firmware: Firmware = '4.10.1', memory: boolean = false])
     To know supported firmwares just consult with
 
     ```typescript
-    import { availableFirmwares } from 'sbf-parser'
+    import { availableFirmwares } from '@coremarine/septentrio-sbf'
     const firmwares = availableFirmwares()
     ```
 

diff --git a/packages/septentrio-sbf/src/gpstime.d.ts → packages/septentrio-sbf/gpstime.d.ts b/packages/septentrio-sbf/src/gpstime.d.ts → packages/septentrio-sbf/gpstime.d.ts
diff --git a/packages/septentrio-sbf/package.json b/packages/septentrio-sbf/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@coremarine/septentrio-sbf",
-  "version": "1.0.2",
+  "version": "1.0.0",
   "author": "CoreMarine",
   "description": "It is a library to parse SBF data. SBF is a private binary protocol of Septentrio trademark which uses in its GNSS devices",
   "license": "MIT",
@@ -25,14 +25,30 @@
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "sideEffects": false,
   "files": [
-    "/dist"
+    "dist"
   ],
+  "engines": {
+    "node": ">= 18"
+  },
   "scripts": {
+    "build": "npm run types && npm run format && tsup",
     "lint": "ts-standard",
     "format": "ts-standard --fix",
-    "build": "tsc",
-    "types": "mkdir node_modules/@types/gpstime && cp src/gpstime.d.ts node_modules/@types/gpstime/index.d.ts",
+    "types": "mkdir -p ../../node_modules/@types/gpstime && cp gpstime.d.ts ../../node_modules/@types/gpstime/index.d.ts",
     "test": "vitest",
     "test:coverage": "vitest run --coverage"
   },
@@ -44,6 +60,8 @@
     "ignore": [
       "tests",
       "vitest.config.ts",
+      "tsup.config.ts",
+      "gpstime.d.ts",
       "examples/*"
     ]
   },

diff --git a/packages/septentrio-sbf/tsup.config.ts b/packages/septentrio-sbf/tsup.config.ts
@@ -0,0 +1,11 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+  entry: ['./src/index.ts'],
+  clean: true,
+  format: ['esm', 'cjs'],
+  minify: false,
+  dts: true,
+  splitting: true,
+  outDir: './dist'
+})
diff --git a/packages/septentrio-sbf/vitest.config.ts b/packages/septentrio-sbf/vitest.config.ts
@@ -8,8 +8,7 @@ export default defineConfig({
         '**/*/constants.ts',
         '**/*/types.ts',
         'dist/*',
-        'examples/*',
-        'src/gpstime.d.ts'
+        'gpstime.d.ts'
       ]
     }
   }

diff --git a/vitest.workspace.ts b/vitest.workspace.ts
@@ -1,7 +1,7 @@
 import { defineWorkspace } from 'vitest/config'
 
 export default defineWorkspace([
-  'nmea-parser/*',
+  'packages/**/*',
   // 'nmea-parser-nodered/*',
   // 'norsub-emru/*',
   // 'norsub-emru-nodered/*',