Initial Commit of wp-hooks-documentor

Author: iamdharmesh

.github/workflows/update-built-branch.yml

@@ -0,0 +1,35 @@
+name: Update built branch
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Build and Push
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+      - name: Create the build folder
+        run: |
+          mkdir build
+          cp package.json build/
+          mv dist build/
+          mv lib build/
+
+      - name: Push
+        uses: s0/git-publish-subdir-action@ac113f6bfe8896e85a373534242c949a7ea74c98 # develop
+        env:
+          REPO: self
+          BRANCH: build
+          FOLDER: build
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          MESSAGE: 'Build: ({sha}) {msg}'

.gitignore

@@ -0,0 +1,29 @@
+# Dependencies
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Build output
+dist/
+*.tsbuildinfo
+
+# IDE and editor files
+.idea/
+.vscode/
+*.swp
+*.swo
+.DS_Store
+
+# Test coverage
+coverage/
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# Temporary files
+.hooks-temp/
+*.log 
+wp-hooks-docs/

.nvmrc

@@ -0,0 +1 @@
+v20

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "semi": true,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "endOfLine": "lf"
+} 

README.md

@@ -0,0 +1,88 @@
+# WP Hooks Documentor
+
+A powerful tool to generate beautiful documentation for WordPress plugin hooks.
+
+## Features
+
+- 📦 Automatically collects action and filter hooks from your WordPress plugin
+- 📝 Generates well-structured markdown documentation
+- 🌐 Creates a beautiful documentation site using Docusaurus
+- 🎨 Fully customizable theme
+- 🔍 Built-in search functionality
+
+## Requirements
+
+- Node.js >= 20.0
+- PHP >= 8.3
+
+## Installation
+
+```bash
+npm install -g wp-hooks-documentor
+```
+
+## Quick Start
+
+1. Initialize a new configuration file:
+```bash
+wp-hooks-documentor init
+```
+
+2. Edit the generated `wp-hooks-doc.json` file to match your project settings.
+
+3. Generate documentation:
+```bash
+wp-hooks-documentor generate
+```
+
+## Configuration
+
+The tool uses a single configuration file (`wp-hooks-doc.json`) to control all aspects of the documentation generation process. Here's a complete example with all available options:
+
+```json
+{
+  "title": "Plugin Hooks Documentation",
+  "tagline": "Hooks Documentation for the plugin",
+  "url": "https://example.com",
+  "baseUrl": "/",
+  "repoUrl": "https://github.com/username/repo",
+  "organizationName": "username",
+  "projectName": "repo",
+  "input": ".",
+  "ignoreFiles": [],
+  "ignoreHooks": [],
+  "outputDir": "./wp-hooks-docs",
+  "templatesDir": "./.wp-hooks-docs/template",
+  "footerStyle": "dark",
+  "footerCopyright: `Copyright © 2025. Built with WP Hooks Documentor.`,
+}
+```
+
+### Configuration Options
+
+- `title`: Site title
+- `tagline`: Site tagline
+- `url`: Production URL
+- `baseUrl`: Base URL path
+- `repoUrl`: GitHub repository URL
+- `organizationName`: GitHub organization/username
+- `projectName`: GitHub repository name
+- `input`: Path to your WordPress plugin
+- `ignoreFiles`: Files to ignore
+- `ignoreHooks`: Hooks to ignore
+- `outputDir`: Where to export documentation site
+- `templatesDir`: Custom templates directory to customize overall documentation site.
+- `footerStyle`: Footer style, eg: dark or light
+- `footerCopyright`: Footer copyright text
+
+## Commands
+
+- `wp-hooks-documentor init`: Create a new configuration file
+- `wp-hooks-documentor generate`: Generate complete documentation
+
+## Customization
+
+### Theme
+
+The documentation site uses Docusaurus, which means you can fully customize the theme. See the [Docusaurus documentation](https://docusaurus.io/docs/styling-layout) for more details.
+

eslint.config.mjs

@@ -0,0 +1,68 @@
+import { defineConfig, globalIgnores } from 'eslint/config';
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import globals from 'globals';
+import tsParser from '@typescript-eslint/parser';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+export default defineConfig([
+  globalIgnores(['node_modules/*', 'dist/*']),
+  {
+    extends: compat.extends(
+      'eslint:recommended',
+      'plugin:@typescript-eslint/recommended',
+      'plugin:prettier/recommended'
+    ),
+
+    plugins: {
+      '@typescript-eslint': typescriptEslint,
+    },
+
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+
+      parser: tsParser,
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+    },
+
+    rules: {
+      '@typescript-eslint/explicit-function-return-type': [
+        'error',
+        {
+          allowExpressions: true,
+          allowTypedFunctionExpressions: true,
+        },
+      ],
+
+      '@typescript-eslint/no-explicit-any': 'warn',
+
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+        },
+      ],
+
+      'no-console': [
+        'warn',
+        {
+          allow: ['warn', 'error', 'info', 'log'],
+        },
+      ],
+    },
+  },
+]);

lib/php/composer.json

@@ -0,0 +1,14 @@
+{
+  "require": {
+    "php": ">=8.3",
+    "wp-hooks/generator": "dev-trunk"
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "repositories": [
+      {
+          "type": "vcs",
+          "url": "https://github.com/iamdharmesh/wp-hooks-generator"
+      }
+  ]
+}