@eagleoutice/flowr - v2.16.3
    Preparing search index...
    DESCRIPTION_METADATA: {
        createSearch: () => FlowrSearchBuilder<
            "from",
            [],
            ParentInformation,
            FlowrSearchElements<ParentInformation, (...)[]>,
        >;
        info: {
            certainty: BestEffort;
            defaultConfig: () => {
                cranIncoming: true;
                maxDepends: number;
                maxImports: number;
            };
            description: "Finds problems in the DESCRIPTION: required fields, package name, version, maintainer, dependency fields, license, Authors@R, encoding, and the Title and Description style CRAN asks for.";
            name: "Description Metadata";
            tags: readonly [CmdCheck];
        };
        prettyPrint: {
            full: (
                r: {
                    loc: [
                        startLine: ...,
                        startColumn: ...,
                        endLine: ...,
                        endColumn: ...,
                        f?: ...,
                    ];
                    message: string;
                },
            ) => string;
            query: (
                r: {
                    loc: [
                        startLine: ...,
                        startColumn: ...,
                        endLine: ...,
                        endColumn: ...,
                        f?: ...,
                    ];
                    message: string;
                },
            ) => string;
        };
        processSearchResult: (
            _elements: FlowrSearchElements<
                ParentInformation,
                FlowrSearchElement<(...)>[],
            >,
            config: DescriptionMetadataConfig,
            data: ReadonlyFlowrAnalysisProvider<KnownParser>,
        ) =>
            | { ".meta": { hasDescription: ... }; results: (...)[] }
            | { ".meta": { hasDescription: ... }; results: (...)[] };
    } = ...

    Port of the DESCRIPTION checks of R CMD check (meta-information, dependency fields, license, Authors@R, and the --as-cran style checks), located at the field's lines.

    Type Declaration

    • ReadonlycreateSearch: () => FlowrSearchBuilder<
          "from",
          [],
          ParentInformation,
          FlowrSearchElements<ParentInformation, (...)[]>,
      >
    • Readonlyinfo: {
          certainty: BestEffort;
          defaultConfig: () => {
              cranIncoming: true;
              maxDepends: number;
              maxImports: number;
          };
          description: "Finds problems in the DESCRIPTION: required fields, package name, version, maintainer, dependency fields, license, Authors@R, encoding, and the Title and Description style CRAN asks for.";
          name: "Description Metadata";
          tags: readonly [CmdCheck];
      }
    • ReadonlyprettyPrint: {
          full: (
              r: {
                  loc: [
                      startLine: ...,
                      startColumn: ...,
                      endLine: ...,
                      endColumn: ...,
                      f?: ...,
                  ];
                  message: string;
              },
          ) => string;
          query: (
              r: {
                  loc: [
                      startLine: ...,
                      startColumn: ...,
                      endLine: ...,
                      endColumn: ...,
                      f?: ...,
                  ];
                  message: string;
              },
          ) => string;
      }
    • ReadonlyprocessSearchResult: (
          _elements: FlowrSearchElements<
              ParentInformation,
              FlowrSearchElement<(...)>[],
          >,
          config: DescriptionMetadataConfig,
          data: ReadonlyFlowrAnalysisProvider<KnownParser>,
      ) =>
          | { ".meta": { hasDescription: ... }; results: (...)[] }
          | { ".meta": { hasDescription: ... }; results: (...)[] }