@eagleoutice/flowr - v2.17.4
    Preparing search index...
    PACKAGE_STRUCTURE: {
        createSearch: () => FlowrSearchBuilder<
            "from",
            [],
            ParentInformation,
            FlowrSearchElements<ParentInformation, (...)[]>,
        >;
        info: {
            certainty: BestEffort;
            defaultConfig: () => {
                builtPackage: false;
                checkBashisms: false;
                checkFutureTimestamps: true;
                checkTopLevel: true;
                cranKnownHidden: (...)[];
                cranPack: true;
                docDirsNotInstalled: (...)[];
                hiddenAllowed: (...)[];
                leftoverExtensions: (...)[];
                maxInstalledSizeMb: number;
                maxPathLength: number;
                maxPdfBytes: number;
                reservedInstDirs: (...)[];
                standardTopLevel: (...)[];
            };
            description: "Finds problems in the package files: portable names, hidden files, top-level files, subdirectories, permissions, executables, timestamps, sizes, line endings of scripts, and vignette leftovers.";
            name: "Package Structure";
            tags: readonly [CmdCheck];
        };
        prettyPrint: {
            full: (
                r: {
                    loc: readonly [(...), (...), (...), (...), (...)];
                    message: string;
                },
                metadata: unknown,
            ) => string;
            query: (
                r: {
                    loc: readonly [(...), (...), (...), (...), (...)];
                    message: string;
                },
                metadata: unknown,
            ) => string;
        };
        processSearchResult: (
            _elements: unknown,
            config: PackageStructureConfig,
            data: ReadonlyFlowrAnalysisProvider,
        ) =>
            | PromiseLike<{ ".meta": ...; results: ... }>
            | { ".meta": { inspectedEntries: ...; onDisk: ... }; results: (...)[] };
    } = ...

    Port of the file and directory structure checks of R CMD check (portable names, hidden and top-level files, subdirectories, permissions, sizes, vignettes).

    Type Declaration

    • ReadonlycreateSearch: () => FlowrSearchBuilder<
          "from",
          [],
          ParentInformation,
          FlowrSearchElements<ParentInformation, (...)[]>,
      >
    • Readonlyinfo: {
          certainty: BestEffort;
          defaultConfig: () => {
              builtPackage: false;
              checkBashisms: false;
              checkFutureTimestamps: true;
              checkTopLevel: true;
              cranKnownHidden: (...)[];
              cranPack: true;
              docDirsNotInstalled: (...)[];
              hiddenAllowed: (...)[];
              leftoverExtensions: (...)[];
              maxInstalledSizeMb: number;
              maxPathLength: number;
              maxPdfBytes: number;
              reservedInstDirs: (...)[];
              standardTopLevel: (...)[];
          };
          description: "Finds problems in the package files: portable names, hidden files, top-level files, subdirectories, permissions, executables, timestamps, sizes, line endings of scripts, and vignette leftovers.";
          name: "Package Structure";
          tags: readonly [CmdCheck];
      }
    • ReadonlyprettyPrint: {
          full: (
              r: {
                  loc: readonly [(...), (...), (...), (...), (...)];
                  message: string;
              },
              metadata: unknown,
          ) => string;
          query: (
              r: {
                  loc: readonly [(...), (...), (...), (...), (...)];
                  message: string;
              },
              metadata: unknown,
          ) => string;
      }
    • ReadonlyprocessSearchResult: (
          _elements: unknown,
          config: PackageStructureConfig,
          data: ReadonlyFlowrAnalysisProvider,
      ) =>
          | PromiseLike<{ ".meta": ...; results: ... }>
          | { ".meta": { inspectedEntries: ...; onDisk: ... }; results: (...)[] }