Class FlowrAnalyzerRdMetaFilePlugin

Support for the Meta/Rd.rds help table an installed package serializes, states what the man/ sources do -- topic, aliases, keywords, title.

Hierarchy (View Summary)

FlowrAnalyzerRdFileBasePlugin<FlowrRdMetaFile>
- FlowrAnalyzerRdMetaFilePlugin

Index

Constructors

constructor

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

Properties

`Readonly`description

description: "Reads an installed package's Meta/Rd.rds help table." = 'Reads an installed package\'s Meta/Rd.rds help table.'

A short description of what the plugin does.

`Readonly`name

name: "flowr-analyzer-rd-meta-file-plugin" = 'flowr-analyzer-rd-meta-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
Inherited from FlowrAnalyzerRdFileBasePlugin.applies
- Defined in src/project/plugins/file-plugins/flowr-analyzer-file-plugin.ts:81

`Protected` `Readonly`lift

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

process

process(_ctx: FlowrAnalyzerContext, file: FlowrFileProvider): FlowrRdMetaFile
Parameters
- _ctx: FlowrAnalyzerContext
- file: FlowrFileProvider
Returns FlowrRdMetaFile
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 FlowrAnalyzerRdMetaFilePlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowrAnalyzerRdMetaFilePlugin

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 FlowrRdMetaFile

process

Parameters

Returns FlowrRdMetaFile

processor

Parameters

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

Settings

On This Page

Class FlowrAnalyzerRdMetaFilePlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowrAnalyzerRdMetaFilePlugin

Properties

Readonlydescription

Readonlyname

Protected Readonlypattern

Readonlytype

Readonlyversion

Methods

StaticdefaultPlugin

Returns FlowrAnalyzerFilePlugin

applies

Parameters

Returns boolean

Protected Readonlylift

Parameters

Returns FlowrRdMetaFile

process

Parameters

Returns FlowrRdMetaFile

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]