Enable typescript-eslint stylistic

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
     continue-on-error: true
     strategy:
       matrix:
-        node-version: [ 16.x, 18.x, 20.x, 22.x ]
+        node-version: [ 18.x, 20.x, 22.x ]
     name: Ubuntu NodeJS ${{ matrix.node-version }} sample
     steps:
       - uses: actions/checkout@v4

eslint.config.mjs

@@ -6,8 +6,12 @@ import tseslint from 'typescript-eslint';
 export default tseslint.config(
   eslint.configs.recommended,
   ...tseslint.configs.recommended,
+  ...tseslint.configs.stylistic,
   {
     rules: {
+      'quotes': ['error', 'single'],
+
+      '@typescript-eslint/no-empty-function': 'off',
       '@typescript-eslint/no-explicit-any': 'off',
       '@typescript-eslint/no-unused-vars': [
         'error',
@@ -22,6 +26,7 @@ export default tseslint.config(
   {
     ignores: [
       'lib/**/*',
+      'src/normalize_mappings/suffix-normalize-mapping.ts',
       'src/parser/*/peg_parser.ts',
     ]
   }

src/chord_sheet/song.ts

@@ -52,13 +52,9 @@ const END_TAG_TO_SECTION_TYPE = {
   [END_OF_VERSE]: VERSE,
 };
 
-interface MapItemsCallback {
-  (_item: Item): Item | null;
-}
+type MapItemsCallback = (_item: Item) => Item | null;
 
-interface MapLinesCallback {
-  (_line: Line): Line | null;
-}
+type MapLinesCallback = (_line: Line) => Line | null;
 
 /**
  * Represents a song in a chord sheet. Currently a chord sheet can only have one song.
@@ -139,7 +135,7 @@ class Song extends MetadataAccessors {
     return this._bodyParagraphs;
   }
 
-  selectRenderableItems(items: Array<Line | Paragraph>): Array<Line | Paragraph> {
+  selectRenderableItems(items: (Line | Paragraph)[]): (Line | Paragraph)[] {
     const copy = [...items];
 
     while (copy.length && !copy[0].hasRenderableItems()) {

src/chord_sheet_serializer.ts

@@ -222,7 +222,7 @@ class ChordSheetSerializer {
     });
   }
 
-  parseExpression(expression: Array<SerializedLiteral | SerializedTernary>): Array<AstType | null> {
+  parseExpression(expression: (SerializedLiteral | SerializedTernary)[]): (AstType | null)[] {
     return (expression || [])
       .map((part) => this.parseAstComponent(part))
       .filter((part) => part !== null);

src/formatter/html_formatter.ts

@@ -4,12 +4,12 @@ import Song from '../chord_sheet/song';
 import { scopeCss } from '../utilities';
 import Paragraph from '../chord_sheet/paragraph';
 
-export type HtmlTemplateArgs = {
+export interface HtmlTemplateArgs {
   configuration: Configuration;
   song: Song;
   renderBlankLines?: boolean;
   bodyParagraphs: Paragraph[],
-};
+}
 
 export type Template = (_args: HtmlTemplateArgs) => string;
 export type CSS = Record<string, Record<string, string>>;

src/formatter/templates/html_div_formatter.ts

@@ -1,4 +1,4 @@
-import { HtmlTemplateArgs } from "../html_formatter";
+import { HtmlTemplateArgs } from '../html_formatter';
 import { renderChord } from '../../helpers';
 
 import {
@@ -15,7 +15,7 @@ import {
   stripHTML,
   when,
 } from '../../template_helpers';
-import {isPresent} from "../../utilities";
+import {isPresent} from '../../utilities';
 
 export default (
   {

src/key.ts

@@ -657,7 +657,7 @@ class Key implements KeyProperties {
     return this.clone();
   }
 
-  private set(attributes: KeyProperties, overwrite: boolean = true): Key {
+  private set(attributes: KeyProperties, overwrite = true): Key {
     return new Key({
       ...(overwrite ? {} : attributes),
       grade: this.grade,

src/parser/chord_pro/helpers.ts

@@ -74,9 +74,9 @@ export function applySoftLineBreaks(lyrics: string): SerializedChordLyricsPair[]
 export function breakChordLyricsPairOnSoftLineBreak(
   chords: string,
   lyrics: string,
-): Array<SerializedChordLyricsPair | SerializedSoftLineBreak> {
+): (SerializedChordLyricsPair | SerializedSoftLineBreak)[] {
   const pairs =
-    applySoftLineBreaks(lyrics || '') as Array<SerializedChordLyricsPair | SerializedSoftLineBreak>;
+    applySoftLineBreaks(lyrics || '') as (SerializedChordLyricsPair | SerializedSoftLineBreak)[];
   const [_first, ...rest] = pairs;
   let first = pairs[0];
   let addedLeadingChord: SerializedChordLyricsPair | null = null;

src/parser/chord_sheet_parser.ts

@@ -42,7 +42,7 @@ class ChordSheetParser {
    */
   constructor(
     { preserveWhitespace = true }: { preserveWhitespace?: boolean } = {},
-    showDeprecationWarning: boolean = true,
+    showDeprecationWarning = true,
   ) {
     if (showDeprecationWarning) {
       deprecate(

src/parser/chords_over_words/helpers.ts

@@ -15,24 +15,24 @@ type NewLine = CarriageReturn | LineFeed | CarriageReturnLineFeed;
 type Lyrics = string;
 type Chord = { column: number, value: string } & SerializedChord;
 
-type RhythmSymbol = {
+interface RhythmSymbol {
   type: 'symbol',
   value: '/' | '|' | '-' | 'x',
   column: number,
-};
+}
 
 type DirectionLine = SerializedLine;
 type InlineMetadata = SerializedLine;
 
-type ChordsLine = {
+interface ChordsLine {
   type: 'chordsLine',
-  items: Array<Chord | RhythmSymbol>
-};
+  items: (Chord | RhythmSymbol)[]
+}
 
-type LyricsLine = {
+interface LyricsLine {
   type: 'lyricsLine',
   content: Lyrics,
-};
+}
 
 type ChordSheetLine = DirectionLine | InlineMetadata | ChordsLine | LyricsLine;
 
@@ -46,7 +46,7 @@ function combineChordSheetLines(
   return [...emptyLines, ...lines, trailingLine].filter(x => x !== null);
 }
 
-function applySoftLineBreaks(line: string): Array<SerializedSoftLineBreak | SerializedChordLyricsPair | null> {
+function applySoftLineBreaks(line: string): (SerializedSoftLineBreak | SerializedChordLyricsPair | null)[] {
   return line
     .split(/\\\s+/)
     .flatMap((lyric, index) => ([
@@ -67,7 +67,7 @@ function chordProperties(chord: Chord): ChordProperties {
 function constructChordLyricsPairs(
   chords: Chord[],
   lyrics: string,
-): Array<SerializedChordLyricsPair | SerializedSoftLineBreak> {
+): (SerializedChordLyricsPair | SerializedSoftLineBreak)[] {
   return chords.map((chord, i) => {
     const nextChord = chords[i + 1];
     const start = chord.column - 1;

src/serialized_types.ts

@@ -1,67 +1,67 @@
 import { ChordType, Modifier } from './constants';
 
-export type SerializedTraceInfo = {
+export interface SerializedTraceInfo {
   location?: {
     offset: number | null,
     line: number | null,
     column: number | null,
   },
-};
+}
 
-export type SerializedChord = {
+export interface SerializedChord {
   type: 'chord',
   base: string,
   modifier: Modifier | null,
   suffix: string | null,
   bassBase: string | null,
   bassModifier: Modifier | null,
   chordType: ChordType,
-};
+}
 
-export type SerializedChordLyricsPair = {
+export interface SerializedChordLyricsPair {
   type: 'chordLyricsPair',
   chord?: SerializedChord | null,
   chords: string,
   lyrics: string | null,
   annotation?: string | null,
-};
+}
 
 export type SerializedTag = SerializedTraceInfo & {
   type: 'tag',
   name: string,
   value: string,
 };
 
-export type SerializedComment = {
+export interface SerializedComment {
   type: 'comment',
   comment: string,
-};
+}
 
 export type ContentType = 'tab' | 'abc' | 'ly' | 'grid';
 
-export type SerializedSection = {
+export interface SerializedSection {
   type: 'section',
   sectionType: ContentType,
   content: string[],
   startTag: SerializedTag,
   endTag: SerializedTag,
-};
+}
 
 export type SerializedLiteral = string;
 
 export interface SerializedTernary extends SerializedTraceInfo {
   type: 'ternary',
   variable: string | null,
   valueTest: string | null,
-  trueExpression: Array<SerializedLiteral | SerializedTernary>,
-  falseExpression: Array<SerializedLiteral | SerializedTernary>,
+  trueExpression: (SerializedLiteral | SerializedTernary)[],
+  falseExpression: (SerializedLiteral | SerializedTernary)[],
 }
 
-export type SerializedComposite = Array<SerializedLiteral | SerializedTernary>;
+export type SerializedComposite = (SerializedLiteral | SerializedTernary)[];
 
-export type SerializedSoftLineBreak = {
+export interface SerializedSoftLineBreak {
   type: 'softLineBreak',
-};
+}
 
 export type SerializedItem =
   SerializedChordLyricsPair |
@@ -71,15 +71,15 @@ export type SerializedItem =
   SerializedTag |
   SerializedTernary;
 
-export type SerializedLine = {
+export interface SerializedLine {
   type: 'line',
   items: SerializedItem[],
-};
+}
 
-export type SerializedSong = {
+export interface SerializedSong {
   type: 'chordSheet',
   lines: SerializedLine[],
-};
+}
 
 export type SerializedComponent =
   SerializedLine |

src/template_helpers.ts

@@ -14,9 +14,7 @@ import When from './template_helpers/when';
 import { Literal } from './index';
 import WhenCallback from './template_helpers/when_callback';
 
-interface EachCallback {
-  (_item: any): string;
-}
+type EachCallback = (_item: any) => string;
 
 export { hasChordContents, isEvaluatable } from './utilities';
 export { renderChord } from './helpers';

src/template_helpers/when.ts

@@ -2,7 +2,7 @@ import WhenClause from './when_clause';
 import WhenCallback from './when_callback';
 
 class When {
-  condition: boolean = false;
+  condition = false;
 
   clauses: WhenClause[] = [];
 

src/template_helpers/when_callback.ts

@@ -1,5 +1,3 @@
-interface WhenCallback {
-  (): string;
-}
+type WhenCallback = () => string;
 
 export default WhenCallback;

test/parser/chord_pro/helpers.test.ts

@@ -34,7 +34,7 @@ describe('breakChordLyricsPairOnSoftLineBreak', () => {
   it('supports breaking a pair\'s lyrics on a soft line break', () => {
     const chords = 'D/A';
     const lyrics = 'I am \xA0a barber';
-    const items: Array<SerializedChordLyricsPair | SerializedSoftLineBreak> =
+    const items: (SerializedChordLyricsPair | SerializedSoftLineBreak)[] =
       breakChordLyricsPairOnSoftLineBreak(chords, lyrics);
 
     expect(items[0]).toEqual({ type: 'chordLyricsPair', chords: 'D/A', lyrics: 'I am ' });
@@ -45,7 +45,7 @@ describe('breakChordLyricsPairOnSoftLineBreak', () => {
   it('supports a soft line break directly following a chord', () => {
     const chords = 'D/A';
     const lyrics = '\xA0a barber';
-    const items: Array<SerializedChordLyricsPair | SerializedSoftLineBreak> =
+    const items: (SerializedChordLyricsPair | SerializedSoftLineBreak)[] =
       breakChordLyricsPairOnSoftLineBreak(chords, lyrics);
 
     expect(items[0]).toEqual({ type: 'chordLyricsPair', chords: 'D/A', lyrics: '' });
@@ -56,7 +56,7 @@ describe('breakChordLyricsPairOnSoftLineBreak', () => {
   it('supports a chord without lyrics', () => {
     const chords = 'D/A';
     const lyrics = '';
-    const items: Array<SerializedChordLyricsPair | SerializedSoftLineBreak> =
+    const items: (SerializedChordLyricsPair | SerializedSoftLineBreak)[] =
       breakChordLyricsPairOnSoftLineBreak(chords, lyrics);
 
     expect(items[0]).toEqual({ type: 'chordLyricsPair', chords: 'D/A', lyrics: '' });
@@ -65,7 +65,7 @@ describe('breakChordLyricsPairOnSoftLineBreak', () => {
   it('returns an empty array when there are no chords or lyrics', () => {
     const chords = '';
     const lyrics = '';
-    const items: Array<SerializedChordLyricsPair | SerializedSoftLineBreak> =
+    const items: (SerializedChordLyricsPair | SerializedSoftLineBreak)[] =
       breakChordLyricsPairOnSoftLineBreak(chords, lyrics);
 
     expect(items).toEqual([]);

test/utilities.ts

@@ -65,7 +65,7 @@ export function createChordLyricsPair(chords, lyrics) {
   return new ChordLyricsPair(chords, lyrics);
 }
 
-export function createTag(name: string, value: string = '') {
+export function createTag(name: string, value = '') {
   return new Tag(name, value);
 }
 
@@ -93,7 +93,7 @@ export function createSongFromAst(lines: SerializedItem[][]): Song {
   return new ChordSheetSerializer().deserialize(serializedSong);
 }
 
-export function tag(name: string, value: string = ''): SerializedTag {
+export function tag(name: string, value = ''): SerializedTag {
   return { type: 'tag', name, value };
 }
 
@@ -115,7 +115,7 @@ export function section(
   ];
 }
 
-export function chordLyricsPair(chords: string, lyrics: string, annotation: string = ''): SerializedChordLyricsPair {
+export function chordLyricsPair(chords: string, lyrics: string, annotation = ''): SerializedChordLyricsPair {
   return {
     type: 'chordLyricsPair', chords, lyrics, annotation,
   };
@@ -151,11 +151,11 @@ export function softLineBreak(): SerializedSoftLineBreak {
   return { type: 'softLineBreak' };
 }
 
-type TestCaseProps = {
+interface TestCaseProps {
   [key: string]: any;
   outcome: any;
   index: string;
-};
+}
 
 export function eachTestCase(table: string, callback: (_testCase: TestCaseProps) => void): void {
   const lines = table.trim().split('\n');
@@ -205,7 +205,7 @@ export function buildKey(
   keyString: string | number,
   keyType: ChordType,
   modifier?: Modifier | null,
-  minor: boolean = false,
+  minor = false,
 ) {
   const resolvedKey = Key.resolve({
     key: keyString,