WIP: YASNCB (Yet Another Strict Null Checks Branch)

.vscode/settings.json

@@ -216,7 +216,7 @@
     "editor.defaultFormatter": "vscode.json-language-features"
   },
   "[jsonc]": {
-    "editor.defaultFormatter": "vscode.json-language-features"
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
   "peacock.color": "#e48141",
   "calva.replConnectSequences": [

src/config.ts

@@ -5,7 +5,7 @@ import { PrettyPrintingOptions } from './printer';
 import { parseEdn } from '../out/cljs-lib/cljs-lib';
 import * as state from './state';
 import _ = require('lodash');
-import { isDefined } from './utilities';
+import { isDefined } from './type-checks';
 
 const REPL_FILE_EXT = 'calva-repl';
 const KEYBINDINGS_ENABLED_CONFIG_KEY = 'calva.keybindingsEnabled';

src/connector.ts

@@ -25,6 +25,7 @@ import * as clojureDocs from './clojuredocs';
 import * as jszip from 'jszip';
 import { addEdnConfig } from './config';
 import { getJarContents } from './utilities';
+import { assertIsDefined, isNonEmptyString } from './type-checks';
 
 async function readJarContent(uri: string) {
   try {
@@ -39,6 +40,7 @@ async function readJarContent(uri: string) {
 }
 
 async function readRuntimeConfigs() {
+  assertIsDefined(nClient, 'Expected there to be an nREPL client!');
   const classpath = await nClient.session.classpath().catch((e) => {
     console.error('readRuntimeConfigs:', e);
   });
@@ -55,7 +57,7 @@ async function readRuntimeConfigs() {
 
     // maybe we don't need to keep uri -> edn association, but it would make showing errors easier later
     return files
-      .filter(([_, config]) => util.isNonEmptyString(config))
+      .filter(([_, config]) => isNonEmptyString(config))
       .map(([_, config]) => addEdnConfig(config));
   }
 }
@@ -112,12 +114,9 @@ async function connectToHost(hostname: string, port: number, connectSequence: Re
 
     if (connectSequence.afterCLJReplJackInCode) {
       outputWindow.append(`\n; Evaluating 'afterCLJReplJackInCode'`);
-      await evaluateInOutputWindow(
-        connectSequence.afterCLJReplJackInCode,
-        'clj',
-        outputWindow.getNs(),
-        {}
-      );
+      const ns = outputWindow.getNs();
+      assertIsDefined(ns, 'Expected outputWindow to have a namespace!');
+      await evaluateInOutputWindow(connectSequence.afterCLJReplJackInCode, 'clj', ns, {});
     }
 
     outputWindow.appendPrompt();
@@ -371,15 +370,23 @@ function createCLJSReplType(
         'cljsReplTypeHasBuilds',
         cljsType.buildsRequired
       );
-      let initCode = cljsType.connectCode,
-        build: string = null;
+      let initCode: typeof cljsType.connectCode | undefined = cljsType.connectCode,
+        build: string | null = null;
       if (menuSelections && menuSelections.cljsDefaultBuild && useDefaultBuild) {
         build = menuSelections.cljsDefaultBuild;
         useDefaultBuild = false;
       } else {
         if (typeof initCode === 'object' || initCode.includes('%BUILD%')) {
+          const buildsForSelection = startedBuilds
+            ? startedBuilds
+            : await figwheelOrShadowBuilds(cljsTypeName);
+          assertIsDefined(
+            buildsForSelection,
+            'Expected there to be figwheel or shadowcljs builds!'
+          );
+
           build = await util.quickPickSingle({
-            values: startedBuilds ? startedBuilds : await figwheelOrShadowBuilds(cljsTypeName),
+            values: buildsForSelection,
             placeHolder: 'Select which build to connect to',
             saveAs: `${state.getProjectRootUri().toString()}/${cljsTypeName.replace(
               ' ',
@@ -415,12 +422,10 @@ function createCLJSReplType(
       );
     },
     connected: (result, out, err) => {
-      if (cljsType.isConnectedRegExp) {
-        return (
-          [...out, result].find((x) => {
-            return x.search(cljsType.isConnectedRegExp) >= 0;
-          }) != undefined
-        );
+      const { isConnectedRegExp } = cljsType;
+
+      if (isConnectedRegExp) {
+        return [...out, result].find((x) => x.search(isConnectedRegExp) >= 0) !== undefined;
       } else {
         return true;
       }
@@ -431,12 +436,15 @@ function createCLJSReplType(
     replType.start = async (session, name, checkFn) => {
       let startCode = cljsType.startCode;
       if (!hasStarted) {
+        assertIsDefined(startCode, 'Expected startCode to be defined!');
         if (startCode.includes('%BUILDS')) {
           let builds: string[];
           if (menuSelections && menuSelections.cljsLaunchBuilds) {
             builds = menuSelections.cljsLaunchBuilds;
           } else {
             const allBuilds = await figwheelOrShadowBuilds(cljsTypeName);
+            assertIsDefined(allBuilds, 'Expected there to be figwheel or shadowcljs builds!');
+
             builds =
               allBuilds.length <= 1
                 ? allBuilds
@@ -494,11 +502,11 @@ function createCLJSReplType(
   }
 
   replType.started = (result, out, err) => {
-    if (cljsType.isReadyToStartRegExp && !hasStarted) {
+    const { isReadyToStartRegExp } = cljsType;
+
+    if (isReadyToStartRegExp && !hasStarted) {
       const started =
-        [...out, ...err].find((x) => {
-          return x.search(cljsType.isReadyToStartRegExp) >= 0;
-        }) != undefined;
+        [...out, ...err].find((x) => x.search(isReadyToStartRegExp) >= 0) !== undefined;
       if (started) {
         hasStarted = true;
       }
@@ -512,7 +520,7 @@ function createCLJSReplType(
   return replType;
 }
 
-async function makeCljsSessionClone(session, repl: ReplType, projectTypeName: string) {
+async function makeCljsSessionClone(session, repl: ReplType, projectTypeName: string | undefined) {
   outputWindow.append('; Creating cljs repl session...');
   let newCljsSession = await session.clone();
   newCljsSession.replType = 'cljs';
@@ -521,7 +529,8 @@ async function makeCljsSessionClone(session, repl: ReplType, projectTypeName: st
     outputWindow.append(
       ';   The Calva Connection Log might have more connection progress information.'
     );
-    if (repl.start != undefined) {
+    if (repl.start !== undefined) {
+      assertIsDefined(repl.started, "Expected repl to have a 'started' check function!");
       if (await repl.start(newCljsSession, repl.name, repl.started)) {
         state.analytics().logEvent('REPL', 'StartedCLJS', repl.name).send();
         outputWindow.append('; Cljs builds started');
@@ -534,6 +543,9 @@ async function makeCljsSessionClone(session, repl: ReplType, projectTypeName: st
         return [null, null];
       }
     }
+
+    assertIsDefined(repl.connect, 'Expected repl to have a connect function!');
+
     if (await repl.connect(newCljsSession, repl.name, repl.connected)) {
       state.analytics().logEvent('REPL', 'ConnectedCLJS', repl.name).send();
       setStateValue('cljs', (cljsSession = newCljsSession));
@@ -588,7 +600,7 @@ async function promptForNreplUrlAndConnect(port, connectSequence: ReplConnectSeq
   return true;
 }
 
-export let nClient: NReplClient;
+export let nClient: NReplClient | undefined;
 export let cljSession: NReplSession;
 export let cljsSession: NReplSession;
 
@@ -637,7 +649,7 @@ export async function connect(
   return true;
 }
 
-async function standaloneConnect(connectSequence: ReplConnectSequence) {
+async function standaloneConnect(connectSequence: ReplConnectSequence | undefined) {
   await outputWindow.initResultsDoc();
   await outputWindow.openResultsDoc();
 
@@ -701,20 +713,21 @@ export default {
         // the REPL client was connected.
         nClient.close();
       }
+
       liveShareSupport.didDisconnectRepl();
       nClient = undefined;
     }
 
     callback();
   },
   toggleCLJCSession: () => {
-    let newSession: NReplSession;
+    let newSession: NReplSession | undefined;
 
     if (getStateValue('connected')) {
-      if (replSession.getSession('cljc') == replSession.getSession('cljs')) {
-        newSession = replSession.getSession('clj');
-      } else if (replSession.getSession('cljc') == replSession.getSession('clj')) {
-        newSession = replSession.getSession('cljs');
+      if (replSession.tryToGetSession('cljc') == replSession.tryToGetSession('cljs')) {
+        newSession = replSession.tryToGetSession('clj');
+      } else if (replSession.tryToGetSession('cljc') == replSession.tryToGetSession('clj')) {
+        newSession = replSession.tryToGetSession('cljs');
       }
       setStateValue('cljc', newSession);
       if (outputWindow.isResultsDoc(util.getActiveTextEditor().document)) {
@@ -726,9 +739,11 @@ export default {
     }
   },
   switchCljsBuild: async () => {
-    const cljSession = replSession.getSession('clj');
-    const cljsTypeName: string = state.extensionContext.workspaceState.get('selectedCljsTypeName'),
-      cljTypeName: string = state.extensionContext.workspaceState.get('selectedCljTypeName');
+    const cljSession = replSession.tryToGetSession('clj');
+    const cljsTypeName: string | undefined =
+        state.extensionContext.workspaceState.get('selectedCljsTypeName'),
+      cljTypeName: string | undefined =
+        state.extensionContext.workspaceState.get('selectedCljTypeName');
     state.analytics().logEvent('REPL', 'switchCljsBuild', cljsTypeName).send();
 
     const [session, build] = await makeCljsSessionClone(

src/converters.ts

@@ -1,5 +1,6 @@
 import * as vscode from 'vscode';
 import * as calvaLib from '../out/cljs-lib/cljs-lib';
+import { getActiveTextEditor } from './utilities';
 
 type Js2CljsResult = {
   result: string;
@@ -23,7 +24,7 @@ type Js2CljsInvalidResult = {
 const isJs2CljsResult = (input: any): input is Js2CljsResult => input.result !== undefined;
 
 export async function js2cljs() {
-  const editor = vscode.window.activeTextEditor;
+  const editor = getActiveTextEditor();
   const selection = editor.selection;
   const doc = editor.document;
   const js = doc.getText(

src/cursor-doc/clojure-lexer.ts

@@ -43,7 +43,7 @@ export function validPair(open: string, close: string): boolean {
 }
 
 export interface Token extends LexerToken {
-  state: ScannerState;
+  state: ScannerState | null;
 }
 
 // whitespace, excluding newlines
@@ -174,7 +174,7 @@ export class Scanner {
     const tks: Token[] = [];
     this.state = state;
     let lex = (this.state.inString ? inString : toplevel).lex(line, this.maxLength);
-    let tk: LexerToken;
+    let tk: LexerToken | undefined;
     do {
       tk = lex.scan();
       if (tk) {

src/cursor-doc/indent.ts

@@ -18,7 +18,7 @@ const indentRules: IndentRules = {
  */
 export interface IndentInformation {
   /** The first token in the expression (after the open paren/bracket etc.), as a raw string */
-  first: string;
+  first: string | null;
 
   /** The indent immediately after the open paren/bracket etc */
   startIndent: number;
@@ -61,6 +61,17 @@ export function collectIndents(
   let lastIndent = 0;
   const indents: IndentInformation[] = [];
   const rules = config['cljfmt-options']['indents'];
+  const patterns = _.keys(rules);
+  const regexpPatterns = patterns.reduce((regexpMap, pattern) => {
+    const match = pattern.match(/^#"(.*)"$/);
+
+    if (match) {
+      regexpMap[pattern] = RegExp(match[1]);
+    }
+
+    return regexpMap;
+  }, {} as Record<string, RegExp>);
+
   do {
     if (!cursor.backwardSexp()) {
       // this needs some work..
@@ -91,7 +102,10 @@ export function collectIndents(
 
       const pattern =
         isList &&
-        _.find(_.keys(rules), (pattern) => pattern === token || testCljRe(pattern, token));
+        patterns.find(
+          (pattern) =>
+            pattern === token || (regexpPatterns[pattern] && regexpPatterns[pattern].test(token))
+        );
       const indentRule = pattern ? rules[pattern] : [];
       indents.unshift({
         first: token,
@@ -138,11 +152,6 @@ export function collectIndents(
   return indents;
 }
 
-const testCljRe = (re, str) => {
-  const matches = re.match(/^#"(.*)"$/);
-  return matches && RegExp(matches[1]).test(str);
-};
-
 /** Returns the expected newline indent for the given position, in characters. */
 export function getIndent(document: EditableModel, offset: number, config?: any): number {
   if (!config) {

src/cursor-doc/lexer.ts

@@ -3,6 +3,8 @@
  * @module lexer
  */
 
+import { assertIsDefined } from '../type-checks';
+
 /**
  * The base Token class. Contains the token type,
  * the raw string of the token, and the offset into the input line.
@@ -36,8 +38,8 @@ export class Lexer {
   constructor(public source: string, public rules: Rule[], private maxLength) {}
 
   /** Returns the next token in this lexer, or null if at the end. If the match fails, throws an Error. */
-  scan(): Token {
-    let token = null,
+  scan(): Token | undefined {
+    let token: Token | undefined,
       length = 0;
     if (this.position < this.source.length) {
       if (this.source !== undefined && this.source.length < this.maxLength) {
@@ -47,6 +49,7 @@ export class Lexer {
           const x = rule.r.exec(this.source);
           if (x && x[0].length > length && this.position + x[0].length == rule.r.lastIndex) {
             token = rule.fn(this, x);
+            assertIsDefined(token, 'Expected token!');
             token.offset = this.position;
             token.raw = x[0];
             length = x[0].length;
@@ -62,9 +65,9 @@ export class Lexer {
       }
     }
     this.position += length;
-    if (token == null) {
+    if (token === undefined) {
       if (this.position == this.source.length) {
-        return null;
+        return undefined;
       }
       throw new Error(
         'Unexpected character at ' + this.position + ': ' + JSON.stringify(this.source)

src/cursor-doc/model.ts

@@ -155,12 +155,12 @@ export class LineInputModel implements EditableModel {
           }
           return x;
         })
-        .filter((x) => x !== null)
+        .filter((x) => x !== null) as number[]
     );
 
     this.insertedLines = new Set(
       Array.from(this.insertedLines)
-        .map((x): [number, number] => {
+        .map((x) => {
           const [a, b] = x;
           if (a > start && a < start + deleted) {
             return null;
@@ -170,12 +170,12 @@ export class LineInputModel implements EditableModel {
           }
           return [a, b];
         })
-        .filter((x) => x !== null)
+        .filter((x) => x !== null) as [number, number][]
     );
 
     this.deletedLines = new Set(
       Array.from(this.deletedLines)
-        .map((x): [number, number] => {
+        .map((x) => {
           const [a, b] = x;
           if (a > start && a < start + deleted) {
             return null;
@@ -185,7 +185,7 @@ export class LineInputModel implements EditableModel {
           }
           return [a, b];
         })
-        .filter((x) => x !== null)
+        .filter((x) => x !== null) as [number, number][]
     );
   }
 
@@ -224,7 +224,7 @@ export class LineInputModel implements EditableModel {
     const seen = new Set<number>();
     this.dirtyLines.sort();
     while (this.dirtyLines.length) {
-      let nextIdx = this.dirtyLines.shift();
+      let nextIdx = this.dirtyLines.shift() as number;
       if (seen.has(nextIdx)) {
         continue;
       } // already processed.