Skip to content

[Linter, Doc] improve linter documentation #1775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 23, 2025

Conversation

EagleoutIce
Copy link
Member

No description provided.

@EagleoutIce EagleoutIce linked an issue Jun 21, 2025 that may be closed by this pull request
4 tasks
@EagleoutIce EagleoutIce requested a review from Copilot June 23, 2025 08:20
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves the linter documentation by adding new auto‐generated markdown pages and refactoring the documentation generation scripts. Key changes include:

  • Adding new wiki pages for lint rules (unused definitions, file-path validity, deprecated functions, absolute paths).
  • Replacing deprecated getTypesFromFolderAsMermaid with getTypesFromFolder (with updated parameter naming) in multiple documentation modules.
  • Refining code in documentation utilities for improved readability and link accuracy.

Reviewed Changes

Copilot reviewed 18 out of 19 changed files in this pull request and generated no comments.

Show a summary per file
File Description
wiki/linter-rules/unused-definitions.md Auto‐generated documentation for the unused definitions lint rule.
wiki/linter-rules/file-path-validity.md Auto‐generated documentation for the file-path validity lint rule.
wiki/linter-rules/deprecated-functions.md Auto‐generated documentation for the deprecated functions lint rule.
wiki/linter-rules/absolute-file-paths.md Auto‐generated documentation for the absolute file paths lint rule.
src/documentation/print-search-wiki.ts Updated import from deprecated function to new utility.
src/documentation/print-query-wiki.ts Updated usage of getTypesFromFolder and adjusted type property naming.
src/documentation/print-normalized-ast-wiki.ts Switched to new getTypesFromFolder import and updated code block parameter.
src/documentation/print-linting-and-testing-wiki.ts Refactored import to align with new function naming.
src/documentation/print-linter-wiki.ts Updated rule registration to use new parameters and refactored link generation.
src/documentation/print-linter-issue.ts Updated import to use getTypesFromFolder.
src/documentation/print-interface-wiki.ts Updated import for a consistent linking format.
src/documentation/print-engines-wiki.ts Updated import to reflect new utility naming.
src/documentation/print-dataflow-graph-wiki.ts Adjusted type usages and updated mermaid diagram referencing.
src/documentation/print-core-wiki.ts Updated getTypesFromFolder usage for code sample generation.
src/documentation/print-cfg-wiki.ts Replaced deprecated import and adjusted inline type handling.
src/documentation/doc-util/doc-types.ts Refactored overloads and short-link generation for improved clarity.
src/documentation/doc-util/doc-print.ts Newly added utility for writing docs to the wiki.
src/documentation/doc-util/doc-code.ts Minor update to the codeBlock function signature.
Comments suppressed due to low confidence (2)

wiki/linter-rules/unused-definitions.md:1

  • The auto-generated header URL contains a double slash ('//') in the path. Consider sanitizing the URL path during generation to prevent potential inconsistencies.
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-06-22, 19:40:16 UTC presenting an overview of flowR's linter (v2.2.15, using R v4.5.0). Please do not edit this file/wiki page directly._

src/documentation/doc-util/doc-code.ts:4

  • [nitpick] Since the function now requires 'code' to be a string, consider removing the optional chaining (i.e., 'code?.trim()') in favor of directly calling 'code.trim()' for clarity.
export function codeBlock(language: string, code: string): string {

@EagleoutIce EagleoutIce merged commit 3e229ff into main Jun 23, 2025
19 checks passed
@EagleoutIce EagleoutIce deleted the 1774-linter-doc-inmprove-linter-documentation branch June 23, 2025 11:58
@EagleoutIce
Copy link
Member Author

This pull request is included in v2.2.16 (see Release v2.2.16 (Local Config, Fixes, New Linter Rules)).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Linter, Doc] Improve Linter Documentation
1 participant