tip-generator/example.config.json at master · drupaltools/tip-generator · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
{
  "prompt_template": [
    "Generate a Drupal tip for category #{cat_id}: {cat_desc}",
    "",
    "NOTE: When reference data is provided below, your tip MUST be based on specific information from that reference. ",
    "Extract a concrete, testable tip from the reference content.",
    "Do not generate generic tips.",
    "",
    "Requirements:",
    "- One paragraph maximum (2-4 sentences)",
    "- Factual, specific, and useful for an experienced Drupal developer",
    "- No padding or filler",
    "- Prefer Drupal 11 / PHP 8.4+ idioms for code examples",
    "- If the tip involves code, include it in a code block with appropriate syntax highlighting (php, bash, sql, yaml, twig, json, etc. based on context)",
    "",
    "Output format:",
    "---",
    "category: {cat_name}",
    "title: [Short descriptive title]",
    "date: [Date formatted Y-m-d]",
    "---",
    "",
    "[The tip paragraph here]",
    "",
    "```",
    "[Code example if relevant - choose appropriate language: php/bash/sql/yaml/twig/json]",
    "```",
    "",
    "Generate ONE tip now."
  ],
  "categories": {
    "1": {"name": "proposed-new-module", "desc": "Proposed new module on drupal.org"},
    "2": {"name": "drupal-history", "desc": "Drupal history or very old versions", "urls": ["https://raw.githubusercontent.com/weitzman/drupal-timeline/refs/heads/main/drupal-timeline.json", "https://en.wikipedia.org/wiki/Drupal"]},
    "3": {"name": "notable-issue-commit", "desc": "Notable Drupal.org issue or commit"},
    "4": {"name": "drupal-statistics", "desc": "Interesting statistics about Drupal usage, websites using, installation counts, code lines, commits per month, people on the community etc"},
    "5": {"name": "obsolete-module", "desc": "Obsolete but once-popular Drupal module"},
    "6": {"name": "high-issue-count-module", "desc": "Module with unusually high issue count"},
    "7": {"name": "old-maintained-module", "desc": "Very old but still actively maintained module"},
    "8": {"name": "rare-drush-command", "desc": "Rare or underused Drush command"},
    "9": {"name": "rare-ddev-command", "desc": "Rare or underused DDEV command"},
    "10": {"name": "composer-trick", "desc": "Rare Composer command or config trick"},
    "11": {"name": "useful-composer-package", "desc": "Useful Composer package for Drupal and PHP development and automation"},
    "12": {"name": "drupal-vs-cms", "desc": "Drupal vs another CMS/tool comparison"},
    "13": {"name": "code-example", "desc": "Interesting Drupal code example"},
    "14": {"name": "upcoming-event", "desc": "Upcoming Drupal event"},
    "15": {"name": "hot-issue", "desc": "Hot or important open Drupal.org issue"},
    "16": {"name": "release-cycle", "desc": "Drupal release cycle or supported version fact"},
    "17": {"name": "github-cli-tool", "desc": "GitHub/CLI tool for Drupal/PHP/JS/Twig/testing"},
    "18": {"name": "llm-prompt-idea", "desc": "Useful LLM prompt or skill idea for Drupal"},
    "19": {"name": "git-drupalcode-api", "desc": "Programmatic use of git.drupalcode.org API"},
    "20": {"name": "online-resource", "desc": "Tip from online resource"},
    "21": {"name": "docs-needs-improvement", "desc": "Drupal.org documentation page needing improvement"},
    "22": {"name": "web-tip", "desc": "Recent Drupal tip from web search"},
    "23": {"name": "ide-tip", "desc": "Recent PHPStorm or VSCode tip for Drupal"},
    "24": {"name": "call-to-action", "desc": "Call to action for Drupal.org"},
    "25": {"name": "ascii-banner", "desc": "Drupal terminal ASCII banner"},
    "26": {"name": "wikipedia-fact", "desc": "Drupal fact from Wikipedia", "urls": ["https://en.wikipedia.org/wiki/Drupal"]},
    "27": {"name": "case-study", "desc": "Nice Drupal showcase/case study from the list here. Do not return any code", "urls": ["https://new.drupal.org/case-studies"], "sub_paths": ["/case-study/"]},
    "28": {"name": "drupal-hook", "desc": "Interesting Drupal 10+ hook from API"},
    "29": {"name": "poem", "desc": "Short poem for Drupal CMS"},
    "30": {"name": "rephrased-quote", "desc": "Famous quote rephrased for Drupal"},
    "31": {"name": "community-quote", "desc": "Drupal community quote or slogan"},
    "32": {"name": "concept-explanation", "desc": "Drupal concept explained simply"},
    "33": {"name": "git-stats", "desc": "Drupal core git commit stats"},
    "34": {"name": "core-bash-commands", "desc": "Drupal core bash commands for testing/linting"},
    "35": {"name": "core-service", "desc": "Lesser-known core service"},
    "36": {"name": "performance-setting", "desc": "Core parameter affecting performance"},
    "37": {"name": "twig-debugging", "desc": "Twig debugging or theming trick"},
    "38": {"name": "anti-pattern", "desc": "Common anti-pattern and correction"},
    "39": {"name": "micro-optimization", "desc": "Micro-optimization tip for render/entities"},
    "40": {"name": "plugin-type", "desc": "Explanation of a core plugin type"},
    "41": {"name": "eventsubscriber", "desc": "EventSubscriber replacing legacy hooks"},
    "42": {"name": "cache-api", "desc": "Cache API nuance with example"},
    "43": {"name": "entity-api-edge", "desc": "Entity API edge case"},
    "44": {"name": "field-api", "desc": "Field API trick"},
    "45": {"name": "routing-nuance", "desc": "Routing system nuance"},
    "46": {"name": "access-control", "desc": "Access control pattern"},
    "47": {"name": "form-api-advanced", "desc": "Form API advanced pattern"},
    "48": {"name": "config-api", "desc": "Configuration API caveat"},
    "49": {"name": "di-best-practice", "desc": "Dependency injection best practice"},
    "50": {"name": "coding-standard", "desc": "Drupal coding standard rule often violated"},
    "51": {"name": "phpunit-pattern", "desc": "PHPUnit testing pattern specific to Drupal"},
    "52": {"name": "drush-internals", "desc": "Drush internals tip"},
    "53": {"name": "multilingual", "desc": "Common multilingual mistake"},
    "54": {"name": "render-pipeline", "desc": "Render pipeline explanation"},
    "55": {"name": "security-best-practice", "desc": "Security-related best practice"},
    "56": {"name": "content-moderation", "desc": "Content moderation/workflows internals"},
    "57": {"name": "queue-api", "desc": "Queue API usage example"},
    "58": {"name": "batch-api", "desc": "Batch API usage pattern"},
    "59": {"name": "plugin-discovery", "desc": "Plugin discovery mechanism"},
    "60": {"name": "derivative-plugins", "desc": "Derivative plugins example"},
    "61": {"name": "lazy-builders", "desc": "Lazy builders and placeholders"},
    "62": {"name": "bigpipe", "desc": "BigPipe or progressive rendering"},
    "63": {"name": "cache-invalidation", "desc": "Cache invalidation with tags"},
    "64": {"name": "config-schema", "desc": "Config Schema importance"},
    "65": {"name": "typed-data", "desc": "Typed Data API explanation"},
    "66": {"name": "service-decoration", "desc": "Service decoration example"},
    "67": {"name": "module-weight", "desc": "Module weight and hook execution order"},
    "68": {"name": "cron-internals", "desc": "Cron system internals"},
    "69": {"name": "stream-wrappers", "desc": "File and stream wrapper system"},
    "70": {"name": "node-access", "desc": "Node access hooks vs entity access handlers"},
    "71": {"name": "symfony-internals", "desc": "Symfony components inside Drupal"},
    "72": {"name": "views-performance", "desc": "Views performance pitfall"},
    "73": {"name": "request-lifecycle", "desc": "Request to response lifecycle"},
    "74": {"name": "entity-query", "desc": "Entity query vs direct DB query"},
    "75": {"name": "config-import-export", "desc": "Config import/export vs runtime overrides"},
    "76": {"name": "subrequest-handling", "desc": "Subrequest handling and render context"},
    "77": {"name": "library-api", "desc": "Library API and asset attachment"},
    "78": {"name": "csrf-protection", "desc": "CSRF protection in forms and routes"},
    "79": {"name": "mysql", "desc": "MySQL specific queries, best practices and performance tips"},
    "80": {"name": "logging-system", "desc": "Internal logging system usage"},
    "81": {"name": "jokes", "desc": "A short joke using Drupal terminology"},
    "82": {"name": "drupal-11-features", "desc": "New features in Drupal 11"},
    "83": {"name": "php85", "desc": "New features in PHP 8.5"},
    "84": {"name": "general-best-practices", "desc": "Drupal best pracices", "urls": ["https://raw.githubusercontent.com/theodorosploumis/drupal-best-practices/refs/heads/master/README.md"]},
    "85": {"name": "rare-devel-command", "desc": "Rare and interesting devel module drush commands"},
    "86": {"name": "drupalorg-cli", "desc": "Rare and interesting commands and usages of drupalorg cli", "urls": ["https://github.com/mglaman/drupalorg-cli"]},
    "87": {"name": "robo-cli", "desc": "Rare and interesting commands and usages of robo cli", "urls": ["https://robo.li"]},
    "88": {"name": "song", "desc": "Rephrase a famous song versus for Drupal"},
    "89": {"name": "webform-module", "desc": "Interesting tips and usages of the webform module and its submodules"},
    "90": {"name": "xdebug-xhprof", "desc": "Interesting tips, code examples, cli commands and IDE plugins for xdebug and xhprof with PHP"}
  }
}