TypeScript Docs

.eslintignore

@@ -0,0 +1,4 @@
+build/**
+dist/**
+coverage/**
+*.d.ts

.eslintrc.cjs

@@ -0,0 +1,25 @@
+module.exports = {
+  plugins: ['svelte', 'typescript'],
+  rules: {
+    'no-console': 0,
+    'no-undefined': 1,
+    'no-unused-vars': ['error', { ignoreRestSiblings: true }],
+    camelcase: 0,
+    'import/no-namespace': 0,
+    'import/no-extraneous-dependencies': 0,
+    // The most trash rule in existence
+  },
+  env: {
+    browser: true,
+    node: true,
+    webextensions: true,
+    es2022: true,
+  },
+  parserOptions: { /*ecmaVersion: 12,*/ sourceType: 'module' },
+  overrides: [
+    {
+      files: ['*.svelte'],
+      processor: 'svelte/svelte',
+    },
+  ],
+};

.github/workflows/pages.yml

@@ -0,0 +1,32 @@
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x.x
+
+      - run: yarn
+      - run: yarn typedoc src/index.ts
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs
+

.gitignore

@@ -9,6 +9,7 @@ cypress/videos
 dist
 build
 public
+docs
 .idea
 test-report.xml
 

.npmignore

@@ -11,6 +11,7 @@ test-report.xml
 # misc folders
 coverage
 dist
+docs
 public
 recipes
 cypress

.npmrc

@@ -1 +1,2 @@
 registry=https://registry.npmjs.org/
+legacy-peer-deps=true