bmssp 0.6.0 → 0.8.0

package/README.md

@@ -1,6 +1,6 @@
 # Tsinghua Single Source Shortest Paths algorithm
 
-This is a repository containing implementation varieties based on the paper written by Duan Ran et. al. from Tsinghua University.
+This is a repository containing a simple community driven implementation in Javascript based on the paper written by Duan Ran et. al. from Tsinghua University.
 "Breaking the Sorting Barrier for Directed Single-Source Shortest Paths".
 
 https://dl.acm.org/doi/10.1145/3717823.3718179
@@ -13,18 +13,9 @@ We give a deterministic O(mlog2/3n)-time algorithm for single-source shortest pa
 
 ## Development Details
 
-This project is mainly focused in Javascript (in order to be published to npmjs.com via github Actions).
+This project is mainly focused in Javascript in order to be published to npmjs.com as a JS module (esmodule).
 
-### Other Implementations
+### Other Implementations in GitHub
 
 https://github.com/search?q=bmssp&type=repositories
 
-Rust:
-  - https://github.com/lucas-montes/bmssp - Available as a crate to pull.
-
-Java:
-  - https://github.com/PatrickDiallo23/BMSSP-Java
-
-Python:
-  - https://github.com/sidharthpunathil/fastest-shortest-path-algo-poc
-  - https://github.com/simpsonresearch/tsinghua_benchmarks/tree/main

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "bmssp",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Javascript package implementation of the bmssp algorithm.",
+  "main": "src/bmssp.mjs",
   "keywords": [
     "shortest-paths",
     "bmssp",
@@ -19,11 +20,34 @@
   "license": "MPL-2.0",
   "author": "Saul Ivan Rivas Vega",
   "type": "module",
-  "main": "index.js",
   "directories": {
     "doc": "docs"
   },
+  "files": [
+    "src/",
+    "docs/",
+    "package.json",
+    "package-lock.json",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
-    "test": "node test/main.js"
+    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --coverage",
+    "lint": "npm run prettier && npm run eslint",
+    "format": "npm run prettier:fix && npm run eslint:fix",
+    "eslint": "eslint --max-warnings=0 .",
+    "eslint:fix": "eslint --fix .",
+    "prettier": "prettier --check \"./**/{*.js,*.mjs}\"",
+    "prettier:fix": "prettier --write \"./**/{*.js,*.mjs}\""
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.34.0",
+    "@eslint/markdown": "^7.2.0",
+    "eslint": "^9.34.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "globals": "^16.3.0",
+    "jest": "^30.1.1",
+    "prettier": "3.6.2"
   }
 }

package/src/bmssp.mjs

@@ -1,5 +1,9 @@
 function printMessage(message) {
-    console.log(message);
+  return message;
 }
 
-export { printMessage };
+function processMessage(message) {
+  return `Processed: ${message}`;
+}
+
+export { printMessage, processMessage };

package/.editorconfig

@@ -1,7 +0,0 @@
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 2
-indent_style = space
-insert_final_newline = true
-trim_trailing_whitespace = true

package/.github/dependabot.yml

@@ -1,19 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
-version: 2
-updates:
-  - package-ecosystem: "docker"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-  - package-ecosystem: "npm" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"

package/.github/workflows/dockerhub-build-publish.yml

@@ -1,51 +0,0 @@
-name: Build and publish Docker image
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  docker-build-and-publish:
-    environment:
-      name: dockerhub
-
-    runs-on: ubuntu-latest
-
-    permissions:
-      contents: read
-
-    steps:
-      - name: Docker meta
-        id: meta
-        uses: docker/metadata-action@v5
-        with:
-          # list of Docker images to use as base name for tags
-          images: |
-            sirivasv/bmssp-js
-          # generate Docker tags based on the following events/attributes
-          tags: |
-            type=semver,pattern={{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-      - name: Checkout code
-        uses: actions/checkout@v5
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Build and push
-        uses: docker/build-push-action@v6
-        with:
-          context: .
-          platforms: linux/amd64,linux/arm64
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}

package/.github/workflows/npm-build.yml

@@ -1,34 +0,0 @@
-name: Build npm package
-
-on:
-  pull_request:
-    branches: [main]
-  push:
-    branches: [main]
-
-jobs:
-  npm-build:
-    runs-on: ubuntu-latest
-
-    permissions:
-      contents: read
-
-    strategy:
-      matrix:
-        node-version: [24.x]
-
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v5
-
-    - name: Setup Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-
-    - name: Install dependencies
-      run: npm ci
-
-    - name: Run tests
-      run: npm test

package/.github/workflows/npm-publish.yml

@@ -1,37 +0,0 @@
-name: Publish npm package
-on:
-  release:
-    types: [published]
-jobs:
-  npm-publish:
-    environment:
-      name: npm-bmssp
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [24.x]
-
-    permissions:
-      contents: read
-      id-token: write
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v5
-
-      - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'npm'
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Publish package
-        run: npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/static.yml

@@ -1,45 +0,0 @@
-# Simple workflow for deploying static content to GitHub Pages
-name: Deploy static content to Pages
-
-on:
-  # Runs on pushes targeting the default branch
-  push:
-    branches: ["main"]
-    paths:
-      - 'docs/**'
-
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
-jobs:
-  # Single deploy job since we're just deploying
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v5
-      - name: Setup Pages
-        uses: actions/configure-pages@v5
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v4
-        with:
-          # Upload entire repository
-          path: 'docs/'
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4

package/Dockerfile

@@ -1,13 +0,0 @@
-FROM node:24-alpine
-
-WORKDIR /app
-
-# Copy package files and install dependencies
-COPY package*.json ./
-RUN npm install
-
-# Mount src/ directory as a volume
-VOLUME ["src/", "tests/"]
-
-# Default command (can be overridden)
-CMD ["node", "tests/main.js"]

package/test/main.js

@@ -1,12 +0,0 @@
-import { printMessage } from "../src/bmssp.mjs";
-
-function testFunction() {
-    try {
-        const result = printMessage("Hello, World!");
-        console.log('Test passed:', result);
-    } catch (error) {
-        console.error('Test failed:', error.message);
-    }
-}
-
-testFunction();