try to build docs in actions; cleanup project to only be a specification

.github/workflows/pages.yml

@@ -0,0 +1,44 @@
+name: pages-workflow
+
+on:
+  push:
+    branches:
+      - master
+
+  # This event is required to deploy to GitHub Pages with actions/deploy-pages@v4
+  workflow_run:
+    workflows: ["Generate and Deploy Docs"]
+    types:
+      - completed
+
+jobs:
+  generate-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up Bun
+      uses: oven-sh/setup-bun@v1
+      with:
+        bun-version: 1.1.29
+
+    - name: Build the docs
+      run: bun run docs
+
+    - name: Upload artifacts
+      uses: actions/upload-pages-artifact@v1
+      with:
+        path: ./docs  # Path to the docs folder
+
+  deploy-docs:
+    runs-on: ubuntu-latest
+    needs: generate-docs
+    permissions:
+      pages: write  # Needed to deploy to GitHub Pages
+      id-token: write  # Needed for authentication
+
+    steps:
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4

.github/workflows/test.yml

@@ -6,19 +6,19 @@ jobs:
   test:
     name: Test
     runs-on: ${{ matrix.os }}
-    
+
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Set up Bun
       uses: oven-sh/setup-bun@v1
       with:
-        bun-version: 1.1.26
+        bun-version: 1.1.29
 
     - name: Install dependencies
       run: bun install
@@ -31,7 +31,7 @@ jobs:
       with:
         toolchain: stable
         override: true
-    
+
     - name: Install Rustfmt
       run: rustup component add rustfmt
 

.gitignore

@@ -12,3 +12,4 @@ server/out/**
 coverage/**
 *.profraw
 cobertura.xml
+docs/

README.md

@@ -21,9 +21,6 @@
   <a href="https://docs.rs/s2json">
     <img src="https://img.shields.io/badge/docs-rust-yellow.svg" alt="docs-rust">
   </a>
-  <a href="https://coveralls.io/github/Open-S2/s2json?branch=master">
-    <img src="https://coveralls.io/repos/github/Open-S2/s2json/badge.svg?branch=master" alt="code-coverage">
-  </a>
   <a href="https://discord.opens2.com">
     <img src="https://img.shields.io/discord/953563031701426206?logo=discord&logoColor=white" alt="Discord">
   </a>
@@ -88,6 +85,10 @@ Notable features of S2JSON are:
 
 [s2json-spec](/s2json-spec/1.0.0/README.md)
 
+## Implementations
+
+* [s2-tools](https://github.com/Open-S2/s2-tools)
+
 ## Install
 
 ```bash

eslint.config.mjs

@@ -24,6 +24,31 @@ export default tseslint.config(
   jsdoc.configs['flat/recommended-typescript'],
   {
     rules: {
+      // ensure explicit comparisons
+      eqeqeq: ['error', 'always'],
+      'no-implicit-coercion': ['error', { boolean: false, number: true, string: true }],
+      '@typescript-eslint/strict-boolean-expressions': [
+        'error',
+        {
+          allowString: false,
+          allowNumber: false,
+          allowNullableObject: false,
+          allowNullableBoolean: false,
+          allowNullableString: false,
+          allowNullableNumber: false,
+          allowAny: false,
+        },
+      ],
+      'no-extra-boolean-cast': 'error',
+      'no-constant-condition': ['error', { checkLoops: false }],
+      'no-unused-expressions': ['error', { allowTernary: true, allowShortCircuit: true }],
+      // manage promises correctly
+      '@typescript-eslint/no-misused-promises': 'error',
+      'no-async-promise-executor': 'error',
+      '@typescript-eslint/no-floating-promises': 'error',
+      '@typescript-eslint/prefer-promise-reject-errors': 'error',
+      '@typescript-eslint/promise-function-async': 'error',
+      'require-await': 'error',
       // console logs
       'no-console': ['error', { allow: ['info', 'warn', 'error'] }],
       // https://github.com/gajus/eslint-plugin-jsdoc