Class FlowrAnalyzerRprofileFilePlugin

Marks R startup files: profiles (.Rprofile, Rprofile.site) are R source, so they get FileRole.Startup and FileRole.Source; environment files (.Renviron, Renviron.site) hold KEY=value definitions rather than R code, so they only get FileRole.Environment. The FlowrAnalyzerLoadingOrderRprofilePlugin moves the profile files to the front of the loading order.

Hierarchy (View Summary)

FlowrAnalyzerFilePlugin
- FlowrAnalyzerRprofileFilePlugin

Index

Constructors

constructor

new FlowrAnalyzerRprofileFilePlugin(
profilePattern?: RegExp,
environPattern?: RegExp,
): FlowrAnalyzerRprofileFilePlugin
Parameters
- profilePattern: RegExp = RprofileFilePattern
- environPattern: RegExp = RenvironFilePattern
Returns FlowrAnalyzerRprofileFilePlugin
Overrides FlowrAnalyzerFilePlugin.constructor
- Defined in src/project/plugins/file-plugins/flowr-analyzer-rprofile-file-plugin.ts:27

Properties

`Readonly`description

description: "Marks R startup files (.Rprofile, Rprofile.site, .Renviron, Renviron.site)." = 'Marks R startup files (.Rprofile, Rprofile.site, .Renviron, Renviron.site).'

A short description of what the plugin does.

`Readonly`name

name: "flowr-analyzer-rprofile-file-plugin" = 'flowr-analyzer-rprofile-file-plugin'

A unique, human-readable name of the plugin.

`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 FlowrAnalyzerFilePlugin.defaultPlugin
- Defined in src/project/plugins/file-plugins/flowr-analyzer-file-plugin.ts:29

applies

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

process

process(
_ctx: FlowrAnalyzerContext,
file: FlowrFileProvider,
): [FlowrFileProvider<{ toString(): string }>, true]
Parameters
- _ctx: FlowrAnalyzerContext
- file: FlowrFileProvider
Returns [FlowrFileProvider<{ toString(): string }>, true]
Overrides FlowrAnalyzerFilePlugin.process
- Defined in src/project/plugins/file-plugins/flowr-analyzer-rprofile-file-plugin.ts:38

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

Class FlowrAnalyzerRprofileFilePlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowrAnalyzerRprofileFilePlugin

Properties

`Readonly`description

`Readonly`name

`Readonly`type

`Readonly`version

Methods

`Static`defaultPlugin

Returns FlowrAnalyzerFilePlugin

applies

Parameters

Returns boolean

process

Parameters

Returns [FlowrFileProvider<{ toString(): string }>, true]

processor

Parameters

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

Settings

On This Page

Class FlowrAnalyzerRprofileFilePlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowrAnalyzerRprofileFilePlugin

Properties

Readonlydescription

Readonlyname

Readonlytype

Readonlyversion

Methods

StaticdefaultPlugin

Returns FlowrAnalyzerFilePlugin

applies

Parameters

Returns boolean

process

Parameters

Returns [FlowrFileProvider<{ toString(): string }>, true]

processor

Parameters

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

Settings

On This Page

`Readonly`description

`Readonly`name

`Readonly`type

`Readonly`version

`Static`defaultPlugin

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