Skip to content

liferay/liferay-portal / .claude/skills/pr-check

pr-check

Verified

Check that a PR is ready to be sent for review.

FileKindSize
SKILL.mdskill md36.5 KB
find_modules.shexecutablescript1.4 KB
references/testing.mdmarkdown5.4 KB
select_paths.shexecutablescript2.2 KB
select_validations.shexecutablescript1.1 KB
validations/branch/bean-param-util-getter.mdmarkdown6.6 KB
validations/branch/bnd-content.mdmarkdown15.2 KB
validations/branch/bnd-dsannotations-options.mdmarkdown9.1 KB
validations/branch/cache-field-usage.mdmarkdown13.9 KB
validations/branch/concurrent-mapper-hash-map-usage.mdmarkdown7.5 KB
validations/branch/html-escaping.mdmarkdown2.6 KB
validations/branch/pr-reviewer.mdmarkdown6.6 KB
validations/branch/redundant-assert-message.mdmarkdown13.5 KB
validations/branch/required-configuration-policy.mdmarkdown7.9 KB
validations/branch/service-holder-usage.mdmarkdown8.3 KB
validations/branch/service-registration.mdmarkdown3.7 KB
validations/branch/source-format.mdmarkdown4.1 KB
validations/branch/startup-sync-usage.mdmarkdown10.6 KB
validations/branch/transaction-usage.mdmarkdown4.0 KB
validations/branch/unused-project-dependencies.mdmarkdown18.5 KB
validations/portal/baseline.mdmarkdown14.0 KB
validations/portal/cross-module-compile.mdmarkdown7.9 KB
validations/portal/full-portal-build.mdmarkdown1.4 KB
validations/portal/go-generate.mdmarkdown2.8 KB
validations/portal/go-source-format.mdmarkdown1.9 KB
validations/portal/helm-unit-test-order.mdmarkdown1.4 KB
validations/portal/instance-wrapper-build.mdmarkdown656 B
validations/portal/java-unit-test.mdmarkdown6.7 KB
validations/portal/javascript-unit-test.mdmarkdown7.7 KB
validations/portal/module-registration.mdmarkdown7.8 KB
validations/portal/per-module-compile.mdmarkdown10.4 KB
validations/portal/portlet-title.mdmarkdown1.1 KB
validations/portal/poshi-syntax.mdmarkdown336 B
validations/portal/pql-validation.mdmarkdown516 B
validations/portal/rest-builder.mdmarkdown938 B
validations/portal/service-builder.mdmarkdown1.6 KB
validations/portal/structural-smoke.mdmarkdown3.9 KB
validations/portal/theme-build.mdmarkdown2.0 KB
validations/workspaces/generated-file.mdmarkdown2.5 KB
validations/workspaces/source-format.mdmarkdown2.0 KB
validations/workspaces/workspace-compile.mdmarkdown1.8 KB
validations/workspaces/workspace-java-unit-test.mdmarkdown1.7 KB
validations/workspaces/workspace-javascript-unit-test.mdmarkdown1.9 KB

validations/branch/service-registration.md

View on GitHub
# Service Registration

Catches registration defects that compile cleanly and surface only on a deployed portal. Add a scan here only when a wrong registration is provable from the tree alone, with no build and no false positives to dismiss.

## Match

`\.java$`

## Command

Use `command grep` for any working tree scan, so it is filtered by the system grep rather than the shell's `grep` wrapper, which some environments route to another tool with its own defaults.

Take the changed Java files:

```bash
bash "${SKILL_DIR}/select_paths.sh" "${MERGE_BASE}" "${VALIDATION_FILE}"
```

### Selection

Run each scan whose inputs the diff touches:

| Diff Touches | Scan |
| --- | --- |
| Any changed `.java` file | Unsatisfied Reference |
| A `*ResourceImpl.java` under a REST Builder `resource/v<major>_<minor>` package | Redeclared Interface |

### Unsatisfied Reference

`@Component(service = {})` registers under no service type, so an `@Reference` whose field type is such a class can never be satisfied and the referencing component never activates.

Collect the risky class names from the diff:

- A changed `.java` file declaring `@Component` with `service = {}`. Its class name is the file name.

- A field the diff adds, declared `<visibility> <Type> _<name>;`, where `*/<Type>.java` declares `@Component` with `service = {}`.

An empty collection ends the scan.

List every `@Reference` in the build root of the file each class came from, and keep those whose declared field type is exactly a collected class, never a substring match. A workspace compiles against released artifacts rather than this source, so a class from the rest of the repository cannot be referenced from a workspace, and a class from a workspace can be referenced only inside that workspace. For a class from the rest of the repository:

```bash
(cd "${REPO_ROOT}" && git grep --after-context=30 --fixed-strings '@Reference' -- ':/*.java' ':(exclude,glob)workspaces/*-workspace/**')
```

For a class from a workspace, with `<workspace>` as its directory under `workspaces`:

```bash
(cd "${REPO_ROOT}" && git grep --after-context=30 --fixed-strings '@Reference' -- ':(glob)workspaces/<workspace>/**/*.java')
```

`git grep` searches from the current directory down, so run it from `${REPO_ROOT}` or the sweep silently narrows to a subtree.

Take the field declaration that follows each annotation rather than a fixed offset from it; an annotation carrying `policy`, `policyOption`, or `target` pushes its declaration down the window.

Report each hit as the unsatisfiable class with the file and field referencing it.

### Redeclared Interface

REST Builder generates `Base<Tag>ResourceImpl` with the interfaces the resource needs and scaffolds `<Tag>ResourceImpl` to extend it. Redeclaring one of them on the subclass changes how the service is registered.

For each changed `*ResourceImpl.java` in scope:

1. Skip it when the class name starts with `Base`, or when the file carries `@generated`.

1. Read its `implements` clause and that of `Base<ClassName>.java` in the same directory. Skip the file when no such base is there. Take the whole class declaration, from `public class` or `public abstract class` through the opening brace.

1. Compare raw type names, stripping type arguments.

Report any interface present in both, naming the class, the interface, and the base.

### Verdict

FAIL when any scan reports a finding, naming the scan alongside what it found. PASS when every scan prints nothing. Never take the verdict from an exit status: `grep` exits 1 precisely when it matches nothing.

## Checklist

Add one subitem per selected scan:

```
- [ ] <scan name>
```

## Time Estimate

~10-30 sec, mostly the `@Reference` sweep across the build root.
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 323kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 323kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 323kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 323kUpdated Claude CodeCodexVerifiedInstall