ADD TO: publish action / auto-generate table of contents

Author: jrfnl

.github/workflows/publish-wiki.yml

@@ -35,10 +35,16 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
+      - name: Install DocToc table of contents generator
+        run: npm install -g doctoc
+
       - name: Copy wiki files to temporary location
         shell: bash
         run: cp -v -a wiki _wiki
 
+      - name: Update tables of contents
+        run: doctoc ./_wiki/ --github --maxlevel 4 --update-only
+
       - name: Deploy to wiki
         uses: Andrew-Chen-Wang/github-wiki-action@v4
         with:

wiki/About-Standards-for-PHP_CodeSniffer.md

@@ -1,15 +1,7 @@
 ## Table of contents
 
-* [A Project ruleset or a standard ?](#a-project-ruleset-or-a-standard-)
-* [How does PHP_CodeSniffer determine which standard or ruleset to apply ?](#how-does-php_codesniffer-determine-which-standard-or-ruleset-to-apply-)
-* [About standards](#about-standards)
-* [Creating an external standard for PHP_CodeSniffer](#creating-an-external-standard-for-php_codesniffer)
-* [Creating new rules](#creating-new-rules)
-    * [Naming conventions](#naming-conventions)
-        * [1. Directory structure](#1-directory-structure)
-        * [2. Sniff file name](#2-sniff-file-name)
-        * [3. Namespace and class name](#3-namespace-and-class-name)
-        * [Examples](#examples)
+<!-- START doctoc -->
+<!-- END doctoc -->
 
 ***
 

wiki/Configuration-Options.md

@@ -1,27 +1,7 @@
 ## Table of contents
 
-* [Setting the default coding standard](#setting-the-default-coding-standard)
-* [Setting the default report format](#setting-the-default-report-format)
-* [Hiding warnings by default](#hiding-warnings-by-default)
-* [Showing progress by default](#showing-progress-by-default)
-* [Using colors in output by default](#using-colors-in-output-by-default)
-* [Changing the default severity levels](#changing-the-default-severity-levels)
-* [Setting the default report width](#setting-the-default-report-width)
-* [Setting the default encoding](#setting-the-default-encoding)
-* [Setting the default tab width](#setting-the-default-tab-width)
-* [Setting the installed standard paths](#setting-the-installed-standard-paths)
-* [Setting the PHP version](#setting-the-php-version)
-* [Ignoring errors when generating the exit code](#ignoring-errors-when-generating-the-exit-code)
-* [Ignoring warnings when generating the exit code](#ignoring-warnings-when-generating-the-exit-code)
-* [Ignoring non-auto-fixable issues when generating the exit code (PHP_CodeSniffer >= 4.0.0)](#ignoring-non-auto-fixable-issues-when-generating-the-exit-code-php_codesniffer--400)
-* Setting tool paths
-    * [CSSLint](#setting-the-path-to-csslint)
-    * [Google Closure Linter](#setting-the-path-to-the-google-closure-linter)
-    * [PHP](#setting-the-path-to-php)
-    * [JSHint](#setting-the-path-to-jshint)
-    * [JSLint](#setting-the-path-to-jslint)
-    * [JavaScript Lint](#setting-the-path-to-javascript-lint)
-    * [Zend Code Analyzer](#setting-the-path-to-the-zend-code-analyzer)
+<!-- START doctoc -->
+<!-- END doctoc -->
 
 ***
 

wiki/FAQ.md

@@ -1,11 +1,7 @@
 ## Table of contents
 
-* [Does PHP_CodeSniffer perform any code coverage or unit testing?](#does-php_codesniffer-perform-any-code-coverage-or-unit-testing)
-* [My code is fine! Why do I need PHP_CodeSniffer?](#my-code-is-fine-why-do-i-need-php_codesniffer)
-* [Does PHP_CodeSniffer parse my code to ensure it will execute?](#does-php_codesniffer-parse-my-code-to-ensure-it-will-execute)
-* [I don't agree with your coding standards! Can I make PHP_CodeSniffer enforce my own?](#i-dont-agree-with-your-coding-standards-can-i-make-php_codesniffer-enforce-my-own)
-* [How come PHP_CodeSniffer reported errors, I fixed them, now I get even more?](#how-come-php_codesniffer-reported-errors-i-fixed-them-now-i-get-even-more)
-* [What does PHP_CodeSniffer use to tokenize my code?](#what-does-php_codesniffer-use-to-tokenize-my-code)
+<!-- START doctoc -->
+<!-- END doctoc -->
 
 ***
 

wiki/Fixing-Errors-Automatically.md

@@ -1,8 +1,7 @@
 ## Table of contents
 
-* [About Automatic Fixing](#about-automatic-fixing)
-* [Using the PHP Code Beautifier and Fixer](#using-the-php-code-beautifier-and-fixer)
-* [Viewing Debug Information](#viewing-debug-information)
+<!-- START doctoc -->
+<!-- END doctoc -->
 
 ***