Continue to fix linting and documentation issues

Author: leeyi45

eslint.config.js

@@ -121,10 +121,12 @@ export default tseslint.config(
   {
     extends: [js.configs.recommended],
     name: 'Global JS/TS Stylistic Rules',
+    plugins: {
+      jsdoc: jsdocPlugin,
+    },
     files: [
-      '**/*.*js',
-      '**/*.ts',
-      '**/*.tsx',
+      '**/*.{js,cjs,mjs}',
+      '**/*.{ts,cts,tsx}',
     ],
     languageOptions: {
       globals: {
@@ -133,7 +135,13 @@ export default tseslint.config(
       }
     },
     rules: {
+      'jsdoc/check-alignment': 'warn',
+      'jsdoc/no-blank-blocks': 'warn',
+      'jsdoc/no-multi-asterisks': ['warn', { allowWhitespace: true }],
+      'jsdoc/require-asterisk-prefix': 'warn',
+
       'object-shorthand': ['warn', 'properties'],
+
       '@stylistic/arrow-spacing': 'warn',
       '@stylistic/block-spacing': 'warn',
       '@stylistic/brace-style': ['warn', '1tbs', { allowSingleLine: true }],
@@ -212,18 +220,22 @@ export default tseslint.config(
   {
     name: 'Global JS/TS Functional Rules',
     files: [
-      '**/*.*js',
-      '**/*.ts',
-      '**/*.cts',
-      '**/*.tsx',
+      '**/*.{js,cjs,mjs}',
+      '**/*.{ts,cts,tsx}',
     ],
+    // Markdown virtual files are ignored because these 'functional' rules
+    // aren't required for them
     ignores: ['**/*.md/**/*.{js,ts,tsx}'],
     plugins: {
       import: importPlugin,
-      jsdoc: jsdocPlugin,
       '@sourceacademy': saLintPlugin
     },
     rules: {
+      'jsdoc/check-param-names': ['error', {
+        checkDestructured: false,
+        disableMissingParamChecks: true
+      }],
+
       'import/first': 'warn',
       'import/newline-after-import': 'warn',
       // This rule is very time intensive.
@@ -245,13 +257,6 @@ export default tseslint.config(
         }
       ],
 
-      'jsdoc/check-alignment': 'warn',
-      'jsdoc/check-param-names': ['error', {
-        checkDestructured: false,
-        disableMissingParamChecks: true
-      }],
-      'jsdoc/require-asterisk-prefix': 'warn',
-
       'no-empty': ['error', { allowEmptyCatch: true }],
       'no-restricted-imports': [
         'error',
@@ -305,6 +310,7 @@ export default tseslint.config(
       // This rule doesn't seem to fail locally but fails on the CI
       // '@typescript-eslint/no-unnecessary-type-assertion': 'error',
       '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }], // Was 'error'
+      '@typescript-eslint/only-throw-error': 'error'
     }
   },
   // #endregion typescript
@@ -451,12 +457,12 @@ export default tseslint.config(
       'vitest/expect-expect': ['error', {
         assertFunctionNames: ['expect*'],
       }],
-      'vitest/no-alias-methods': 'off',
-      'vitest/no-conditional-expect': 'off',
+      'vitest/no-alias-methods': 'off', // was 'error'
+      'vitest/no-conditional-expect': 'off', // was 'error'
       'vitest/no-focused-tests': ['warn', { fixable: false }],
       'vitest/prefer-describe-function-title': 'warn',
-      'vitest/require-top-level-describe': 'off',
-      'vitest/valid-describe-callback': 'off',
+      'vitest/require-top-level-describe': 'off', // was 'error'
+      'vitest/valid-describe-callback': 'off', // was 'error'
       'vitest/valid-expect-in-promise': 'error',
       'vitest/valid-title': ['error', { ignoreTypeOfDescribeName: true }],
 

lib/modules-lib/src/specialErrors.ts

@@ -3,6 +3,7 @@
  * When called, the frontend will notify that the program has ended successfully
  * and display a message that the program is stopped by a module.
  */
-export function interrupt() {
+export function interrupt(): never {
+  // eslint-disable-next-line @typescript-eslint/only-throw-error
   throw 'source_academy_interrupt';
 }

lib/vitest-reporter/build/test-reporter.js

@@ -184,4 +184,4 @@ module.exports = class GithubActionsCoverageReporter extends report.ReportBase {
     this.cw.write('</tbody></table>');
     this.cw.close();
   }
-}
+};

lib/vitest-reporter/src/coverage-reporter.cts

@@ -17,7 +17,7 @@ export function throwIfNotRune(name: string, rune: unknown): asserts rune is Run
 
 /**
  * primitive Rune in the rune of a full square
- * */
+ */
 export function getSquare() {
   const vertexList: number[] = [];
   const colorList: number[] = [];
@@ -46,7 +46,7 @@ export function getBlank() {
  * smallsquare inside a large square,
  * each diagonally split into a
  * black and white half
- * */
+ */
 export function getRcross() {
   const vertexList: number[] = [];
   const colorList: number[] = [];
@@ -82,7 +82,7 @@ export function getRcross() {
 
 /**
  * primitive Rune in the rune of a sail
- * */
+ */
 export function getSail() {
   const vertexList: number[] = [];
   const colorList: number[] = [];
@@ -101,7 +101,7 @@ export function getSail() {
 
 /**
  * primitive Rune in the rune of a triangle
- * */
+ */
 export function getTriangle() {
   const vertexList: number[] = [];
   const colorList: number[] = [];
@@ -121,7 +121,7 @@ export function getTriangle() {
 /**
  * primitive Rune with black triangle,
  * filling upper right corner
- * */
+ */
 export function getCorner() {
   const vertexList: number[] = [];
   const colorList: number[] = [];
@@ -141,7 +141,7 @@ export function getCorner() {
  * primitive Rune in the rune of two overlapping
  * triangles, residing in the upper half
  * of
- * */
+ */
 export function getNova() {
   const vertexList: number[] = [];
   const colorList: number[] = [];
@@ -163,7 +163,7 @@ export function getNova() {
 
 /**
  * primitive Rune in the rune of a circle
- * */
+ */
 export function getCircle() {
   const vertexList: number[] = [];
   const colorList: number[] = [];
@@ -185,7 +185,7 @@ export function getCircle() {
 
 /**
  * primitive Rune in the rune of a heart
- * */
+ */
 export function getHeart() {
   const vertexList: number[] = [];
   const colorList: number[] = [];
@@ -246,7 +246,7 @@ export function getHeart() {
 
 /**
  * primitive Rune in the rune of a pentagram
- * */
+ */
 export function getPentagram() {
   const vertexList: number[] = [];
   const colorList: number[] = [];
@@ -281,7 +281,7 @@ export function getPentagram() {
 /**
  * primitive Rune in the rune of a ribbon
  * winding outwards in an anticlockwise spiral
- * */
+ */
 export function getRibbon() {
   const vertexList: number[] = [];
   const colorList: number[] = [];

src/bundles/rune/src/runes_ops.ts

@@ -15,7 +15,7 @@ export function throwIfNotRune(name: string, ...runes: any) {
 
 /**
  * primitive Rune in the rune of a full square
- * */
+ */
 export const getSquare: () => string = () => 'square';
 
 export const getBlank: () => string = () => 'blank';