Merge pull request #75 from brainstormforce/claude-docs-setup

Author: kiransbsf

.claude/settings.json

@@ -0,0 +1,28 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(npx grunt:*)",
+      "Bash(npm install)",
+      "Bash(composer install)",
+      "Bash(./vendor/bin/phpcs:*)",
+      "Bash(git status)",
+      "Bash(git diff:*)",
+      "Bash(git log:*)",
+      "Bash(git branch:*)",
+      "Bash(git checkout:*)",
+      "Bash(git add:*)",
+      "Bash(git commit:*)",
+      "Bash(git push:*)",
+      "Bash(git remote:*)",
+      "Bash(ls:*)",
+      "Bash(find:*)",
+      "Bash(cat:*)",
+      "Bash(wc:*)"
+    ],
+    "deny": [
+      "Bash(rm -rf:*)",
+      "Bash(git push --force:*)",
+      "Bash(git reset --hard:*)"
+    ]
+  }
+}

.distignore

@@ -31,4 +31,7 @@ node_modules
 *.tar.gz
 *.zip
 .github
-.wordpress-org
+.wordpress-org
+.claude
+CLAUDE.md
+internal-docs

.github/workflows/phpcs.yml

@@ -1,23 +1,23 @@
-name: PHP_CodeSniffer
-
-on: pull_request
-
-jobs:
-  phpcs:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: '8.0'
-          coverage: none
-          tools: composer
-
-      - name: Install dependencies
-        run: composer install --prefer-dist --no-suggest --no-progress
-
-      - name: Detect coding standard violations
+name: PHP_CodeSniffer
+
+on: pull_request
+
+jobs:
+  phpcs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.0'
+          coverage: none
+          tools: composer
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-suggest --no-progress
+
+      - name: Detect coding standard violations
         run: vendor/bin/phpcs

.gitignore

@@ -1,11 +1,14 @@
-.DS_Store
-phpcs.xml
-phpunit.xml
-Thumbs.db
-wp-cli.local.yml
-node_modules/
-*.sql
-*.tar.gz
-*.zip
-.wordpress-org
-vendor/
+.DS_Store
+phpcs.xml
+phpunit.xml
+Thumbs.db
+wp-cli.local.yml
+node_modules/
+*.sql
+*.tar.gz
+*.zip
+.wordpress-org
+vendor/
+
+.claude/settings.local.json
+config.bat

CLAUDE.md

@@ -0,0 +1,55 @@
+# Custom Template for LearnDash
+
+## Project Overview
+
+Custom Template for LearnDash is a WordPress plugin by Brainstorm Force. Replace default LearnDash course template for non-enrolled students with a custom page-builder template.
+
+- **Version:** 1.0.7
+- **Text Domain:** custom-template-learndash
+- **Main File:** custom-template-learndash.php
+- **Requires:** WordPress, PHP 5.6+
+
+## Tech Stack
+
+- **Language:** PHP
+- **Platform:** WordPress
+- **Build:** Grunt (i18n, readme conversion)
+- **Coding Standards:** PHPCS with WordPress standards
+
+## Commands
+
+```bash
+# Install dependencies
+npm install
+composer install
+
+# Build (i18n + readme)
+npx grunt
+
+# Generate translations
+npx grunt i18n
+
+# Convert readme.txt to README.md
+npx grunt readme
+
+# Run PHPCS
+./vendor/bin/phpcs .
+```
+
+## Architecture
+
+This is a WordPress plugin following standard WordPress patterns:
+- Entry point: `custom-template-learndash.php`
+- Constants defined for version, file path, base, dir, and URI
+- Classes loaded via `after_setup_theme` or `plugins_loaded` hook
+- Follows WordPress Coding Standards (WPCS)
+
+## Conventions
+
+- Use WordPress hooks (`add_action`, `add_filter`) for extensibility
+- Prefix all functions and classes to avoid conflicts
+- Use `custom-template-learndash` text domain for all translatable strings
+- Escape all output (`esc_html`, `esc_attr`, `esc_url`, `wp_kses`)
+- Sanitize all input (`sanitize_text_field`, `absint`, etc.)
+- Use nonces for form submissions and AJAX requests
+- Follow WordPress PHP coding standards