fix: remove prettier formatting of outputted markdown

Author: bmish

lib/generator.ts

@@ -174,11 +174,10 @@ export async function generate(
     );
 
     const contents = readFileSync(pathToDoc).toString();
-    const contentsNew = await replaceOrCreateHeader(
+    const contentsNew = replaceOrCreateHeader(
       contents,
       newHeaderLines,
-      END_RULE_HEADER_MARKER,
-      pathToDoc
+      END_RULE_HEADER_MARKER
     );
 
     if (options?.check) {
@@ -230,7 +229,7 @@ export async function generate(
 
   // Update the rules list in the README.
   const readmeContents = readFileSync(pathToReadme, 'utf8');
-  const readmeContentsNew = await updateRulesList(
+  const readmeContentsNew = updateRulesList(
     details,
     readmeContents,
     plugin,

lib/markdown.ts

@@ -1,34 +1,16 @@
 // General helpers for dealing with markdown files / content.
 
-export async function format(str: string, filePath: string): Promise<string> {
-  try {
-    const { default: prettier } = await import('prettier');
-    const options = await prettier.resolveConfig(filePath);
-    return prettier
-      .format(str, {
-        ...options,
-        parser: 'markdown',
-      })
-      .trimEnd(); // Trim the ending newline that prettier may add.
-  } catch {
-    // Skip prettier formatting if not installed.
-    /* istanbul ignore next -- TODO: Figure out how to test when prettier is not installed. */
-    return str;
-  }
-}
-
 /**
  * Replace the header of a doc up to and including the specified marker.
  * Insert at beginning if header doesn't exist.
  * @param markdown - doc content
  * @param newHeader - new header including marker
  * @param marker - marker to indicate end of header
  */
-export async function replaceOrCreateHeader(
+export function replaceOrCreateHeader(
   markdown: string,
   newHeader: string,
-  marker: string,
-  pathToDoc: string
+  marker: string
 ) {
   const lines = markdown.split('\n');
 
@@ -39,9 +21,7 @@ export async function replaceOrCreateHeader(
     lines.splice(0, 1);
   }
 
-  return `${await format(newHeader, pathToDoc)}\n${lines
-    .slice(markerLineIndex + 1)
-    .join('\n')}`;
+  return `${newHeader}\n${lines.slice(markerLineIndex + 1).join('\n')}`;
 }
 
 /**

lib/rule-list.ts

@@ -7,7 +7,7 @@ import {
 } from './emojis.js';
 import { getConfigsForRule } from './configs.js';
 import { getColumns, COLUMN_HEADER } from './rule-list-columns.js';
-import { findSectionHeader, format } from './markdown.js';
+import { findSectionHeader } from './markdown.js';
 import { getPluginRoot } from './package-json.js';
 import { generateLegend } from './legend.js';
 import { relative } from 'node:path';
@@ -271,7 +271,7 @@ function generateRulesListMarkdownWithSplitBy(
   return parts.join('\n\n');
 }
 
-export async function updateRulesList(
+export function updateRulesList(
   details: RuleDetails[],
   markdown: string,
   plugin: Plugin,
@@ -284,7 +284,7 @@ export async function updateRulesList(
   ruleListColumns: COLUMN_TYPE[],
   urlConfigs?: string,
   splitBy?: string
-): Promise<string> {
+): string {
   let listStartIndex = markdown.indexOf(BEGIN_RULE_LIST_MARKER);
   let listEndIndex = markdown.indexOf(END_RULE_LIST_MARKER);
 
@@ -360,7 +360,7 @@ export async function updateRulesList(
         ignoreConfig
       );
 
-  const newContent = await format(`${legend}\n\n${list}`, pathToReadme);
+  const newContent = `${legend ? `${legend}\n\n` : ''}${list}`;
 
   return `${preList}${BEGIN_RULE_LIST_MARKER}\n\n${newContent}\n\n${END_RULE_LIST_MARKER}${postList}`;
 }

package-lock.json

@@ -55,7 +55,6 @@
     "@types/jest": "^29.1.0",
     "@types/mock-fs": "^4.13.1",
     "@types/node": "^18.7.23",
-    "@types/prettier": "^2.7.1",
     "@types/sinon": "^10.0.13",
     "@typescript-eslint/eslint-plugin": "^5.38.1",
     "@typescript-eslint/parser": "^5.38.1",
@@ -77,8 +76,7 @@
     "typescript": "^4.8.4"
   },
   "peerDependencies": {
-    "eslint": ">= 7",
-    "prettier": ">= 2"
+    "eslint": ">= 7"
   },
   "engines": {
     "node": "^14.18.0 || ^16.0.0 || >=18.0.0"