Skip to content

docs: document isExtend FQN contract #753

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tangcent merged 1 commit into from
Aug 24, 2026
Merged

docs: document isExtend FQN contract #753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 1 addition & 3 deletions src/main/kotlin/com/itangcent/easyapi/core/export/EndpointBuilder.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ import com.intellij.openapi.components.service
import com.intellij.openapi.project.Project
import com.intellij.psi.PsiClass
import com.intellij.psi.PsiMethod
import com.itangcent.easyapi.core.export.ApiHeader
import com.itangcent.easyapi.core.export.ApiParameter
import com.itangcent.easyapi.core.psi.PsiClassHelper
import com.itangcent.easyapi.core.psi.helper.DocHelper
import com.itangcent.easyapi.core.psi.helper.DocMetadataResolver
Expand Down Expand Up @@ -110,7 +108,7 @@ class EndpointBuilder(private val project: Project) {
*
* The `method.return.main` rule specifies a field name within the response type where
* the `@return` doc comment should be placed. For example, with `Result<T>`:
* - Rule: `method.return.main[groovy:it.returnType().isExtend("Result")]=data`
* - Rule: `method.return.main[groovy:it.returnType().isExtend("com.example.Result")]=data`
* - `@return "processed result"` is attached to the `data` field instead of the root
*
* If no explicit rule is set and `settings.inferReturnMain` is true, auto-detects
Expand Down
15 changes: 15 additions & 0 deletions src/main/kotlin/com/itangcent/easyapi/core/rule/context/ScriptPsiContexts.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@ interface ClassContext {
fun fields(): Array<ScriptPsiFieldContext>
fun fieldCnt(): Int
fun type(): ScriptTypeContext

/**
* Checks whether this class is, or inherits from, [superClass].
*
* @param superClass the **fully qualified name** of the base class or
* interface, e.g. `"java.lang.Exception"`. A simple name like
* `"Exception"` never matches.
*/
fun isExtend(superClass: String): Boolean
fun isMap(): Boolean
fun isCollection(): Boolean
Expand Down Expand Up @@ -651,6 +659,13 @@ class ScriptTypeContext(private val context: RuleContext, private val resolvedTy

override fun toString(): String = resolvedType.qualifiedName()

/**
* Checks whether this type is, or inherits from, [superClass].
*
* @param superClass the **fully qualified name** of the base class or
* interface, e.g. `"java.lang.Exception"`. A simple name like
* `"Exception"` never matches.
*/
fun isExtend(superClass: String): Boolean = when (resolvedType) {
is ResolvedType.ClassType -> InheritanceHelper.isInheritor(resolvedType.psiClass, superClass)
else -> false
Expand Down
Loading