Index

A B G I L S
All Classes and Interfaces|All Packages

A

app.spellscroll - package app.spellscroll

app.spellscroll.task - package app.spellscroll.task

apply(Project) - Method in class app.spellscroll.SpellscrollGradlePlugin

Applies the plugin to the given Project.

B

buildUi() - Method in class app.spellscroll.task.SpellscrollBuildUiTask

Runs npm install and npm run build in the UI module directory.

G

generate() - Method in class app.spellscroll.task.GenerateBuildConfigTask

Generates the {PluginName}Constants.java source file.

GenerateBuildConfigTask - Class in app.spellscroll.task

Gradle task that generates a Java constants class containing plugin metadata.

GenerateBuildConfigTask() - Constructor for class app.spellscroll.task.GenerateBuildConfigTask

getApiVersion() - Method in class app.spellscroll.SpellscrollGradleExtension

Required. Version of spellscroll-api to compile against (e.g.

getBuildFile() - Method in class app.spellscroll.task.GenerateBuildConfigTask

The project's build.gradle file, declared as an input so the task reruns whenever the build script changes.

getBuildLibsDir() - Method in class app.spellscroll.task.SpellscrollDevTask

Absolute path to the Gradle build/libs directory, passed to Spellscroll via --plugindir.

getIgnoreDefaultPluginsDir() - Method in class app.spellscroll.SpellscrollGradleExtension

When true, passes --ignore-default-plugins-dir to the Spellscroll process on launch, preventing Spellscroll from loading plugins from its default directory.

getIgnoreDefaultPluginsDir() - Method in class app.spellscroll.task.SpellscrollDevTask

When true, appends --ignore-default-plugins-dir to the Spellscroll command, preventing it from loading plugins from its default directory.

getOutputDir() - Method in class app.spellscroll.task.GenerateBuildConfigTask

The directory into which the generated .java file is written.

getOutputDir() - Method in class app.spellscroll.task.SpellscrollBuildUiTask

The directory into which npm places its build output.

getPluginId() - Method in class app.spellscroll.SpellscrollGradleExtension

Required. The plugin identifier (registered at Spellscroll.app under "Developer Tools") This identifier is always an all-lowercase alphanumeric only string.

getPluginId() - Method in class app.spellscroll.task.GenerateBuildConfigTask

The plugin identifier (registered at Spellscroll.app under "Developer Tools") This identifier is always an all-lowercase alphanumeric only string.

getPluginId() - Method in class app.spellscroll.task.SpellscrollDevTask

The plugin identifier passed to Spellscroll via --dev-plugin.

getPluginName() - Method in class app.spellscroll.SpellscrollGradleExtension

Required. Human-readable plugin name (e.g.

getPluginName() - Method in class app.spellscroll.task.GenerateBuildConfigTask

Human-readable plugin name (e.g.

getPluginName() - Method in class app.spellscroll.task.SpellscrollInitUiTask

Human-readable plugin name used to derive the React component name and the npm package name in package.json.

getPluginVersion() - Method in class app.spellscroll.SpellscrollGradleExtension

Plugin version string embedded in the generated constants class as PLUGIN_VERSION.

getPluginVersion() - Method in class app.spellscroll.task.GenerateBuildConfigTask

Plugin version string (e.g.

getProjectGroup() - Method in class app.spellscroll.task.GenerateBuildConfigTask

Gradle project.group value used to derive the package name of the generated class.

getSpellscrollInstallDir() - Method in class app.spellscroll.SpellscrollGradleExtension

Path to the Spellscroll installation directory.

getSpellscrollInstallDir() - Method in class app.spellscroll.task.SpellscrollDevTask

Path to the Spellscroll installation directory.

getUiModuleDir() - Method in class app.spellscroll.SpellscrollGradleExtension

Path to the UI module npm project directory.

getUiModuleDir() - Method in class app.spellscroll.task.SpellscrollBuildUiTask

Path to the UI module npm project directory (i.e.

getUiModuleDir() - Method in class app.spellscroll.task.SpellscrollInitUiTask

Path to the directory where the UI module will be scaffolded.

I

initUi() - Method in class app.spellscroll.task.SpellscrollInitUiTask

Entry point: fetches the latest @spellscroll/ui-sdk version, then writes the three scaffold files into getUiModuleDir().

L

launch() - Method in class app.spellscroll.task.SpellscrollDevTask

Resolves the Spellscroll executable, builds the launch command, and starts the process.

S

SpellscrollBuildUiTask - Class in app.spellscroll.task

Gradle task that builds the Spellscroll UI module using npm.

SpellscrollBuildUiTask() - Constructor for class app.spellscroll.task.SpellscrollBuildUiTask

SpellscrollDevTask - Class in app.spellscroll.task

Gradle task that launches the Spellscroll application with the plugin loaded in dev mode.

SpellscrollDevTask() - Constructor for class app.spellscroll.task.SpellscrollDevTask

SpellscrollGradleExtension - Class in app.spellscroll

DSL extension that exposes the spellscroll {} configuration block.

SpellscrollGradleExtension() - Constructor for class app.spellscroll.SpellscrollGradleExtension

SpellscrollGradlePlugin - Class in app.spellscroll

Main entry point for the Spellscroll Gradle plugin (app.spellscroll.dev).

SpellscrollGradlePlugin() - Constructor for class app.spellscroll.SpellscrollGradlePlugin

SpellscrollInitUiTask - Class in app.spellscroll.task

Gradle task that scaffolds a new Spellscroll UI module at the configured directory.

SpellscrollInitUiTask() - Constructor for class app.spellscroll.task.SpellscrollInitUiTask

A B G I L S
All Classes and Interfaces|All Packages