- src/project/plugins/file-plugins/flowr-analyzer-description-file-plugin
- FlowrAnalyzerDescriptionFilePlugin
Class FlowrAnalyzerDescriptionFilePlugin
Hierarchy (View Summary)
- FlowrAnalyzerFilePlugin
- FlowrAnalyzerDescriptionFilePlugin
Hierarchy-Diagram
Index
Constructors
Properties
Methods
Constructors
constructor
Creates a new instance of the DESCRIPTION file plugin.
Parameters
- filePattern: RegExp = DescriptionFilePattern
The pattern to identify DESCRIPTION files, see DescriptionFilePattern for the default pattern.
Returns FlowrAnalyzerDescriptionFilePlugin
- filePattern: RegExp = DescriptionFilePattern
Properties
Readonlydescription
description: "Reads DESCRIPTION files into key-value pairs." = 'Reads DESCRIPTION files into key-value pairs.'
A short description of what the plugin does.
Readonlyname
name: "flowr-analyzer-description-file-plugin" = 'flowr-analyzer-description-file-plugin'
A unique, human-readable name of the plugin.
Readonlytype
The type of the plugin, determining when and for what purpose it is applied during the analysis.
Readonlyversion
version: SemVer = ...
The version of the plugin, ideally following semver.
Methods
Staticdefault
Returns a default/dummy implementation to be used when no plugin of this type is registered or triggered.
Returns FlowrAnalyzerFilePlugin
applies
Determine whether this plugin applies to the given file.
Parameters
- file: PathLike
Returns boolean
process
Parameters
- _ctx: FlowrAnalyzerContext
- file: FlowrFileProvider
Returns FlowrDescriptionFile
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]
Settings
Member Visibility
On This Page
Constructors
Properties
- src
- util
- collections
- mermaid
- simple-df
- text
- parallel.ts
- assert.ts
- diff.ts
- diff-graph.ts
- files.ts
- glob.ts
- hash.ts
- html-hover-over.ts
- json.ts
- log.ts
- logic.ts
- numbers.ts
- objects.ts
- os.ts
- prefix.ts
- proc.ts
- quads.ts
- r-author.ts
- r-base-packages.ts
- r-license.ts
- r-regex.ts
- r-value.ts
- r-version.ts
- random.ts
- range.ts
- record.ts
- schema.ts
- slice-direction.ts
- summarizer.ts
- version.ts
- abstract-interpretation
- data-frame
- domains
- absint-visitor.ts
- unsupported-functions.ts
- benchmark
- stats
- summarizer
- first-phase
- second-phase
- data.ts
- summarizer.ts
- slicer.ts
- stopwatch.ts
- cli
- common
- repl
- commands
- parser
- server
- core.ts
- execute.ts
- ghost-hint.ts
- path-input.ts
- print-version.ts
- prompt.ts
- script-core
- benchmark-app.ts
- benchmark-helper-app.ts
- export-quads-app.ts
- flowr.ts
- flowr-main-options.ts
- run-script.ts
- slicer-app.ts
- summarizer-app.ts
- wiki.ts
- control-flow
- core
- steps
- all
- core
- static-slicing
- pipeline
- create-pipeline.ts
- default-pipelines.ts
- createDataflowPipeline
- createNormalizePipeline
- createParsePipeline
- createSlicePipeline
- DEFAULT_DATAFLOW_PIPELINE
- DEFAULT_NORMALIZE_PIPELINE
- DEFAULT_PARSE_PIPELINE
- DEFAULT_SLICE_AND_RECONSTRUCT_PIPELINE
- DEFAULT_SLICE_WITHOUT_RECONSTRUCT_PIPELINE
- DEFAULT_SLICING_PIPELINE
- TREE_SITTER_DATAFLOW_PIPELINE
- TREE_SITTER_NORMALIZE_PIPELINE
- TREE_SITTER_PARSE_PIPELINE
- TREE_SITTER_SLICE_AND_RECONSTRUCT_PIPELINE
- TREE_SITTER_SLICE_WITHOUT_RECONSTRUCT_PIPELINE
- TREE_SITTER_SLICING_PIPELINE
- invalid-pipeline-error.ts
- pipeline.ts
- pipeline-step.ts
- all
- pipeline-executor.ts
- data
- dataflow
- environments
- eval
- resolve
- values
- intervals
- logical
- scalar
- sets
- string
- vectors
- general.ts
- r-value.ts
- fn
- graph
- call-graph.ts
- dataflowgraph-builder.ts
- df-helper.ts
- diff-dataflow-graph.ts
- edge.ts
- graph.ts
- graph-helper.ts
- quads.ts
- unknown-replacement.ts
- unknown-side-effect.ts
- vertex.ts
- <internal>
- DataflowGraphVertexArgument
- DataflowGraphVertexAstLink
- DataflowGraphVertexFunctionCall
- DataflowGraphVertexFunctionDefinition
- DataflowGraphVertexInfo
- DataflowGraphVertexUse
- DataflowGraphVertexValue
- DataflowGraphVertexVariableDefinition
- DataflowGraphVertices
- FunctionOriginInformation
- isFunctionCallVertex
- isFunctionDefinitionVertex
- isUseVertex
- isValueVertex
- isVariableDefinitionVertex
- ValidVertexTypeReverse
- ValidVertexTypes
- VertexType
- instrument
- internal
- process
- functions
- call
- argument
- built-in
- built-in-access.ts
- built-in-apply.ts
- built-in-assignment.ts
- built-in-attach.ts
- built-in-envir-utils.ts
- built-in-eval.ts
- built-in-expression-list.ts
- built-in-for-loop.ts
- built-in-function-definition.ts
- built-in-get.ts
- built-in-if-then-else.ts
- built-in-library.ts
- built-in-list.ts
- built-in-load.ts
- built-in-local.ts
- built-in-namespace-access.ts
- built-in-new-env.ts
- built-in-pipe.ts
- built-in-purrr-formula.ts
- built-in-quote.ts
- built-in-recall.ts
- built-in-register-hook.ts
- built-in-repeat-loop.ts
- built-in-replacement.ts
- built-in-rm.ts
- built-in-s-seven-dispatch.ts
- built-in-s-seven-new-generic.ts
- built-in-s-three-dispatch.ts
- built-in-source.ts
- built-in-special-bin-op.ts
- built-in-stack-env.ts
- built-in-stop-if-not.ts
- built-in-try-catch.ts
- built-in-vector.ts
- built-in-while-loop.ts
- built-in-with.ts
- transitive-side-effects.ts
- common.ts
- default-call-handling.ts
- known-call-handling.ts
- named-call-handling.ts
- unnamed-call-handling.ts
- process-argument.ts
- process-parameter.ts
- call
- process-named-call.ts
- process-symbol.ts
- process-uninteresting-leaf.ts
- process-value.ts
- functions
- linker.ts
- process
- origin
- cluster.ts
- extractor.ts
- hooks.ts
- info.ts
- addNonDefaultExitPoints
- alwaysExits
- ControlDependency
- DataflowCfgInformation
- DataflowInformation
- DataflowInformation
- diffControlDependencies
- diffControlDependency
- doesExitPointPropagateCalls
- ExitPoint
- ExitPointType
- filterOutLoopExitPoints
- happensInEveryBranch
- happensInEveryBranchSet
- KillReference
- negateControlDependency
- overwriteExitPoints
- logger.ts
- processor.ts
- documentation
- data
- dfg
- faq
- interface
- query
- server
- doc-util
- doc-auto-gen.ts
- doc-benchmarks.ts
- doc-cfg.ts
- doc-cli-option.ts
- doc-code.ts
- doc-dfg.ts
- doc-docker.ts
- doc-env.ts
- doc-escape.ts
- doc-files.ts
- doc-functions.ts
- doc-general.ts
- doc-issue.ts
- doc-normalized-ast.ts
- doc-query.ts
- doc-repl.ts
- doc-search.ts
- doc-server-message.ts
- doc-structure.ts
- doc-types.ts
- dropGenericsFromTypeName
- FnElementInfo
- getDocumentationForType
- GetDocumentationForTypeFilters
- getStartLineOfTypeScriptNode
- getTypePathLink
- GetTypesAsMermaidOption
- getTypeScriptSourceFiles
- getTypesFromFolder
- MermaidClassDiagramArguments
- mermaidHide
- printCodeOfElement
- printCodeOfFile
- printHierarchy
- PrintHierarchyArguments
- removeCommentSymbolsFromTypeScriptComment
- shortLink
- shortLinkFile
- TypeElementInSource
- TypeElementKind
- TypeReport
- visualizeMermaidClassDiagram
- wiki-mk
- doc-capabilities.ts
- doc-readme.ts
- issue-linting-rule.ts
- wiki-absint.ts
- wiki-analyzer.ts
- wiki-cfg.ts
- wiki-core.ts
- wiki-create-linting-rules.ts
- wiki-dataflow-graph.ts
- wiki-engine.ts
- wiki-faq.ts
- wiki-interface.ts
- wiki-linter.ts
- wiki-linting-and-testing.ts
- wiki-normalized-ast.ts
- wiki-onboarding.ts
- wiki-overview.ts
- wiki-query.ts
- wiki-search.ts
- wiki-setup.ts
- wiki-signature-database.ts
- data
- linter
- rules
- absolute-path.ts
- dataframe-access-validation.ts
- dead-code.ts
- deprecated-functions.ts
- file-path-validity.ts
- function-finder-util.ts
- naming-convention.ts
- network-functions.ts
- no-leaked-credentials.ts
- problematic-inputs.ts
- roxygen-arguments.ts
- seeded-randomness.ts
- software-has-license.ts
- software-has-tests.ts
- stop-with-call-arg.ts
- syntactically-valid.ts
- undefined-symbol.ts
- undefined-symbol-util.ts
- unused-definition.ts
- useless-loop.ts
- linter-executor.ts
- linter-format.ts
- linter-output.ts
- linter-rules.ts
- linter-tags.ts
- rules
- project
- cache
- context
- abstract-flowr-analyzer-context.ts
- classify-project-kind.ts
- flowr-analyzer-context.ts
- flowr-analyzer-dependencies-context.ts
- flowr-analyzer-environment-context.ts
- flowr-analyzer-files-context.ts
- flowr-analyzer-functions-context.ts
- flowr-analyzer-gas-context.ts
- flowr-analyzer-loading-order-context.ts
- flowr-analyzer-meta-context.ts
- flowr-file.ts
- project-kind.ts
- plugins
- file-plugins
- files
- notebooks
- flowr-analyzer-description-file-plugin.ts
- flowr-analyzer-file-plugin.ts
- flowr-analyzer-inst-file-plugin.ts
- flowr-analyzer-license-file-plugin.ts
- flowr-analyzer-namespace-files-plugin.ts
- flowr-analyzer-news-file-plugin.ts
- flowr-analyzer-rda-file-plugin.ts
- flowr-analyzer-rprofile-file-plugin.ts
- flowr-analyzer-rproject-file-plugin.ts
- flowr-analyzer-test-file-plugin.ts
- flowr-analyzer-vignette-file-plugin.ts
- flowr-analyzer-virtualenv-file-plugin.ts
- gas-plugins
- loading-order-plugins
- package-version-plugins
- flowr-analyzer-meta-description-file-plugin.ts
- flowr-analyzer-meta-rproject-file-plugin.ts
- flowr-analyzer-package-versions-description-file-plugin.ts
- flowr-analyzer-package-versions-lockfile-plugin.ts
- flowr-analyzer-package-versions-namespace-file-plugin.ts
- flowr-analyzer-package-versions-plugin.ts
- flowr-analyzer-package-versions-session-info-plugin.ts
- flowr-analyzer-package-versions-sigdb-plugin.ts
- package.ts
- project-discovery
- flowr-analyzer-plugin.ts
- plugin-registry.ts
- file-plugins
- sigdb
- build.ts
- codec.ts
- decode.ts
- decompress.ts
- hash.ts
- index-format.ts
- manifest.ts
- reader.ts
- <internal>
- AvailableVersion
- availableVersionEntries
- getSharedSigSource
- getSharedSigSourceSync
- MergedSignatureSource
- OpenSyncFromOptions
- OpenSyncOptions
- PackageSignatureSource
- readSignatureDb
- ShardStatus
- ShardVerifyResult
- SigDatabase
- SigDatabaseSet
- SigDbOpenOptions
- SigDbSetOpenOptions
- SigDbVerifyReport
- sourceForPackage
- VerifyOptions
- verifyShardedDatabase
- schema.ts
- DefaultCranBase
- DepType
- DepTypeNames
- FnProp
- FnPropNames
- LibraryExports
- MaxDefaultLength
- ParamFlag
- PkgBlob
- PkgBlobTuple
- Sig
- SigDb
- SigDbContent
- SigDbExt
- SigDbFeatures
- SigDbMagic
- SigDbPkgMeta
- SigDbSchema
- SigDbShard
- SigDbTier
- SigDefinitionLocation
- SigDep
- SigDependencyInfo
- SigFn
- SigFunctionInfo
- SigParam
- SigParamInfo
- SigVersionInfo
- sigdb-download.ts
- sigdb-version.ts
- signature-match.ts
- cfg-kind.ts
- dependency-version-space.ts
- <internal>
- ArcEntry
- assignmentsOf
- collectTransitiveConstraints
- collectUsage
- ConstraintObserver
- ConstraintSource
- CountFactor
- countRunnableCombinations
- dateCutoff
- DefaultExplodeLimit
- DefaultFixpointIterations
- defaultTargets
- DerivedConstraint
- enforceArcConsistency
- explodeDependencyVersions
- FnResolver
- intersectSurvivors
- isoDay
- iterateToFixpoint
- NoDisabledSources
- OrderedCandidates
- orderedCandidatesOf
- PackageUsage
- survivingEntries
- SurvivingEntries
- TimelineEntry
- timelinePackageKey
- TransitiveConstraint
- VersionAssignment
- VersionExplodeOptions
- versionMeetsPartners
- flowr-analyzer.ts
- flowr-analyzer-builder.ts
- queries
- catalog
- absint-query
- call-context-query
- call-graph-query
- cluster-query
- config-query
- control-flow-query
- dataflow-lens-query
- dataflow-query
- dependencies-query
- dice-query
- does-call-query
- files-query
- guess-dep-versions-query
- happens-before-query
- id-map-query
- input-sources-query
- inspect-exceptions-query
- inspect-higher-order-query
- inspect-recursion-query
- linter-query
- location-map-query
- normalized-ast-query
- origin-query
- project-query
- provenance-query
- resolve-value-query
- search-query
- signature-query
- static-slice-query
- slice-query-options.ts
- virtual-query
- base-query-format.ts
- query.ts
- AnyQuerySchema
- CompoundQuerySchema
- executeQueries
- executeQueriesOfSameType
- genericWrapReplFailIfNoRequest
- ParsedQueryLine
- Queries
- QueriesSchema
- Query
- QueryArgumentsWithType
- QueryExecutor
- QueryResult
- QueryResults
- QueryResultsWithoutMeta
- queryWikiPage
- SupportedQueries
- SupportedQueriesSchema
- SupportedQuery
- SupportedQueryTypes
- VirtualQuerySchema
- query-print.ts
- two-layer-collector.ts
- catalog
- r-bridge
- data
- lang-4.x
- ast
- model
- nodes
- info
- r-access.ts
- r-argument.ts
- r-binary-op.ts
- r-break.ts
- r-comment.ts
- r-expression-list.ts
- r-for-loop.ts
- r-function-call.ts
- r-function-definition.ts
- r-if-then-else.ts
- r-line-directive.ts
- r-logical.ts
- r-next.ts
- r-number.ts
- r-parameter.ts
- r-pipe.ts
- r-project.ts
- r-repeat-loop.ts
- r-string.ts
- r-symbol.ts
- r-unary-op.ts
- r-while-loop.ts
- processing
- model.ts
- operators.ts
- type.ts
- versions.ts
- nodes
- parser
- json
- main
- internal
- control
- expression
- functions
- loops
- operators
- other
- structure
- values
- normalize-access.ts
- normalize-meta.ts
- normalizer-data.ts
- internal
- model
- tree-sitter
- convert-values.ts
- ast
- roxygen2
- documentation-provider.ts
- roxygen-ast.ts
- <internal>
- isKnownRoxygenText
- KnownRoxygenTags
- RoxygenBlock
- RoxygenCrossrefTag
- RoxygenDatasetDocumentationTag
- RoxygenDocType
- RoxygenFormattingTag
- RoxygenFunctionDocumentationTag
- RoxygenNamespaceTag
- RoxygenOtherTag
- RoxygenReusingDocumentationTag
- RoxygenTag
- RoxygenTagAlias
- RoxygenTagAuthor
- RoxygenTagBackref
- RoxygenTagBase
- RoxygenTagConcept
- RoxygenTagDescribeIn
- RoxygenTagDescription
- RoxygenTagDetails
- RoxygenTagEval
- RoxygenTagEvalNamespace
- RoxygenTagEvalRd
- RoxygenTagExample
- RoxygenTagExamples
- RoxygenTagExamplesIf
- RoxygenTagExport
- RoxygenTagExportClass
- RoxygenTagExportMethod
- RoxygenTagExportPattern
- RoxygenTagExportS3Method
- RoxygenTagFamily
- RoxygenTagField
- RoxygenTagFormat
- RoxygenTagImport
- RoxygenTagImportClassesFrom
- RoxygenTagImportFrom
- RoxygenTagImportMethodsFrom
- RoxygenTagIncludeRmd
- RoxygenTagInherit
- RoxygenTagInheritDotParams
- RoxygenTagInheritParams
- RoxygenTagInheritSection
- RoxygenTagKeywords
- RoxygenTagMarkdown
- RoxygenTagMethod
- RoxygenTagName
- RoxygenTagNoMarkdown
- RoxygenTagNoRd
- RoxygenTagOrder
- RoxygenTagParam
- RoxygenTagRawNamespace
- RoxygenTagRawRd
- RoxygenTagRdName
- RoxygenTagReferences
- RoxygenTagReturn
- RoxygenTagSection
- RoxygenTagSeeAlso
- RoxygenTagSlot
- RoxygenTagSource
- RoxygenTagTemplate
- RoxygenTagTemplateVar
- RoxygenTagText
- RoxygenTagTitle
- RoxygenTagUsage
- RoxygenTagUseDynLib
- RoxygenUnknownTag
- roxygen-parse.ts
- init.ts
- parser.ts
- retriever.ts
- shell.ts
- shell-executor.ts
- reconstruct
- search
- search-executor
- search-enrichers.ts
- CallTargetsContent
- CfgInformationArguments
- CfgInformationElementContent
- CfgInformationSearchContent
- enrichElement
- Enrichment
- enrichmentContent
- EnrichmentData
- EnrichmentElementArguments
- EnrichmentElementContent
- Enrichments
- EnrichmentSearchArguments
- EnrichmentSearchContent
- LastCallContent
- QueryDataElementContent
- QueryDataSearchContent
- RoxygenElementContent
- search-generators.ts
- search-mappers.ts
- search-transformer.ts
- search-enrichers.ts
- search-optimizer
- flowr-search.ts
- flowr-search-builder.ts
- flowr-search-executor.ts
- flowr-search-filters.ts
- flowr-search-printer.ts
- flowr-search-traverse.ts
- search-executor
- slicing
- config.ts
- ConfigPlugin
- DefaultAssumedRVersion
- DropPathsOption
- EngineConfig
- FlowrConfig
- FlowrConfig
- FlowrDefaultPlugins
- FlowrLaxSourcingOptions
- globalConfigFilePath
- InferWorkingDirectory
- isSigDbEnabled
- KnownEngines
- persistSigDbPathToGlobalConfig
- resolveAssumedRVersion
- RShellEngineConfig
- SpecializeConfigEntry
- TreeSitterEngineConfig
- ValidFlowrConfigPaths
- VariableResolve
- VersionSelection
- engines.ts
- gas.ts
- util
- test
- functionality
- _helper
- controlflow
- dataflow
- ast-builder.ts
- guess-dep-versions.ts
- label.ts
- linter.ts
- log.ts
- net.ts
- network.ts
- pointer-analysis.ts
- provider.ts
- query.ts
- r-path.ts
- repl.ts
- search.ts
- shell.ts
- <internal>
- assertAst
- assertDataflow
- assertDecoratedAst
- assertDiced
- assertOutput
- assertReconstructed
- assertSliced
- assertSlicedF
- defaultTestConfiguration
- DiceTestExpect
- mapProblematicNodesToIds
- retrieveNormalizedAst
- sameForSteps
- skipTestBecauseConfigNotMet
- TestCaseFailType
- TestConfiguration
- TestConfigurationWithOutput
- testWithShell
- withShell
- withTreeSitter
- sigdb.ts
- _helper
- functionality
This plugin provides support for R
DESCRIPTIONfiles.