Restrict maximum number of lines per function (martijnversluis#1645)

Author: martijnversluis

eslint.config.mjs

@@ -46,6 +46,7 @@ export default tseslint.config(
       'max-depth': ['error', 2],
       'max-len': ['error', { code: 120, ignoreUrls: true }],
       'max-lines': ['error', 700],
+      'max-lines-per-function': ['error', { max: 25, skipBlankLines: true, skipComments: true }],
       'max-statements': ['error', 10],
       'no-underscore-dangle': 'off',
       'no-unused-vars': 'off',
@@ -71,12 +72,14 @@ export default tseslint.config(
     files: ['src/formatter/templates/*.ts'],
     rules: {
       'indent': 'off',
+      'max-lines-per-function': 'off',
       'template-curly-spacing': ['error', 'always'],
     },
   },
   {
     files: ['script/**/*.ts'],
     rules: {
+      'max-lines-per-function': 'off',
       'no-console': 'off',
     },
   },
@@ -89,19 +92,22 @@ export default tseslint.config(
       'jest/no-standalone-expect': 'off',
       'jest/prefer-expect-assertions': 'off',
       'max-lines': 'off',
+      'max-lines-per-function': 'off',
       'max-statements': 'off',
     },
   },
   {
     files: ['test/fixtures/**/*.ts'],
     rules: {
       'max-lines': 'off',
+      'max-lines-per-function': 'off',
     },
   },
   {
     files: ['test/matchers.ts', 'test/utilities.ts', 'unibuild.ts'],
     rules: {
       'jest/no-export': 'off',
+      'max-lines-per-function': 'off',
       'max-statements': 'off',
     },
   },

src/chord.ts

@@ -17,6 +17,17 @@ interface ChordProperties {
   bass?: Key | null;
 }
 
+export interface ChordConstructorOptions {
+  base?: string | number | null;
+  modifier?: Modifier | null;
+  suffix?: string | null;
+  bassBase?: string | number | null;
+  bassModifier?: Modifier | null;
+  root?: Key | null;
+  bass?: Key | null;
+  chordType?: ChordType | null;
+}
+
 /**
  * Represents a Chord, consisting of a root, suffix (quality) and bass
  */
@@ -351,16 +362,7 @@ class Chord implements ChordProperties {
       root = null,
       bass = null,
       chordType = null,
-    }: {
-      base?: string | number | null,
-      modifier?: Modifier | null,
-      suffix?: string | null,
-      bassBase?: string | number | null,
-      bassModifier?: Modifier | null,
-      root?: Key | null,
-      bass?: Key | null,
-      chordType?: ChordType | null,
-    },
+    }: ChordConstructorOptions,
   ) {
     this.suffix = suffix || null;
     this.root = Chord.determineRoot({

src/chord_sheet/song.ts

@@ -211,11 +211,7 @@ class Song extends MetadataAccessors {
     return song.mapItems((item) => {
       if (item instanceof Tag && item.name === KEY) {
         transposedKey = Key.wrapOrFail(item.value).transpose(delta);
-
-        if (modifier) {
-          transposedKey = transposedKey.useModifier(modifier);
-        }
-
+        if (modifier) transposedKey = transposedKey.useModifier(modifier);
         return item.set({ value: transposedKey.toString() });
       }
 

src/formatter/chord_renderer.ts

@@ -4,6 +4,30 @@ import { NullableChordStyle } from '../constants';
 import { transposeDistance } from '../helpers';
 import { callChain } from '../utilities';
 
+interface ConstructorOptions {
+  capo: number;
+  contextKey: Key | null;
+  decapo: boolean;
+  normalizeChords: boolean;
+  renderKey: Key | null;
+  songKey: Key | null;
+  style: NullableChordStyle;
+  transposeKey: string | null;
+  useUnicodeModifier: boolean;
+}
+
+const defaultConstructorOptions = {
+  capo: 0,
+  contextKey: null,
+  decapo: false,
+  normalizeChords: true,
+  renderKey: null,
+  songKey: null,
+  style: null,
+  transposeKey: null,
+  useUnicodeModifier: false,
+};
+
 class ChordRenderer {
   capo: number;
 
@@ -21,47 +45,17 @@ class ChordRenderer {
 
   useUnicodeModifier: boolean;
 
-  constructor(
-    {
-      capo,
-      contextKey,
-      decapo,
-      normalizeChords,
-      renderKey,
-      songKey,
-      style,
-      transposeKey,
-      useUnicodeModifier,
-    }: {
-      capo: number,
-      contextKey: Key | null,
-      decapo: boolean,
-      normalizeChords: boolean,
-      renderKey: Key | null,
-      songKey: Key | null,
-      style: NullableChordStyle,
-      transposeKey: string | null,
-      useUnicodeModifier: boolean,
-    } = {
-      capo: 0,
-      contextKey: null,
-      decapo: false,
-      normalizeChords: true,
-      renderKey: null,
-      songKey: null,
-      style: null,
-      transposeKey: null,
-      useUnicodeModifier: false,
-    },
-  ) {
-    this.capo = decapo ? capo : 0;
-    this.contextKey = contextKey;
-    this.normalizeChords = normalizeChords;
-    this.renderKey = renderKey;
-    this.songKey = songKey;
-    this.style = style;
-    this.transposeKey = transposeKey;
-    this.useUnicodeModifier = useUnicodeModifier;
+  constructor(options: Partial<ConstructorOptions> = {}) {
+    const config: ConstructorOptions = { ...defaultConstructorOptions, ...options };
+
+    this.capo = config.decapo ? config.capo : 0;
+    this.contextKey = config.contextKey;
+    this.normalizeChords = config.normalizeChords;
+    this.renderKey = config.renderKey;
+    this.songKey = config.songKey;
+    this.style = config.style;
+    this.transposeKey = config.transposeKey;
+    this.useUnicodeModifier = config.useUnicodeModifier;
   }
 
   render(chordString: string): string {

src/formatter/html_table_formatter.ts

@@ -1,6 +1,7 @@
 import HtmlFormatter, { Template, CSS, HtmlTemplateCssClasses } from './html_formatter';
 import template from './templates/html_table_formatter';
 
+/* eslint-disable-next-line max-lines-per-function */
 function defaultCss(cssClasses: HtmlTemplateCssClasses): CSS {
   const {
     annotation,

src/key.ts

@@ -42,6 +42,17 @@ const NO_FLAT_NUMBERS = [1, 4];
 const NO_SHARP_GRADES = [5, 0];
 const NO_SHARP_NUMBERS = [3, 7];
 
+interface ConstructorOptions {
+  grade?: number | null;
+  number?: number | null;
+  minor: boolean;
+  type: ChordType;
+  modifier: Modifier | null;
+  referenceKeyGrade?: number | null;
+  originalKeyString?: string | null;
+  preferredModifier: Modifier | null;
+}
+
 /**
  * Represents a key, such as Eb (symbol), #3 (numeric) or VII (numeral).
  *
@@ -105,6 +116,7 @@ class Key implements KeyProperties {
     });
   }
 
+  /* eslint-disable-next-line max-lines-per-function */
   static resolve(
     {
       key,
@@ -256,16 +268,7 @@ class Key implements KeyProperties {
       referenceKeyGrade = null,
       originalKeyString = null,
       preferredModifier = null,
-    }: {
-      grade?: number | null,
-      number?: number | null,
-      minor: boolean,
-      type: ChordType,
-      modifier: Modifier | null,
-      referenceKeyGrade?: number | null,
-      originalKeyString?: string | null,
-      preferredModifier: Modifier | null,
-    },
+    }: ConstructorOptions,
   ) {
     this.grade = grade;
     this.number = number;

src/utilities.ts

@@ -152,33 +152,27 @@ function determineKey({
   return new GradeSet(grades).determineGrade(modifier, preferredModifier, grade);
 }
 
-export function gradeToKey({
-  type,
-  modifier,
-  preferredModifier,
-  grade,
-  minor,
-}: {
+export function gradeToKey(options: {
   type: ChordType,
   modifier: ModifierMaybe | null,
   preferredModifier: Modifier | null,
   grade: number,
   minor: boolean,
 }): string {
+  const {
+    type,
+    modifier,
+    preferredModifier,
+    grade,
+    minor,
+  } = options;
+
   let key = determineKey({
     type, modifier, preferredModifier, grade, minor,
   });
 
   if (!key) {
-    throw new Error(
-      `Could not resolve
-      type=${type}
-      modifier=${modifier}
-      grade=${grade}
-      preferredModifier=${preferredModifier}
-      minor=${minor}
-to a key`,
-    );
+    throw new Error(`Could not resolve ${options} to a key`);
   }
 
   if (minor && type === NUMERAL) {