github-action-readme-generator 1.8.10 → 1.9.1

package/dist/mjs/readme-editor.d.ts

@@ -24,6 +24,11 @@ export default class ReadmeEditor {
      * @param {string} filePath - The path to the README file.
      */
     constructor(filePath: string);
+    /**
+     * Gets the current README content.
+     * @returns {string} - The README file content.
+     */
+    getReadmeContent(): string;
     /**
      * Gets the indexes of the start and end tokens for a given section.
      * @param {string} token - The section token.

package/dist/mjs/readme-editor.js

@@ -42,6 +42,13 @@ export default class ReadmeEditor {
             throw error;
         }
     }
+    /**
+     * Gets the current README content.
+     * @returns {string} - The README file content.
+     */
+    getReadmeContent() {
+        return this.fileContent;
+    }
     /**
      * Gets the indexes of the start and end tokens for a given section.
      * @param {string} token - The section token.

package/dist/mjs/readme-editor.js.map

@@ -1 +1 @@
-{"version":3,"file":"readme-editor.js","sourceRoot":"","sources":["../../src/readme-editor.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,GAAG,EAAE,MAAM,SAAS,CAAC;AAE9B,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,OAAO,MAAM,oBAAoB,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE/C;;GAEG;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,wCAAwC,CAAC;AAEzE;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,sCAAsC,CAAC;AAErE,MAAM,CAAC,OAAO,OAAO,YAAY;IACvB,GAAG,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC;IAE1C;;OAEG;IACc,QAAQ,CAAS;IAE1B,WAAW,CAAS;IAE5B;;;OAGG;IACH,YAAY,QAAgB;QAC1B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC;YACH,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YACxB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACrD,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;gBAC/B,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,QAAQ,mBAAmB,CAAC,CAAC;YACzD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,KAAa,EAAE,OAAiB;QAC9C,MAAM,GAAG,GAAG,OAAO,IAAI,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACtD,MAAM,WAAW,GAAG,IAAI,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QACtE,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;QACnE,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;YACtB,GAAG,CAAC,KAAK,CAAC,qCAAqC,KAAK,aAAa,CAAC,CAAC;YACnE,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7D,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;YACrB,GAAG,CAAC,KAAK,CAAC,4CAA4C,KAAK,aAAa,CAAC,CAAC;YAC1E,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,IAAY,EAAE,eAAkC,EAAE,WAAW,GAAG,IAAI;QAChF,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QAC9B,MAAM,OAAO,GAAG,CACd,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,IAAI,EAAE,CAAC,CACrF,CAAC,IAAI,EAAE,CAAC;QACT,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,aAAa,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE9D,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAChE,IAAI,UAAU,IAAI,SAAS,EAAE,CAAC;YAC5B,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;YAC5D,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAEvD,IAAI,CAAC,WAAW,GAAG,WAAW;gBAC5B,CAAC,CAAC,GAAG,aAAa,OAAO,OAAO,KAAK,YAAY,EAAE;gBACnD,CAAC,CAAC,GAAG,aAAa,GAAG,OAAO,GAAG,YAAY,EAAE,CAAC;QAClD,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACvD,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;CACF","sourcesContent":["/**\n * This TypeScript code imports the necessary modules and defines a class named `ReadmeEditor`.\n * The class represents an editor for modifying a README file.\n * It has methods to update specific sections within the file and dump the modified content back to the file.\n */\n\nimport * as fs from 'node:fs';\nimport { EOL } from 'node:os';\n\nimport * as core from '@actions/core';\n\nimport { indexOfRegex, lastIndexOfRegex } from './helpers.js';\nimport LogTask from './logtask/index.js';\nimport { formatMarkdown } from './prettier.js';\n\n/**\n * The format for the start token of a section.\n */\n\nexport const startTokenFormat = '(^|[^`\\\\\\\\])<!--\\\\s+start\\\\s+%s\\\\s+-->';\n\n/**\n * The format for the end token of a section.\n */\nexport const endTokenFormat = '(^|[^`\\\\\\\\])<!--\\\\s+end\\\\s+%s\\\\s+-->';\n\nexport default class ReadmeEditor {\n  private log = new LogTask('ReadmeEditor');\n\n  /**\n   * The path to the README file.\n   */\n  private readonly filePath: string;\n\n  private fileContent: string;\n\n  /**\n   * Creates a new instance of `ReadmeEditor`.\n   * @param {string} filePath - The path to the README file.\n   */\n  constructor(filePath: string) {\n    this.filePath = filePath;\n    try {\n      fs.accessSync(filePath);\n      this.fileContent = fs.readFileSync(filePath, 'utf8');\n      if (process.env.GITHUB_ACTIONS) {\n        core.setOutput('readme_before', this.fileContent);\n      }\n    } catch (error) {\n      this.log.fail(`Readme at '${filePath}' does not exist.`);\n      throw error;\n    }\n  }\n\n  /**\n   * Gets the indexes of the start and end tokens for a given section.\n   * @param {string} token - The section token.\n   * @returns {number[]} - The indexes of the start and end tokens.\n   */\n  getTokenIndexes(token: string, logTask?: LogTask): number[] {\n    const log = logTask ?? new LogTask('getTokenIndexes');\n    const startRegExp = new RegExp(startTokenFormat.replace('%s', token));\n    const stopRegExp = new RegExp(endTokenFormat.replace('%s', token));\n    const startIndex = lastIndexOfRegex(this.fileContent, startRegExp);\n    if (startIndex === -1) {\n      log.debug(`No start token found for section '${token}'. Skipping`);\n      return [];\n    }\n\n    const stopIndex = indexOfRegex(this.fileContent, stopRegExp);\n    if (stopIndex === -1) {\n      log.debug(`No start or end token found for section '${token}'. Skipping`);\n      return [];\n    }\n\n    return [startIndex, stopIndex];\n  }\n\n  /**\n   * Updates a specific section in the README file with the provided content.\n   * @param {string} name - The name of the section.\n   * @param {string | string[]} providedContent - The content to update the section with.\n   * @param {boolean} addNewlines - Whether to add newlines before and after the content.\n   */\n  updateSection(name: string, providedContent: string | string[], addNewlines = true): void {\n    const log = new LogTask(name);\n    const content = (\n      Array.isArray(providedContent) ? providedContent.join(EOL) : (providedContent ?? '')\n    ).trim();\n    log.info(`Looking for the ${name} token in ${this.filePath}`);\n\n    const [startIndex, stopIndex] = this.getTokenIndexes(name, log);\n    if (startIndex && stopIndex) {\n      const beforeContent = this.fileContent.slice(0, startIndex);\n      const afterContent = this.fileContent.slice(stopIndex);\n\n      this.fileContent = addNewlines\n        ? `${beforeContent}\\n\\n${content}\\n${afterContent}`\n        : `${beforeContent}${content}${afterContent}`;\n    }\n  }\n\n  /**\n   * Dumps the modified content back to the README file.\n   * @returns {Promise<void>}\n   */\n  async dumpToFile(): Promise<void> {\n    const content = await formatMarkdown(this.fileContent);\n    if (process.env.GITHUB_ACTIONS) {\n      core.setOutput('readme_after', content);\n    }\n    return fs.promises.writeFile(this.filePath, content, 'utf8');\n  }\n}\n"]}
+{"version":3,"file":"readme-editor.js","sourceRoot":"","sources":["../../src/readme-editor.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,GAAG,EAAE,MAAM,SAAS,CAAC;AAE9B,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,OAAO,MAAM,oBAAoB,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE/C;;GAEG;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,wCAAwC,CAAC;AAEzE;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,sCAAsC,CAAC;AAErE,MAAM,CAAC,OAAO,OAAO,YAAY;IACvB,GAAG,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC;IAE1C;;OAEG;IACc,QAAQ,CAAS;IAE1B,WAAW,CAAS;IAE5B;;;OAGG;IACH,YAAY,QAAgB;QAC1B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC;YACH,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YACxB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACrD,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;gBAC/B,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,QAAQ,mBAAmB,CAAC,CAAC;YACzD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,KAAa,EAAE,OAAiB;QAC9C,MAAM,GAAG,GAAG,OAAO,IAAI,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACtD,MAAM,WAAW,GAAG,IAAI,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QACtE,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;QACnE,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;YACtB,GAAG,CAAC,KAAK,CAAC,qCAAqC,KAAK,aAAa,CAAC,CAAC;YACnE,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7D,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;YACrB,GAAG,CAAC,KAAK,CAAC,4CAA4C,KAAK,aAAa,CAAC,CAAC;YAC1E,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,IAAY,EAAE,eAAkC,EAAE,WAAW,GAAG,IAAI;QAChF,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QAC9B,MAAM,OAAO,GAAG,CACd,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,IAAI,EAAE,CAAC,CACrF,CAAC,IAAI,EAAE,CAAC;QACT,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,aAAa,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE9D,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAChE,IAAI,UAAU,IAAI,SAAS,EAAE,CAAC;YAC5B,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;YAC5D,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAEvD,IAAI,CAAC,WAAW,GAAG,WAAW;gBAC5B,CAAC,CAAC,GAAG,aAAa,OAAO,OAAO,KAAK,YAAY,EAAE;gBACnD,CAAC,CAAC,GAAG,aAAa,GAAG,OAAO,GAAG,YAAY,EAAE,CAAC;QAClD,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACvD,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;CACF","sourcesContent":["/**\n * This TypeScript code imports the necessary modules and defines a class named `ReadmeEditor`.\n * The class represents an editor for modifying a README file.\n * It has methods to update specific sections within the file and dump the modified content back to the file.\n */\n\nimport * as fs from 'node:fs';\nimport { EOL } from 'node:os';\n\nimport * as core from '@actions/core';\n\nimport { indexOfRegex, lastIndexOfRegex } from './helpers.js';\nimport LogTask from './logtask/index.js';\nimport { formatMarkdown } from './prettier.js';\n\n/**\n * The format for the start token of a section.\n */\n\nexport const startTokenFormat = '(^|[^`\\\\\\\\])<!--\\\\s+start\\\\s+%s\\\\s+-->';\n\n/**\n * The format for the end token of a section.\n */\nexport const endTokenFormat = '(^|[^`\\\\\\\\])<!--\\\\s+end\\\\s+%s\\\\s+-->';\n\nexport default class ReadmeEditor {\n  private log = new LogTask('ReadmeEditor');\n\n  /**\n   * The path to the README file.\n   */\n  private readonly filePath: string;\n\n  private fileContent: string;\n\n  /**\n   * Creates a new instance of `ReadmeEditor`.\n   * @param {string} filePath - The path to the README file.\n   */\n  constructor(filePath: string) {\n    this.filePath = filePath;\n    try {\n      fs.accessSync(filePath);\n      this.fileContent = fs.readFileSync(filePath, 'utf8');\n      if (process.env.GITHUB_ACTIONS) {\n        core.setOutput('readme_before', this.fileContent);\n      }\n    } catch (error) {\n      this.log.fail(`Readme at '${filePath}' does not exist.`);\n      throw error;\n    }\n  }\n\n  /**\n   * Gets the current README content.\n   * @returns {string} - The README file content.\n   */\n  getReadmeContent(): string {\n    return this.fileContent;\n  }\n\n  /**\n   * Gets the indexes of the start and end tokens for a given section.\n   * @param {string} token - The section token.\n   * @returns {number[]} - The indexes of the start and end tokens.\n   */\n  getTokenIndexes(token: string, logTask?: LogTask): number[] {\n    const log = logTask ?? new LogTask('getTokenIndexes');\n    const startRegExp = new RegExp(startTokenFormat.replace('%s', token));\n    const stopRegExp = new RegExp(endTokenFormat.replace('%s', token));\n    const startIndex = lastIndexOfRegex(this.fileContent, startRegExp);\n    if (startIndex === -1) {\n      log.debug(`No start token found for section '${token}'. Skipping`);\n      return [];\n    }\n\n    const stopIndex = indexOfRegex(this.fileContent, stopRegExp);\n    if (stopIndex === -1) {\n      log.debug(`No start or end token found for section '${token}'. Skipping`);\n      return [];\n    }\n\n    return [startIndex, stopIndex];\n  }\n\n  /**\n   * Updates a specific section in the README file with the provided content.\n   * @param {string} name - The name of the section.\n   * @param {string | string[]} providedContent - The content to update the section with.\n   * @param {boolean} addNewlines - Whether to add newlines before and after the content.\n   */\n  updateSection(name: string, providedContent: string | string[], addNewlines = true): void {\n    const log = new LogTask(name);\n    const content = (\n      Array.isArray(providedContent) ? providedContent.join(EOL) : (providedContent ?? '')\n    ).trim();\n    log.info(`Looking for the ${name} token in ${this.filePath}`);\n\n    const [startIndex, stopIndex] = this.getTokenIndexes(name, log);\n    if (startIndex && stopIndex) {\n      const beforeContent = this.fileContent.slice(0, startIndex);\n      const afterContent = this.fileContent.slice(stopIndex);\n\n      this.fileContent = addNewlines\n        ? `${beforeContent}\\n\\n${content}\\n${afterContent}`\n        : `${beforeContent}${content}${afterContent}`;\n    }\n  }\n\n  /**\n   * Dumps the modified content back to the README file.\n   * @returns {Promise<void>}\n   */\n  async dumpToFile(): Promise<void> {\n    const content = await formatMarkdown(this.fileContent);\n    if (process.env.GITHUB_ACTIONS) {\n      core.setOutput('readme_after', content);\n    }\n    return fs.promises.writeFile(this.filePath, content, 'utf8');\n  }\n}\n"]}

package/dist/mjs/sections/index.js

@@ -1,6 +1,7 @@
 import LogTask from '../logtask/index.js';
 import updateBadges from './update-badges.js';
 import updateBranding from './update-branding.js';
+import updateContents from './update-contents.js';
 import updateDescription from './update-description.js';
 import updateInputs from './update-inputs.js';
 import updateOutputs from './update-outputs.js';
@@ -37,6 +38,9 @@ export default async function updateSection(section, inputs) {
         case 'outputs': {
             return updateOutputs(section, inputs);
         }
+        case 'contents': {
+            return updateContents(section, inputs);
+        }
         default: {
             log.debug(`unknown section found <!-- start ${section} -->. No updates were made.`);
             return {};

package/dist/mjs/sections/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sections/index.ts"],"names":[],"mappings":"AAUA,OAAO,OAAO,MAAM,qBAAqB,CAAC;AAC1C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,iBAAiB,MAAM,yBAAyB,CAAC;AACxD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;AAEzC,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,aAAa,CACzC,OAAsB,EACtB,MAAc;IAEd,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAC7E,KAAK;IACL,6CAA6C;IAC7C,yDAAyD;IACzD,IAAI,UAAU,KAAK,CAAC,CAAC,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,OAAO,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACzC,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACvC,CAAC;QACD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,OAAO,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtC,CAAC;QACD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,OAAO,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtC,CAAC;QACD,KAAK,aAAa,CAAC,CAAC,CAAC;YACnB,OAAO,iBAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC5C,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACvC,CAAC;QACD,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,OAAO,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,GAAG,CAAC,KAAK,CAAC,oCAAoC,OAAO,6BAA6B,CAAC,CAAC;YACpF,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;AACH,CAAC","sourcesContent":["/**\n * This TypeScript code exports a function named 'updateSection' which takes a section (ReadmeSection) and an instance of the 'Inputs' class as its parameters.\n * The function is responsible for updating different sections of the README.md file based on the provided section input.\n * It utilizes various update functions (e.g., updateBranding, updateBadges) to update specific sections.\n * @param {ReadmeSection} section - The section of the README to update.\n * @param {Inputs} inputs - The Inputs class instance.\n * @returns {Promise<void>} A promise that resolves once the section is updated.\n */\nimport { ReadmeSection } from '../constants.js';\nimport type Inputs from '../inputs.js';\nimport LogTask from '../logtask/index.js';\nimport updateBadges from './update-badges.js';\nimport updateBranding from './update-branding.js';\nimport updateDescription from './update-description.js';\nimport updateInputs from './update-inputs.js';\nimport updateOutputs from './update-outputs.js';\nimport updateTitle from './update-title.js';\nimport updateUsage from './update-usage.js';\n\nconst log = new LogTask('updateSection');\n\nexport default async function updateSection(\n  section: ReadmeSection,\n  inputs: Inputs,\n): Promise<Record<string, string>> {\n  const [startToken, stopToken] = inputs.readmeEditor.getTokenIndexes(section);\n  // &&\n  // ['branding', 'title'].includes(section) &&\n  // inputs.config.get('branding_as_title_prefix') !== true\n  if (startToken === -1 || stopToken === -1) {\n    return {};\n  }\n  switch (section) {\n    case 'branding': {\n      return updateBranding(section, inputs);\n    }\n    case 'badges': {\n      return updateBadges(section, inputs);\n    }\n    case 'usage': {\n      return updateUsage(section, inputs);\n    }\n    case 'title': {\n      return updateTitle(section, inputs);\n    }\n    case 'description': {\n      return updateDescription(section, inputs);\n    }\n    case 'inputs': {\n      return updateInputs(section, inputs);\n    }\n    case 'outputs': {\n      return updateOutputs(section, inputs);\n    }\n    default: {\n      log.debug(`unknown section found <!-- start ${section} -->. No updates were made.`);\n      return {};\n    }\n  }\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sections/index.ts"],"names":[],"mappings":"AAUA,OAAO,OAAO,MAAM,qBAAqB,CAAC;AAC1C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,iBAAiB,MAAM,yBAAyB,CAAC;AACxD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;AAEzC,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,aAAa,CACzC,OAAsB,EACtB,MAAc;IAEd,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAC7E,KAAK;IACL,6CAA6C;IAC7C,yDAAyD;IACzD,IAAI,UAAU,KAAK,CAAC,CAAC,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,OAAO,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACzC,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACvC,CAAC;QACD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,OAAO,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtC,CAAC;QACD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,OAAO,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtC,CAAC;QACD,KAAK,aAAa,CAAC,CAAC,CAAC;YACnB,OAAO,iBAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC5C,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACvC,CAAC;QACD,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,OAAO,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACxC,CAAC;QACD,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,OAAO,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,GAAG,CAAC,KAAK,CAAC,oCAAoC,OAAO,6BAA6B,CAAC,CAAC;YACpF,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;AACH,CAAC","sourcesContent":["/**\n * This TypeScript code exports a function named 'updateSection' which takes a section (ReadmeSection) and an instance of the 'Inputs' class as its parameters.\n * The function is responsible for updating different sections of the README.md file based on the provided section input.\n * It utilizes various update functions (e.g., updateBranding, updateBadges) to update specific sections.\n * @param {ReadmeSection} section - The section of the README to update.\n * @param {Inputs} inputs - The Inputs class instance.\n * @returns {Promise<void>} A promise that resolves once the section is updated.\n */\nimport { ReadmeSection } from '../constants.js';\nimport type Inputs from '../inputs.js';\nimport LogTask from '../logtask/index.js';\nimport updateBadges from './update-badges.js';\nimport updateBranding from './update-branding.js';\nimport updateContents from './update-contents.js';\nimport updateDescription from './update-description.js';\nimport updateInputs from './update-inputs.js';\nimport updateOutputs from './update-outputs.js';\nimport updateTitle from './update-title.js';\nimport updateUsage from './update-usage.js';\n\nconst log = new LogTask('updateSection');\n\nexport default async function updateSection(\n  section: ReadmeSection,\n  inputs: Inputs,\n): Promise<Record<string, string>> {\n  const [startToken, stopToken] = inputs.readmeEditor.getTokenIndexes(section);\n  // &&\n  // ['branding', 'title'].includes(section) &&\n  // inputs.config.get('branding_as_title_prefix') !== true\n  if (startToken === -1 || stopToken === -1) {\n    return {};\n  }\n  switch (section) {\n    case 'branding': {\n      return updateBranding(section, inputs);\n    }\n    case 'badges': {\n      return updateBadges(section, inputs);\n    }\n    case 'usage': {\n      return updateUsage(section, inputs);\n    }\n    case 'title': {\n      return updateTitle(section, inputs);\n    }\n    case 'description': {\n      return updateDescription(section, inputs);\n    }\n    case 'inputs': {\n      return updateInputs(section, inputs);\n    }\n    case 'outputs': {\n      return updateOutputs(section, inputs);\n    }\n    case 'contents': {\n      return updateContents(section, inputs);\n    }\n    default: {\n      log.debug(`unknown section found <!-- start ${section} -->. No updates were made.`);\n      return {};\n    }\n  }\n}\n"]}

package/dist/mjs/sections/update-contents.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This TypeScript code exports a function named 'updateContents' which generates
+ * a table of contents from the README.md headers.
+ * @param {ReadmeSection} sectionToken - The sectionToken representing the section of the README to update.
+ * @param {Inputs} inputs - The Inputs class instance.
+ */
+import { ReadmeSection } from '../constants.js';
+import type Inputs from '../inputs.js';
+export default function updateContents(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;

package/dist/mjs/sections/update-contents.js

@@ -0,0 +1,87 @@
+import LogTask from '../logtask/index.js';
+/**
+ * Converts a header text to a GitHub-compatible anchor link.
+ * @param {string} text - The header text to convert.
+ * @returns {string} The anchor link.
+ */
+function headerToAnchor(text) {
+    return text
+        .toLowerCase()
+        .replaceAll(/[^\w\s-]/g, '') // Remove special characters except hyphens
+        .replaceAll(/\s+/g, '-') // Replace spaces with hyphens
+        .replaceAll(/-+/g, '-') // Collapse multiple hyphens
+        .replaceAll(/^-|-$/g, ''); // Remove leading/trailing hyphens
+}
+/**
+ * Extracts headers from markdown content, excluding those in code blocks.
+ * @param {string} content - The markdown content.
+ * @returns {Array<{level: number, text: string}>} Array of header objects.
+ */
+function extractHeaders(content) {
+    const headers = [];
+    const lines = content.split('\n');
+    let inCodeBlock = false;
+    for (const line of lines) {
+        // Track code block state
+        if (line.trim().startsWith('```')) {
+            inCodeBlock = !inCodeBlock;
+            continue;
+        }
+        // Skip if inside code block
+        if (inCodeBlock) {
+            continue;
+        }
+        // Match markdown headers (## Header)
+        const headerMatch = /^(#{2,6})\s+(.+)$/.exec(line);
+        if (headerMatch) {
+            const level = headerMatch[1].length;
+            let text = headerMatch[2].trim();
+            // Remove inline images and other markdown formatting from header text
+            text = text.replaceAll(/<img[^>]*>/g, '').trim();
+            // Remove markdown links but keep the text
+            text = text.replaceAll(/\[([^\]]+)]\([^)]+\)/g, '$1');
+            if (text) {
+                headers.push({ level, text });
+            }
+        }
+    }
+    return headers;
+}
+export default function updateContents(sectionToken, inputs) {
+    const log = new LogTask(sectionToken);
+    log.start();
+    const content = [];
+    const readmeContent = inputs.readmeEditor.getReadmeContent();
+    // Extract headers from README
+    const headers = extractHeaders(readmeContent);
+    // Filter out the title (h1) and contents section itself
+    const tocHeaders = headers.filter((h) => h.level >= 2 && !h.text.toLowerCase().includes('contents'));
+    if (tocHeaders.length === 0) {
+        log.info('No headers found for table of contents');
+    }
+    else {
+        log.info(`Generating table of contents with ${tocHeaders.length} entries`);
+        // Find minimum header level for proper indentation
+        const minLevel = Math.min(...tocHeaders.map((h) => h.level));
+        // Track anchor occurrences to disambiguate duplicates like GitHub does
+        const anchorCounts = new Map();
+        // Generate TOC entries
+        content.push('## Table of Contents', '');
+        for (const header of tocHeaders) {
+            const indent = '  '.repeat(header.level - minLevel);
+            const baseAnchor = headerToAnchor(header.text);
+            // Track occurrences and compute unique anchor
+            const count = anchorCounts.get(baseAnchor) ?? 0;
+            anchorCounts.set(baseAnchor, count + 1);
+            // First occurrence uses base anchor, subsequent ones get -1, -2, etc.
+            const anchor = count === 0 ? baseAnchor : `${baseAnchor}-${count}`;
+            content.push(`${indent}- [${header.text}](#${anchor})`);
+        }
+    }
+    inputs.readmeEditor.updateSection(sectionToken, content);
+    log.success();
+    const ret = {};
+    ret[sectionToken] = content.join('\n');
+    return ret;
+}
+//# sourceMappingURL=update-contents.js.map

package/dist/mjs/sections/update-contents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-contents.js","sourceRoot":"","sources":["../../../src/sections/update-contents.ts"],"names":[],"mappings":"AAQA,OAAO,OAAO,MAAM,qBAAqB,CAAC;AAE1C;;;;GAIG;AACH,SAAS,cAAc,CAAC,IAAY;IAClC,OAAO,IAAI;SACR,WAAW,EAAE;SACb,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,2CAA2C;SACvE,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,8BAA8B;SACtD,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,4BAA4B;SACnD,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,kCAAkC;AACjE,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,OAAe;IACrC,MAAM,OAAO,GAAsC,EAAE,CAAC;IACtD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAClC,IAAI,WAAW,GAAG,KAAK,CAAC;IAExB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,yBAAyB;QACzB,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAClC,WAAW,GAAG,CAAC,WAAW,CAAC;YAC3B,SAAS;QACX,CAAC;QAED,4BAA4B;QAC5B,IAAI,WAAW,EAAE,CAAC;YAChB,SAAS;QACX,CAAC;QAED,qCAAqC;QACrC,MAAM,WAAW,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YACpC,IAAI,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAEjC,sEAAsE;YACtE,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACjD,0CAA0C;YAC1C,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAC;YAEtD,IAAI,IAAI,EAAE,CAAC;gBACT,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,YAA2B,EAC3B,MAAc;IAEd,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;IACtC,GAAG,CAAC,KAAK,EAAE,CAAC;IAEZ,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC,gBAAgB,EAAE,CAAC;IAE7D,8BAA8B;IAC9B,MAAM,OAAO,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC;IAE9C,wDAAwD;IACxD,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAC/B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAClE,CAAC;IAEF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,GAAG,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;IACrD,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,IAAI,CAAC,qCAAqC,UAAU,CAAC,MAAM,UAAU,CAAC,CAAC;QAE3E,mDAAmD;QACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAE7D,uEAAuE;QACvE,MAAM,YAAY,GAAG,IAAI,GAAG,EAAkB,CAAC;QAE/C,uBAAuB;QACvB,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;QAEzC,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE,CAAC;YAChC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,GAAG,QAAQ,CAAC,CAAC;YACpD,MAAM,UAAU,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAE/C,8CAA8C;YAC9C,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAChD,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;YAExC,sEAAsE;YACtE,MAAM,MAAM,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,IAAI,KAAK,EAAE,CAAC;YAEnE,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,MAAM,MAAM,CAAC,IAAI,MAAM,MAAM,GAAG,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,aAAa,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACzD,GAAG,CAAC,OAAO,EAAE,CAAC;IAEd,MAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,GAAG,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["/**\n * This TypeScript code exports a function named 'updateContents' which generates\n * a table of contents from the README.md headers.\n * @param {ReadmeSection} sectionToken - The sectionToken representing the section of the README to update.\n * @param {Inputs} inputs - The Inputs class instance.\n */\nimport { ReadmeSection } from '../constants.js';\nimport type Inputs from '../inputs.js';\nimport LogTask from '../logtask/index.js';\n\n/**\n * Converts a header text to a GitHub-compatible anchor link.\n * @param {string} text - The header text to convert.\n * @returns {string} The anchor link.\n */\nfunction headerToAnchor(text: string): string {\n  return text\n    .toLowerCase()\n    .replaceAll(/[^\\w\\s-]/g, '') // Remove special characters except hyphens\n    .replaceAll(/\\s+/g, '-') // Replace spaces with hyphens\n    .replaceAll(/-+/g, '-') // Collapse multiple hyphens\n    .replaceAll(/^-|-$/g, ''); // Remove leading/trailing hyphens\n}\n\n/**\n * Extracts headers from markdown content, excluding those in code blocks.\n * @param {string} content - The markdown content.\n * @returns {Array<{level: number, text: string}>} Array of header objects.\n */\nfunction extractHeaders(content: string): { level: number; text: string }[] {\n  const headers: { level: number; text: string }[] = [];\n  const lines = content.split('\\n');\n  let inCodeBlock = false;\n\n  for (const line of lines) {\n    // Track code block state\n    if (line.trim().startsWith('```')) {\n      inCodeBlock = !inCodeBlock;\n      continue;\n    }\n\n    // Skip if inside code block\n    if (inCodeBlock) {\n      continue;\n    }\n\n    // Match markdown headers (## Header)\n    const headerMatch = /^(#{2,6})\\s+(.+)$/.exec(line);\n    if (headerMatch) {\n      const level = headerMatch[1].length;\n      let text = headerMatch[2].trim();\n\n      // Remove inline images and other markdown formatting from header text\n      text = text.replaceAll(/<img[^>]*>/g, '').trim();\n      // Remove markdown links but keep the text\n      text = text.replaceAll(/\\[([^\\]]+)]\\([^)]+\\)/g, '$1');\n\n      if (text) {\n        headers.push({ level, text });\n      }\n    }\n  }\n\n  return headers;\n}\n\nexport default function updateContents(\n  sectionToken: ReadmeSection,\n  inputs: Inputs,\n): Record<string, string> {\n  const log = new LogTask(sectionToken);\n  log.start();\n\n  const content: string[] = [];\n  const readmeContent = inputs.readmeEditor.getReadmeContent();\n\n  // Extract headers from README\n  const headers = extractHeaders(readmeContent);\n\n  // Filter out the title (h1) and contents section itself\n  const tocHeaders = headers.filter(\n    (h) => h.level >= 2 && !h.text.toLowerCase().includes('contents'),\n  );\n\n  if (tocHeaders.length === 0) {\n    log.info('No headers found for table of contents');\n  } else {\n    log.info(`Generating table of contents with ${tocHeaders.length} entries`);\n\n    // Find minimum header level for proper indentation\n    const minLevel = Math.min(...tocHeaders.map((h) => h.level));\n\n    // Track anchor occurrences to disambiguate duplicates like GitHub does\n    const anchorCounts = new Map<string, number>();\n\n    // Generate TOC entries\n    content.push('## Table of Contents', '');\n\n    for (const header of tocHeaders) {\n      const indent = '  '.repeat(header.level - minLevel);\n      const baseAnchor = headerToAnchor(header.text);\n\n      // Track occurrences and compute unique anchor\n      const count = anchorCounts.get(baseAnchor) ?? 0;\n      anchorCounts.set(baseAnchor, count + 1);\n\n      // First occurrence uses base anchor, subsequent ones get -1, -2, etc.\n      const anchor = count === 0 ? baseAnchor : `${baseAnchor}-${count}`;\n\n      content.push(`${indent}- [${header.text}](#${anchor})`);\n    }\n  }\n\n  inputs.readmeEditor.updateSection(sectionToken, content);\n  log.success();\n\n  const ret: Record<string, string> = {};\n  ret[sectionToken] = content.join('\\n');\n  return ret;\n}\n"]}

package/dist/types/index.d.ts

@@ -412,6 +412,11 @@ declare module "src/readme-editor" {
          * @param {string} filePath - The path to the README file.
          */
         constructor(filePath: string);
+        /**
+         * Gets the current README content.
+         * @returns {string} - The README file content.
+         */
+        getReadmeContent(): string;
         /**
          * Gets the indexes of the start and end tokens for a given section.
          * @param {string} token - The section token.
@@ -881,6 +886,17 @@ declare module "src/sections/update-branding" {
      */
     export default function updateBranding(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;
 }
+declare module "src/sections/update-contents" {
+    /**
+     * This TypeScript code exports a function named 'updateContents' which generates
+     * a table of contents from the README.md headers.
+     * @param {ReadmeSection} sectionToken - The sectionToken representing the section of the README to update.
+     * @param {Inputs} inputs - The Inputs class instance.
+     */
+    import { ReadmeSection } from "src/constants";
+    import type Inputs from "src/inputs";
+    export default function updateContents(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;
+}
 declare module "src/sections/update-description" {
     /**
      * This TypeScript code exports a function named 'updateDescription' which takes a sectionToken (ReadmeSection) and an instance of the 'Inputs' class as its parameters.
@@ -1004,6 +1020,7 @@ declare module "__tests__/readme-generator.test" {
     export const __filename: string;
     export const __dirname: string;
 }
+declare module "__tests__/update-contents.test" { }
 declare module "__tests__/logtask/index.test" { }
 declare module "src/config" {
     import type Inputs from "src/inputs";

package/package.json

@@ -1,18 +1,21 @@
 {
   "name": "github-action-readme-generator",
   "displayName": "bitflight-devops/github-action-readme-generator",
-  "version": "1.8.10",
-  "description": "This is a CLI tool and GitHub Action that reads in the details from a \nGitHub Action's `action.yml` file and updates the `README.md` file\nwith the `name`, `description`, `usage`, `inputs`, `outputs`, and\nexamples of the action.\nConfiguration can be provided via a `.ghadocs.json` file stored in the\nroot directory of the Action's repository, via the command line when\nusing the cli, or via the `with:` section of this Action.\n\n\nThis tool uses markdown comments as delimiting tokens within the `README.md`\nfile to determine where to place the generated content.\n\n[`README.example.md`](README.example.md) example with all fields filled in, and no other free-form content.",
+  "version": "1.9.1",
+  "description": "The docs generator for GitHub Actions. Auto-syncs action.yml to README.md with 8 sections: inputs, outputs, usage, badges, branding & more. Works as CLI or GitHub Action.",
   "keywords": [
+    "github-actions",
     "actions",
-    "github",
-    "node20",
     "documentation",
-    "github-actions",
-    "generator",
     "readme-generator",
-    "action-metadata",
-    "markdown-generator"
+    "action-yml",
+    "markdown-generator",
+    "github-action-docs",
+    "auto-docs",
+    "devops",
+    "cli",
+    "inputs-outputs",
+    "usage-generator"
   ],
   "homepage": "https://github.com/bitflight-devops/github-action-readme-generator#readme",
   "bugs": {
@@ -141,14 +144,14 @@
   },
   "dependencies": {
     "@actions/core": "^2.0.1",
-    "@actions/github": "^6.0.1",
+    "@actions/github": "^7.0.0",
     "@svgdotjs/svg.js": "^3.2.5",
     "@types/feather-icons": "^4.29.4",
     "@types/svgdom": "^0.1.2",
     "chalk": "^5.6.2",
     "feather-icons": "^4.29.2",
     "nconf": "^0.13.0",
-    "prettier": "^3.7.4",
+    "prettier": "^3.8.1",
     "svgdom": "^0.1.22",
     "yaml": "^2.8.2"
   },
@@ -158,7 +161,7 @@
     "@babel/plugin-proposal-decorators": "^7.28.0",
     "@babel/preset-env": "^7.26.0",
     "@commitlint/cli": "^20.3.1",
-    "@commitlint/config-conventional": "^20.0.0",
+    "@commitlint/config-conventional": "^20.3.1",
     "@commitlint/prompt": "^20.3.1",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.1.0",
     "@semantic-release/changelog": "^6.0.3",
@@ -170,7 +173,7 @@
     "@types/nconf": "^0.10.5",
     "@types/node": "^25.0.9",
     "@types/node-emoji": "^2.1.0",
-    "@typescript-eslint/eslint-plugin": "^8.53.0",
+    "@typescript-eslint/eslint-plugin": "^8.53.1",
     "@typescript-eslint/parser": "^8.53.0",
     "@vitest/coverage-v8": "^4.0.6",
     "commitizen": "^4.3.1",