Update to TS 5

Updated dependencies
Fixed linting errors

Author: Alessio Michelini

package-lock.json

@@ -11,21 +11,21 @@
     "tslib": "^2.5.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.21.0",
-    "@babel/preset-env": "^7.20.2",
+    "@babel/core": "^7.21.4",
+    "@babel/preset-env": "^7.21.4",
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
-    "@types/jest": "^29.4.0",
-    "@types/node": "^18.15.0",
-    "@typescript-eslint/eslint-plugin": "^5.54.1",
-    "@typescript-eslint/parser": "^5.54.1",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^18.15.11",
+    "@typescript-eslint/eslint-plugin": "^5.57.1",
+    "@typescript-eslint/parser": "^5.57.1",
     "auto-changelog": "^2.4.0",
     "babel-jest": "^29.5.0",
-    "eslint": "^8.36.0",
+    "eslint": "^8.37.0",
     "jest": "^29.5.0",
     "nyc": "^15.1.0",
-    "ts-jest": "^29.0.5",
+    "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5.0.3"
   },
   "engines": {
     "node": ">=16.0.0"

package.json

@@ -1,6 +1,6 @@
-import {VALID_FORMATS} from '../constants'
+import {VALID_FORMATS} from '../constants';
 
 export const isFileValid = (file: string): boolean => {
-  const regex = new RegExp(`(${VALID_FORMATS.join('|')})$`)
-  return regex.test(file)
+  const regex = new RegExp(`(${VALID_FORMATS.join('|')})$`);
+  return regex.test(file);
 }

src/lib/file.ts

@@ -1,15 +1,15 @@
-import {INDEX_TAG} from '../constants'
+import {INDEX_TAG} from '../constants';
 
 /**
  * Tries to the first H2 title and adds the index tag right before it
  * @param text The text to process
  * @returns The updated text
  */
 export const findFirstParagraph = (text: string): string => {
-  const regex = /^(##\s.+)\n{1,3}/gm
-  const split = text.split(regex)
-  split.splice(1, 0, `<!-- ${INDEX_TAG}-start -->\n<!-- ${INDEX_TAG}-end -->\n\n`)
-  return split.join('')
+  const regex = /^(##\s.+)\n{1,3}/gm;
+  const split = text.split(regex);
+  split.splice(1, 0, `<!-- ${INDEX_TAG}-start -->\n<!-- ${INDEX_TAG}-end -->\n\n`);
+  return split.join('');
 }
 
 /**
@@ -21,23 +21,23 @@ export const findFirstParagraph = (text: string): string => {
  * @returns The parsed string
  */
 export const replaceTag = (source: string, tag: string, content: string): string => {
-  const start = `<!-- ${tag}-start -->`
-  const end = `<!-- ${tag}-end -->`
-  let tagStartPosition = source.indexOf(start)
-  let tagEndPosition = source.indexOf(end)
+  const start = `<!-- ${tag}-start -->`;
+  const end = `<!-- ${tag}-end -->`;
+  let tagStartPosition = source.indexOf(start);
+  let tagEndPosition = source.indexOf(end);
   if (tagStartPosition === -1 || tagEndPosition === -1) {
     if (tag === INDEX_TAG) {
-      source = findFirstParagraph(source)
-      tagStartPosition = source.indexOf(start)
-      tagEndPosition = source.indexOf(end)
+      source = findFirstParagraph(source);
+      tagStartPosition = source.indexOf(start);
+      tagEndPosition = source.indexOf(end);
     } else {
-      throw new Error(`You must add the ${tag} tags in the document!`)
+      throw new Error(`You must add the ${tag} tags in the document!`);
     }
   }
 
-  const preTagContent = source.slice(0, tagStartPosition + start.length)
-  const postTagContent = source.slice(tagEndPosition)
-  return `${preTagContent}\n${content}\n${postTagContent}`
+  const preTagContent = source.slice(0, tagStartPosition + start.length);
+  const postTagContent = source.slice(tagEndPosition);
+  return `${preTagContent}\n${content}\n${postTagContent}`;
 }
 
 /**
@@ -48,6 +48,6 @@ export const replaceTag = (source: string, tag: string, content: string): string
  * @returns The replaced string
  */
 export const replaceBlock = (source: string, block: string): string => {
-  const regex = new RegExp(`${block}(.+?)${block}`, 'gms')
-  return source.replace(regex, '')
+  const regex = new RegExp(`${block}(.+?)${block}`, 'gms');
+  return source.replace(regex, '');
 }

src/lib/tags.ts

@@ -5,10 +5,6 @@
  */
 
 export function stringToPermalink(string: string): string {
-  if (typeof string !== 'string') {
-    return string
-  }
-
   return string
   .replace(/(-)+\1+/g, '')
   .replace(/\s/g, '-')

src/lib/utils.ts

@@ -1,4 +1,4 @@
-import {replaceTag, replaceBlock, findFirstParagraph} from '../../src/lib/tags'
+import {replaceTag, replaceBlock, findFirstParagraph} from '../../src/lib/tags';
 
 describe('tags.ts', () => {
   describe('findFirstParagraph (Function)', () => {
@@ -11,8 +11,8 @@ Some text\n`;
       const result = findFirstParagraph(mockContent)
       expect(result).toContain('<!-- index-start -->');
       expect(result).toContain('<!-- index-end -->');
-    })
-  })
+    });
+  });
 
   describe('replacetag (Function)', () => {
     it('should replace the content', () => {
@@ -22,7 +22,7 @@ Some text\n`;
       Some test`;
       const result = replaceTag(mockContent, 'test', 'hello');
       expect(result).toContain('hello');
-    })
+    });
 
     it('should throw an error if a tag is missing', () => {
       const mockContent = `# Some Title
@@ -35,8 +35,8 @@ Some text\n`;
       Some test`;
 
       expect(() => replaceTag(mockContent2, 'test', 'hello')).toThrow();
-    })
-  })
+    });
+  });
 
   describe('replaceBlock (Function)', () => {
     it('should remove the block from the content', () => {
@@ -47,7 +47,7 @@ Some text\n`;
       Some test`;
       const result = replaceBlock(mockContent, '```');
       expect(result).not.toContain('Find Me');
-    })
+    });
 
     it('should not remove everything else', () => {
       const mockContent = `# Some Title
@@ -57,7 +57,7 @@ Some text\n`;
       Some test`;
       const result = replaceBlock(mockContent, '```');
       expect(result).toContain('Some test');
-    })
+    });
 
     it('should remove every instance of the block from the content', () => {
       const mockContent = `# Some Title
@@ -71,6 +71,6 @@ Some text\n`;
       Some test`;
       const result = replaceBlock(mockContent, '```');
       expect(result).not.toContain('Find Me');
-    })
-  })
-})
+    });
+  });
+});

test/lib/tags.test.ts

@@ -4,18 +4,18 @@ describe('Utils', () => {
   describe('stringToPermalink', () => {
     it('should return the url formatted string', () => {
       expect(stringToPermalink('Hello world')).toEqual('hello-world');
-    })
+    });
 
     it('should escape punctuation characters', () => {
       expect(stringToPermalink('Hello, world')).toEqual('hello-world');
       expect(stringToPermalink('Hello. World!')).toEqual('hello-world');
-    })
+    });
 
     it('should escape special characters', () => {
       expect(stringToPermalink('Hello, @@--`world')).toEqual('hello-world');
       expect(stringToPermalink('Hello /world!****')).toEqual('hello-world');
       expect(stringToPermalink('---Hello---world---')).toEqual('helloworld');
-    })
-  })
-})
+    });
+  });
+});