Class FlowrAnalyzerRdMacroFilePlugin

Support for a package's man/macros/ (installed: help/macros/) files, whose \newcommands rdIndexOf expands before reading pages.

Hierarchy (View Summary)

FlowrAnalyzerRdFileBasePlugin<FlowrRdMacroFile>
- FlowrAnalyzerRdMacroFilePlugin

Index

Constructors

constructor

new FlowrAnalyzerRdMacroFilePlugin(
filePattern?: RegExp,
): FlowrAnalyzerRdMacroFilePlugin
Parameters
- filePattern: RegExp = RdMacroFilePattern
Returns FlowrAnalyzerRdMacroFilePlugin
Overrides FlowrAnalyzerRdFileBasePlugin.constructor
- Defined in src/project/plugins/file-plugins/flowr-analyzer-rd-file-plugin.ts:75

Properties

`Readonly`description

description: "Reads the \\newcommand definitions of man/macros/ files." = 'Reads the \\newcommand definitions of man/macros/ files.'

A short description of what the plugin does.

`Readonly`name

name: "flowr-analyzer-rd-macro-file-plugin" = 'flowr-analyzer-rd-macro-file-plugin'

A unique, human-readable name of the plugin.

`Protected` `Readonly`pattern

pattern: RegExp

`Readonly`type

type: FileLoad = PluginType.FileLoad

The type of the plugin, determining when and for what purpose it is applied during the analysis.

`Readonly`version

version: SemVer = ...

The version of the plugin, ideally following semver.

Methods

`Static`defaultPlugin

defaultPlugin(): FlowrAnalyzerFilePlugin
Returns a default/dummy implementation to be used when no plugin of this type is registered or triggered.

Returns FlowrAnalyzerFilePlugin
Inherited from FlowrAnalyzerRdFileBasePlugin.defaultPlugin
- Defined in src/project/plugins/file-plugins/flowr-analyzer-file-plugin.ts:30

applies

applies(file: PathLike): boolean
Determine whether this plugin applies to the given file.
Parameters
- file: PathLike
Returns boolean
Overrides FlowrAnalyzerRdFileBasePlugin.applies
- Defined in src/project/plugins/file-plugins/flowr-analyzer-rd-file-plugin.ts:79

`Protected` `Readonly`lift

lift(file: FlowrFileProvider): FlowrRdMacroFile
Parameters
- file: FlowrFileProvider
Returns FlowrRdMacroFile
Overrides FlowrAnalyzerRdFileBasePlugin.lift
- Defined in src/project/plugins/file-plugins/flowr-analyzer-rd-file-plugin.ts:83

process

process(_ctx: FlowrAnalyzerContext, file: FlowrFileProvider): FlowrRdMacroFile
Parameters
- _ctx: FlowrAnalyzerContext
- file: FlowrFileProvider
Returns FlowrRdMacroFile
Inherited from FlowrAnalyzerRdFileBasePlugin.process
- Defined in src/project/plugins/file-plugins/flowr-analyzer-rd-file-plugin.ts:37

processor

processor(
    context: FlowrAnalyzerContext,
    args: FlowrFileProvider,
):
    | FlowrFileProvider<{ toString(): string }>
    | [file: FlowrFileProvider<{ toString(): string }>, cont: boolean]
Run the plugin with the given context and arguments.
Parameters
- context: FlowrAnalyzerContext
- args: FlowrFileProvider
Returns
| FlowrFileProvider<{ toString(): string }>
| [file: FlowrFileProvider<{ toString(): string }>, cont: boolean]
Inherited from FlowrAnalyzerRdFileBasePlugin.processor
- Defined in src/project/plugins/flowr-analyzer-plugin.ts:110

Class FlowrAnalyzerRdMacroFilePlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowrAnalyzerRdMacroFilePlugin

Properties

`Readonly`description

`Readonly`name

`Protected` `Readonly`pattern

`Readonly`type

`Readonly`version

Methods

`Static`defaultPlugin

Returns FlowrAnalyzerFilePlugin

applies

Parameters

Returns boolean

`Protected` `Readonly`lift

Parameters

Returns FlowrRdMacroFile

process

Parameters

Returns FlowrRdMacroFile

processor

Parameters

Returns
| FlowrFileProvider<{ toString(): string }>
| [file: FlowrFileProvider<{ toString(): string }>, cont: boolean]

Settings

On This Page

Class FlowrAnalyzerRdMacroFilePlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowrAnalyzerRdMacroFilePlugin

Properties

Readonlydescription

Readonlyname

Protected Readonlypattern

Readonlytype

Readonlyversion

Methods

StaticdefaultPlugin

Returns FlowrAnalyzerFilePlugin

applies

Parameters

Returns boolean

Protected Readonlylift

Parameters

Returns FlowrRdMacroFile

process

Parameters

Returns FlowrRdMacroFile

processor

Parameters

Returns | FlowrFileProvider<{ toString(): string }> | [file: FlowrFileProvider<{ toString(): string }>, cont: boolean]

Settings

On This Page

`Readonly`description

`Readonly`name

`Protected` `Readonly`pattern

`Readonly`type

`Readonly`version

`Static`defaultPlugin

`Protected` `Readonly`lift

Returns
| FlowrFileProvider<{ toString(): string }>
| [file: FlowrFileProvider<{ toString(): string }>, cont: boolean]