Clean: use constants where possible.

Author: bjones1

client/src/CodeChatEditor.mts

@@ -66,10 +66,10 @@ import "graphviz-webcomponent";
 import { tinymce, init, Editor } from "./tinymce-config.mjs";
 import {
     CodeChatForWeb,
-    CodeMirrorDocBlockTuple,
     CodeMirrorDiffable,
     UpdateMessageContents,
     CodeMirror,
+    autosave_timeout_ms,
 } from "./shared_types.mjs";
 import { show_toast } from "./show_toast.mjs";
 
@@ -400,7 +400,7 @@ export const startAutosaveTimer = () => {
     autosaveTimeoutId = window.setTimeout(() => {
         console_log("CodeChat Editor Client: autosaving.");
         on_save();
-    }, 1000);
+    }, autosave_timeout_ms);
 };
 
 const clearAutosaveTimer = () => {

client/src/shared_types.mts

@@ -16,6 +16,8 @@
 //
 // `shared_types.mts` -- Shared type definitions
 // =============================================
+// The time, in ms, to wait between the last user edit and sending updated data to the Server.
+export const autosave_timeout_ms = 300;
 //
 // ### Message types
 //

extensions/VSCode/src/extension.ts

@@ -40,6 +40,7 @@ import { CodeChatEditorServer, initServer } from "./index";
 
 // ### Local packages
 import {
+    autosave_timeout_ms,
     EditorMessage,
     MessageResult,
     UpdateMessageContents,
@@ -600,7 +601,7 @@ const send_update = (this_is_dirty: boolean) => {
         if (idle_timer !== undefined) {
             clearTimeout(idle_timer);
         }
-        // ... schedule a render after 300 ms.
+        // ... schedule a render after an autosave timeout.
         idle_timer = setTimeout(async () => {
             if (can_render()) {
                 const ate = vscode.window.activeTextEditor!;
@@ -648,7 +649,7 @@ const send_update = (this_is_dirty: boolean) => {
                     scroll_position,
                 );
             }
-        }, 300);
+        }, autosave_timeout_ms);
     }
 };
 

server/src/ide/vscode.rs

@@ -183,7 +183,7 @@ pub fn vscode_ide_core(
                         // Make sure it's the `Result` message with no errors.
                         let res =
                             // First, make sure the ID matches.
-                            if message.id != 0.0 {
+                            if message.id != RESERVED_MESSAGE_ID {
                                 Err(format!("Unexpected message ID {}.", message.id))
                             } else {
                                 match message.message {

server/src/lexer/supported_languages.rs

@@ -56,6 +56,8 @@ use super::{
     StringDelimiterSpec, pest_parser,
 };
 
+pub const MARKDOWN_MODE: &str = "markdown";
+
 // Helper functions
 // -----------------------------------------------------------------------------
 //
@@ -543,7 +545,7 @@ pub fn get_language_lexer_vec() -> Vec<LanguageLexer> {
         ),
         // ### Markdown
         make_language_lexer(
-            "markdown",
+            MARKDOWN_MODE,
             &["md"],
             &[],
             &[],

server/src/processing.rs

@@ -59,7 +59,10 @@ use serde::{Deserialize, Serialize};
 use ts_rs::TS;
 
 // ### Local
-use crate::lexer::{CodeDocBlock, DocBlock, LEXERS, LanguageLexerCompiled, source_lexer};
+use crate::lexer::{
+    CodeDocBlock, DocBlock, LEXERS, LanguageLexerCompiled, source_lexer,
+    supported_languages::MARKDOWN_MODE,
+};
 
 // Data structures
 // -----------------------------------------------------------------------------
@@ -426,7 +429,7 @@ pub fn codechat_for_web_to_source(
     };
 
     // If this is a Markdown-only document, handle this special case.
-    if *lexer.language_lexer.lexer_name == "markdown" {
+    if *lexer.language_lexer.lexer_name == MARKDOWN_MODE {
         // There should be no doc blocks.
         if !code_mirror.doc_blocks.is_empty() {
             return Err(CodechatForWebToSourceError::DocBlocksNotAllowed);
@@ -802,7 +805,7 @@ pub fn source_to_codechat_for_web(
             mode: lexer.language_lexer.lexer_name.to_string(),
         },
         version,
-        source: if lexer.language_lexer.lexer_name.as_str() == "markdown" {
+        source: if lexer.language_lexer.lexer_name.as_str() == MARKDOWN_MODE {
             // Document-only files are easy: just encode the contents.
             let html = markdown_to_html(file_contents);
             // TODO: process the HTML.

server/src/processing/tests.rs

@@ -34,7 +34,10 @@ use super::{
 };
 use crate::{
     cast,
-    lexer::{CodeDocBlock, DocBlock, compile_lexers, supported_languages::get_language_lexer_vec},
+    lexer::{
+        CodeDocBlock, DocBlock, compile_lexers,
+        supported_languages::{MARKDOWN_MODE, get_language_lexer_vec},
+    },
     prep_test_dir,
     processing::{
         CodeDocBlockVecToSourceError, CodeMirrorDiffable, CodeMirrorDocBlockDelete,
@@ -510,7 +513,7 @@ fn test_source_to_codechat_for_web_1() {
     assert_eq!(
         source_to_codechat_for_web("", &"md".to_string(), 0.0, false, false),
         Ok(TranslationResults::CodeChat(build_codechat_for_web(
-            "markdown",
+            MARKDOWN_MODE,
             "",
             vec![]
         )))
@@ -526,7 +529,7 @@ fn test_source_to_codechat_for_web_1() {
             false,
         ),
         Ok(TranslationResults::CodeChat(build_codechat_for_web(
-            "markdown",
+            MARKDOWN_MODE,
             &format!("<p>{lexer_spec}markdown</p>\n"),
             vec![]
         )))

server/tests/overall_core/mod.rs

@@ -678,7 +678,7 @@ async fn test_server_core(
                 file_path: md_path_str.clone(),
                 contents: Some(CodeChatForWeb {
                     metadata: SourceFileMetadata {
-                        mode: "markdown".to_string()
+                        mode: MARKDOWN_MODE.to_string()
                     },
                     source: CodeMirrorDiffable::Diff(CodeMirrorDiff {
                         doc: vec![StringDiff {