Merge pull request #21 from MaddyGuthridge/maddy-ssh-keygen

Add support for custom SSH config

Author: MaddyGuthridge

design/Setup.md

@@ -1,12 +1,20 @@
 # Setup process
 
-1. User specifies a data repository URL, which is then cloned.
-2. If the repo is empty, some default data is configured:
-    * `config.json` with the site's default configuration
-    * `.gitignore` with a simple gitignore to ignore the local configuration
-3. Otherwise, the `.gitignore` is checked to ensure that `config.local.json`
-   will be ignored (lest auth information be leaked).
-4. A secure password is generated, and stored securely in `config.local.json`.
-   It is shown to the user once, and they are prompted to take note of it.
-
-The site is then fully configured.
+## 1. Account creation
+
+The user creates the initial account, which triggers the private data setup.
+
+## 2. Data initialization
+
+The user then chooses how to initialize the repo:
+
+* From a `git` repo. The repo is cloned.
+* Empty, meaning a new blank repository is created.
+
+The user is also given the options to control how the server uses SSH keys.
+Allowed options are:
+
+* Generate an SSH key-pair, stored within the private data.
+* Use an existing private key given its path.
+* Use the default SSH identity, which works best if the app is running on an
+  account with existing SSH access.

eslint.config.mjs

@@ -2,11 +2,13 @@
 import js from '@eslint/js';
 import ts from 'typescript-eslint';
 import svelte from 'eslint-plugin-svelte';
+import svelteParser from 'svelte-eslint-parser';
 import globals from 'globals';
 
 export default ts.config(
   js.configs.recommended,
-  ...ts.configs.recommended,
+  ...ts.configs.recommendedTypeChecked,
+  ...ts.configs.stylisticTypeChecked,
   ...svelte.configs['flat/recommended'],
   {
     languageOptions: {
@@ -19,39 +21,68 @@ export default ts.config(
     }
   },
   {
-    files: ['**/*.svelte'],
     languageOptions: {
+      parser: ts.parser,
       parserOptions: {
-        parser: ts.parser
-      }
-    }
+        // ...
+        project: true,
+        extraFileExtensions: ['.svelte'], // This is a required setting in `@typescript-eslint/parser` v4.24.0.
+      },
+    },
+  },
+  {
+    files: ['**/*.svelte', '*.svelte'],
+    languageOptions: {
+      parser: svelteParser,
+      // Parse the `<script>` in `.svelte` as TypeScript by adding the following configuration.
+      parserOptions: {
+        parser: ts.parser,
+      },
+    },
   },
   {
     rules: {
       // Allow explicit any, to avoid type gymnastics
-      "@typescript-eslint/no-explicit-any": "off",
-      "@typescript-eslint/no-unused-vars": ["error", {
-        argsIgnorePattern: "^_",
-        caughtErrors: "none",
-      }]
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-unused-vars': ['error', {
+        argsIgnorePattern: '^_',
+        caughtErrors: 'none',
+      }],
+      // Disallow floating promises to avoid random crashes
+      '@typescript-eslint/no-floating-promises': 'error',
+      // Single quotes where possible
+      quotes: ['error', 'single', { 'avoidEscape': true, 'allowTemplateLiterals': false }],
+      // Allow some `any` expressions since otherwise they seriously mess with tests, or enforce
+      // strictness in areas where it really doesn't matter (eg error handling)
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+      '@typescript-eslint/no-unsafe-argument': 'off',
+      // Also disable template expression checks, since they're also error handling stuff
+      // TODO: Enable them at some point when I get around to actually tidying things up
+      '@typescript-eslint/no-base-to-string': 'off',
+      '@typescript-eslint/restrict-template-expressions': 'off',
+      // FIXME: When I get around to hardening the request body validation, enable this rule again
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+      // Allow empty functions, as they are useful to silence promise errors
+      '@typescript-eslint/no-empty-function': 'off',
     },
   },
   {
     ignores: [
-      "**/.DS_Store",
-      "**/node_modules",
-      "build",
-      ".svelte-kit",
-      "package",
-      "**/.env",
-      "**/.env.*",
-      "!**/.env.example",
-      "**/pnpm-lock.yaml",
-      "**/package-lock.json",
-      "**/yarn.lock",
-      "**/svelte.config.js",
-      "**/vitest.config.ts",
-      "eslint.config.mjs",
+      '**/.DS_Store',
+      '**/node_modules',
+      'build',
+      '.svelte-kit',
+      'package',
+      '**/.env',
+      '**/.env.*',
+      '!**/.env.example',
+      '**/pnpm-lock.yaml',
+      '**/package-lock.json',
+      '**/yarn.lock',
+      '**/svelte.config.js',
+      '**/vitest.config.ts',
+      'eslint.config.mjs',
+      'vite.config.ts',
     ],
   },
 );