Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,8 @@ dependencies:
- analyze:analyze
```

3. Create your Analyzer plugin class that extends `AnalyzePluginBase`. At minimum, you must:
3. Create your Analyzer plugin class that extends `AnalyzePluginBase`.
At minimum, you must:
- Implement the `@Analyze` annotation
- Override the `renderSummary()` method
- Override the `renderFullReport()` method if you want a detailed view
Expand Down Expand Up @@ -179,7 +180,8 @@ final class MyAnalyzer extends AnalyzePluginBase {
- `access()` - Set permission requirements
- `extraSummaryLinks()` - Add additional links to the summary page

See the `analyze_plugin_example` module in the codebase for a complete working example.
See the `analyze_plugin_example` module in the codebase for a complete
working example.

### Community Documentation

Expand Down
22 changes: 22 additions & 0 deletions phpcs.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?xml version="1.0"?>
<ruleset name="Module">
<description>Drupal 11 coding standards for module.</description>
<file>.</file>
<arg name="extensions" value="php,module,inc,install,test,profile,theme,info,txt,md,yml"/>
<config name="drupal_core_version" value="11"/>

<exclude-pattern>*/.git/*</exclude-pattern>
<exclude-pattern>*/config/*</exclude-pattern>
<exclude-pattern>*/css/*</exclude-pattern>
<exclude-pattern>*/js/*</exclude-pattern>
<exclude-pattern>*/node_modules/*</exclude-pattern>
<exclude-pattern>*/vendor/*</exclude-pattern>
<exclude-pattern>*/.github/*</exclude-pattern>

<rule ref="Drupal">
<!-- Drupal.org packages add info keys automatically -->
<exclude name="Drupal.InfoFiles.AutoAddedKeys"/>
</rule>

<rule ref="DrupalPractice"/>
</ruleset>