Class FlowrAnalyzerRMarkdownFilePlugin`Abstract`

Common base of the plugins reading an R Markdown flavor, which differ only in the files they claim.

Hierarchy (View Summary)

FlowrAnalyzerPatternFilePlugin
- FlowrAnalyzerRMarkdownFilePlugin
  - FlowrAnalyzerQmdFilePlugin
  - FlowrAnalyzerRmdFilePlugin

Index

Constructors

constructor

new FlowrAnalyzerRMarkdownFilePlugin(
pattern: RegExp,
part?: (p: string) => string,
): FlowrAnalyzerRMarkdownFilePlugin
Parameters
- pattern: RegExp
  The pattern to identify the files of this plugin, see the respective subclass for its default.
- part: (p: string) => string = PathPart.Basename
  The part of the path the pattern is matched against.
Returns FlowrAnalyzerRMarkdownFilePlugin
Inherited from FlowrAnalyzerPatternFilePlugin.constructor
- Defined in src/project/plugins/file-plugins/flowr-analyzer-file-plugin.ts:75

Properties

`Abstract` `Readonly`description

description: string

A short description of what the plugin does.

`Abstract` `Readonly`name

name: string

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 FlowrAnalyzerPatternFilePlugin.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 FlowrAnalyzerPatternFilePlugin.applies
- Defined in src/project/plugins/file-plugins/flowr-analyzer-file-plugin.ts:81

`Protected`process

process(
ctx: FlowrAnalyzerContext,
arg: FlowrFileProvider<string>,
): FlowrRMarkdownFile
Parameters
- ctx: FlowrAnalyzerContext
- arg: FlowrFileProvider<string>
Returns FlowrRMarkdownFile
Overrides FlowrAnalyzerPatternFilePlugin.process
- Defined in src/project/plugins/file-plugins/notebooks/flowr-analyzer-rmarkdown-file-plugin.ts:13

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 FlowrAnalyzerPatternFilePlugin.processor
- Defined in src/project/plugins/flowr-analyzer-plugin.ts:110

Class FlowrAnalyzerRMarkdownFilePlugin`Abstract`

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowrAnalyzerRMarkdownFilePlugin

Properties

`Abstract` `Readonly`description

`Abstract` `Readonly`name

`Protected` `Readonly`pattern

`Readonly`type

`Readonly`version

Methods

`Static`defaultPlugin

Returns FlowrAnalyzerFilePlugin

applies

Parameters

Returns boolean

`Protected`process

Parameters

Returns FlowrRMarkdownFile

processor

Parameters

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

Settings

On This Page

Class FlowrAnalyzerRMarkdownFilePluginAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowrAnalyzerRMarkdownFilePlugin

Properties

Abstract Readonlydescription

Abstract Readonlyname

Protected Readonlypattern

Readonlytype

Readonlyversion

Methods

StaticdefaultPlugin

Returns FlowrAnalyzerFilePlugin

applies

Parameters

Returns boolean

Protectedprocess

Parameters

Returns FlowrRMarkdownFile

processor

Parameters

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

Settings

On This Page

Class FlowrAnalyzerRMarkdownFilePlugin`Abstract`

`Abstract` `Readonly`description

`Abstract` `Readonly`name

`Protected` `Readonly`pattern

`Readonly`type

`Readonly`version

`Static`defaultPlugin

`Protected`process

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