FlowrAnalyzerNamespaceFilesPlugin | @eagleoutice/flowr

Constructors

constructor

new FlowrAnalyzerNamespaceFilesPlugin(
filePattern?: RegExp,
): FlowrAnalyzerNamespaceFilesPlugin
Creates a new instance of the NAMESPACE file plugin.
Parameters
- filePattern: RegExp = NamespaceFilePattern
  The pattern to identify NAMESPACE files, see NamespaceFilePattern for the default pattern.
Returns FlowrAnalyzerNamespaceFilesPlugin
Overrides FlowrAnalyzerFilePlugin.constructor
- Defined in src/project/plugins/file-plugins/flowr-analyzer-namespace-files-plugin.ts:25

Properties

`Readonly`description

description: "This plugin provides support for NAMESPACE files and extracts their content into the NAMESPACEFormat." = 'This plugin provides support for NAMESPACE files and extracts their content into the NAMESPACEFormat.'

A short description of what the plugin does.

`Readonly`name

name: "flowr-analyzer-namespace-file-plugin" = 'flowr-analyzer-namespace-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-namespace-files-plugin.ts:30

process

process(ctx: FlowrAnalyzerContext, file: FlowrFileProvider): FlowrNamespaceFile
Parameters
- ctx: FlowrAnalyzerContext
- file: FlowrFileProvider
Returns FlowrNamespaceFile
Overrides FlowrAnalyzerFilePlugin.process
- Defined in src/project/plugins/file-plugins/flowr-analyzer-namespace-files-plugin.ts:34

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:103

Class FlowrAnalyzerNamespaceFilesPlugin

Hierarchy (View Summary)

Hierarchy-Diagram

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowrAnalyzerNamespaceFilesPlugin

Properties

`Readonly`description

`Readonly`name

`Readonly`type

`Readonly`version

Methods

`Static`defaultPlugin

Returns FlowrAnalyzerFilePlugin

applies

Parameters

Returns boolean

process

Parameters

Returns FlowrNamespaceFile

processor

Parameters

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

Settings

On This Page

Class FlowrAnalyzerNamespaceFilesPlugin

Hierarchy (View Summary)

Hierarchy-Diagram

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowrAnalyzerNamespaceFilesPlugin

Properties

Readonlydescription

Readonlyname

Readonlytype

Readonlyversion

Methods

StaticdefaultPlugin

Returns FlowrAnalyzerFilePlugin

applies

Parameters

Returns boolean

process

Parameters

Returns FlowrNamespaceFile

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]