##// END OF EJS Templates
implab » gradle-common
RSS
refactor: replace configureAssembly with configureTask
refactor: replace configureAssembly with configureTask
cin - - Load All Authors

File last commit:

r31:414a5d71eaa5 default
r37:3be316021669 default
Show More
variant-sources-plugin.md
155 lines | 4.2 KiB | text/x-minidsrc | MarkdownLexer
/ common / variant-sources-plugin.md
History | Source | Raw |Copy content |Copy permalink
cin
implemented variants model, variants-sources adapter
 r26 # Variant Sources Plugin
## NAME
`VariantsSourcesPlugin` и extension `variantSources`.
## SYNOPSIS
```groovy
plugins {
id 'org.implab.gradle-variants-sources'
}
variants {
layer('main')
variant('browser') {
role('main') { layers('main') }
}
variant('node') {
role('main') { layers('main') }
}
}
variantSources {
bind('main').sourceSetNamePattern = '{layer}'
bind('main') {
configureSourceSet {
declareOutputs('compiled')
}
}
whenRegistered { sourceSetName() }
whenBound('browser') { roleName() }
}
```
## DESCRIPTION
`VariantsSourcesPlugin` применяет `VariantsPlugin` и `SourcesPlugin`, затем
cin
Variants mutation guard after finalize
 r27 регистрирует source sets из модели `variants`.
cin
implemented variants model, variants-sources adapter
 r26
cin
Variants mutation guard after finalize
 r27 Точка запуска registration:
cin
implemented variants model, variants-sources adapter
 r26
- `variants.whenFinalized(model -> registerSourceSets(...))`
cin
Variants mutation guard after finalize
 r27 ### registration
cin
implemented variants model, variants-sources adapter
 r26
Для каждой usage-связки `variant/role/layer` вычисляется имя source set,
регистрируется `GenericSourceSet` (если он еще не существует), затем
вызываются callbacks.
### binding
`bind('<layer>')` возвращает `BuildLayerBinding` и задает policy для этого
слоя:
- как именовать source set;
- как конфигурировать source set;
- какие callbacks вызвать на registration/binding.
### sourceSetNamePattern
cin
Variants mutation guard after finalize
 r27 `sourceSetNamePattern` определяет naming policy зарегистрированного source set.
cin
implemented variants model, variants-sources adapter
 r26
Default:
- `{variant}{layerCap}`
Tokens:
- `{variant}`, `{variantCap}`
- `{role}`, `{roleCap}`
- `{layer}`, `{layerCap}`
Имя санитизируется (`[^A-Za-z0-9_.-] -> _`).
Ограничение:
- один `sourceSetName` не может быть порожден разными слоями.
## EVENTS
### whenRegistered
- callback на новый уникальный source set;
- replayable;
- при shared source set срабатывает один раз.
### whenBound
- callback на каждую usage-связку `variant/role/layer`;
- replayable;
- подходит для per-usage логики.
### variant filter
cin
separated SourceSetRegistration, SourceSetUsageBinding
 r31 Фильтр по варианту поддерживает только usage-binding:
cin
implemented variants model, variants-sources adapter
 r26
- `whenBound(String variantName, ...)`
cin
separated SourceSetRegistration, SourceSetUsageBinding
 r31 ## PAYLOAD TYPES
`SourceSetRegistration` содержит:
cin
implemented variants model, variants-sources adapter
 r26
cin
separated SourceSetRegistration, SourceSetUsageBinding
 r31 - `layerName`, `sourceSetName`;
- `sourceSet` (`NamedDomainObjectProvider<GenericSourceSet>`).
Sugar:
- `configureSourceSet(Action|Closure)`.
`SourceSetUsageBinding` содержит:
cin
implemented variants model, variants-sources adapter
 r26
- `variantName`, `roleName`, `layerName`, `sourceSetName`;
- `sourceSet` (`NamedDomainObjectProvider<GenericSourceSet>`).
Sugar:
- `configureSourceSet(Action|Closure)`.
## API
### VariantSourcesExtension
- `bind(String)` — получить/создать binding по имени слоя.
- `bind(String, Action|Closure)` — сконфигурировать binding.
- `bindings(Action|Closure)` — контейнерная конфигурация bindings.
- `whenRegistered(...)` — глобальные callbacks регистрации source set.
- `whenBound(...)` — глобальные callbacks usage-binding.
cin
separated SourceSetRegistration, SourceSetUsageBinding
 r31 - `whenBound(String variantName, ...)` — usage-binding callbacks с variant-filter.
cin
implemented variants model, variants-sources adapter
 r26
### BuildLayerBinding
- `sourceSetNamePattern` — naming policy для source set слоя.
- `configureSourceSet(...)` — слойная конфигурация `GenericSourceSet`.
- `whenRegistered(...)` — callbacks регистрации в рамках слоя.
- `whenBound(...)` — callbacks usage-binding в рамках слоя.
## KEY CLASSES
- `VariantsSourcesPlugin` — точка входа plugin adapter.
- `VariantSourcesExtension` — глобальный DSL bind/events.
- `BuildLayerBinding` — layer-local policy и callbacks.
cin
separated SourceSetRegistration, SourceSetUsageBinding
 r31 - `SourceSetRegistration` — payload регистрации source set.
- `SourceSetUsageBinding` — payload usage-binding.
cin
implemented variants model, variants-sources adapter
 r26
## NOTES
cin
Variants mutation guard after finalize
 r27 - `sourceSetNamePattern` фиксируется при первом чтении в registration
cin
implemented variants model, variants-sources adapter
 r26 (`finalizeValueOnRead`).
- Closure callbacks используют delegate-first.
- Для вложенных closure лучше явный параметр (`ctx -> ...`).