fortitude-lint 0.8.0__tar.gz → 0.8.0rc1__tar.gz

{fortitude_lint-0.8.0 → fortitude_lint-0.8.0rc1}/Cargo.lock

@@ -712,7 +712,7 @@ dependencies = [
 
 [[package]]
 name = "fortitude"
-version = "0.8.0"
+version = "0.8.0-rc.1"
 dependencies = [
  "anyhow",
  "assert_cmd",

{fortitude_lint-0.8.0 → fortitude_lint-0.8.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fortitude-lint
-Version: 0.8.0
+Version: 0.8.0rc1
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -276,7 +276,7 @@ Fortitude can be integrated into text editors and IDEs that support the
 Language Server Protocol (LSP), providing real-time diagnostics and
 code actions for applying fixes as you work.
 
-Please see the [documentation](https://fortitude.readthedocs.io/en/stable/editors/) for
+Please see the [documentation](fortitude.readthedocs.io/en/stable/editors) for
 details on setting this up for your editor.
 
 A VSCode plugin is in development, and will be released shortly.
@@ -298,43 +298,6 @@ This also includes instructions for building the project from source, running
 tests, and linting/formatting the code. Please consult our [code of
 conduct](CODE_OF_CONDUCT.md) before contributing.
 
-## Projects Using Fortitude
-
-More and more open-source Fortran projects are using Fortitude to help maintain
-their code, including:
-
-- [ADCIRC](https://github.com/adcirc/adcirc)
-- [cp2k](https://github.com/cp2k/cp2k)
-- [flexi](https://github.com/flexi-framework/flexi)
-- [FTorch](https://github.com/Cambridge-ICCS/FTorch)
-- [MESA](https://github.com/MESAHub/mesa)
-- [OpenFMS](https://github.com/ispg-group/openfms)
-- [The Met Office](https://github.com/MetOffice/growss/tree/main/fortran-lint)
-
-### Show Your Support
-
-If you've found Fortitude useful in your project, please consider adding the
-Fortitude badge to your `README.md`:
-
-```md
-[![Fortitude](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/PlasmaFAIR/fortitude/main/docs/assets/badge/v0.json)](https://github.com/PlasmaFAIR/fortitude)
-```
-
-or `README.rst`:
-
-```rst
-.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/PlasmaFAIR/fortitude/main/docs/assets/badge/v0.json
-    :target: https://github.com/PlasmaFAIR/fortitude
-    :alt: Fortitude
-```
-
-or, as HTML:
-
-```html
-<a href="https://github.com/PlasmaFAIR/fortitude"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/PlasmaFAIR/fortitude/main/docs/assets/badge/v0.json" alt="Fortitude" style="max-width:100%;"></a>
-```
-
-
 ## License
 
 This work is distributed under the MIT License. See [`LICENSE`](LICENSE) for more

{fortitude_lint-0.8.0 → fortitude_lint-0.8.0rc1}/README.md

@@ -255,7 +255,7 @@ Fortitude can be integrated into text editors and IDEs that support the
 Language Server Protocol (LSP), providing real-time diagnostics and
 code actions for applying fixes as you work.
 
-Please see the [documentation](https://fortitude.readthedocs.io/en/stable/editors/) for
+Please see the [documentation](fortitude.readthedocs.io/en/stable/editors) for
 details on setting this up for your editor.
 
 A VSCode plugin is in development, and will be released shortly.
@@ -277,43 +277,6 @@ This also includes instructions for building the project from source, running
 tests, and linting/formatting the code. Please consult our [code of
 conduct](CODE_OF_CONDUCT.md) before contributing.
 
-## Projects Using Fortitude
-
-More and more open-source Fortran projects are using Fortitude to help maintain
-their code, including:
-
-- [ADCIRC](https://github.com/adcirc/adcirc)
-- [cp2k](https://github.com/cp2k/cp2k)
-- [flexi](https://github.com/flexi-framework/flexi)
-- [FTorch](https://github.com/Cambridge-ICCS/FTorch)
-- [MESA](https://github.com/MESAHub/mesa)
-- [OpenFMS](https://github.com/ispg-group/openfms)
-- [The Met Office](https://github.com/MetOffice/growss/tree/main/fortran-lint)
-
-### Show Your Support
-
-If you've found Fortitude useful in your project, please consider adding the
-Fortitude badge to your `README.md`:
-
-```md
-[![Fortitude](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/PlasmaFAIR/fortitude/main/docs/assets/badge/v0.json)](https://github.com/PlasmaFAIR/fortitude)
-```
-
-or `README.rst`:
-
-```rst
-.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/PlasmaFAIR/fortitude/main/docs/assets/badge/v0.json
-    :target: https://github.com/PlasmaFAIR/fortitude
-    :alt: Fortitude
-```
-
-or, as HTML:
-
-```html
-<a href="https://github.com/PlasmaFAIR/fortitude"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/PlasmaFAIR/fortitude/main/docs/assets/badge/v0.json" alt="Fortitude" style="max-width:100%;"></a>
-```
-
-
 ## License
 
 This work is distributed under the MIT License. See [`LICENSE`](LICENSE) for more

{fortitude_lint-0.8.0 → fortitude_lint-0.8.0rc1}/crates/fortitude/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "fortitude"
-version = "0.8.0"
+version = "0.8.0-rc.1"
 publish = true
 description = "A Fortran linter, written in Rust and installable with Python"
 edition = { workspace = true }

{fortitude_lint-0.8.0 → fortitude_lint-0.8.0rc1}/crates/fortitude/README.md

@@ -255,7 +255,7 @@ Fortitude can be integrated into text editors and IDEs that support the
 Language Server Protocol (LSP), providing real-time diagnostics and
 code actions for applying fixes as you work.
 
-Please see the [documentation](https://fortitude.readthedocs.io/en/stable/editors/) for
+Please see the [documentation](fortitude.readthedocs.io/en/stable/editors) for
 details on setting this up for your editor.
 
 A VSCode plugin is in development, and will be released shortly.
@@ -277,43 +277,6 @@ This also includes instructions for building the project from source, running
 tests, and linting/formatting the code. Please consult our [code of
 conduct](CODE_OF_CONDUCT.md) before contributing.
 
-## Projects Using Fortitude
-
-More and more open-source Fortran projects are using Fortitude to help maintain
-their code, including:
-
-- [ADCIRC](https://github.com/adcirc/adcirc)
-- [cp2k](https://github.com/cp2k/cp2k)
-- [flexi](https://github.com/flexi-framework/flexi)
-- [FTorch](https://github.com/Cambridge-ICCS/FTorch)
-- [MESA](https://github.com/MESAHub/mesa)
-- [OpenFMS](https://github.com/ispg-group/openfms)
-- [The Met Office](https://github.com/MetOffice/growss/tree/main/fortran-lint)
-
-### Show Your Support
-
-If you've found Fortitude useful in your project, please consider adding the
-Fortitude badge to your `README.md`:
-
-```md
-[![Fortitude](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/PlasmaFAIR/fortitude/main/docs/assets/badge/v0.json)](https://github.com/PlasmaFAIR/fortitude)
-```
-
-or `README.rst`:
-
-```rst
-.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/PlasmaFAIR/fortitude/main/docs/assets/badge/v0.json
-    :target: https://github.com/PlasmaFAIR/fortitude
-    :alt: Fortitude
-```
-
-or, as HTML:
-
-```html
-<a href="https://github.com/PlasmaFAIR/fortitude"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/PlasmaFAIR/fortitude/main/docs/assets/badge/v0.json" alt="Fortitude" style="max-width:100%;"></a>
-```
-
-
 ## License
 
 This work is distributed under the MIT License. See [`LICENSE`](LICENSE) for more

{fortitude_lint-0.8.0 → fortitude_lint-0.8.0rc1}/crates/fortitude/tests/check.rs

@@ -758,7 +758,7 @@ end program foo
     success: false
     exit_code: 1
     ----- stdout -----
-    [TEMP_FILE] S081 unnecessary semicolon
+    [TEMP_FILE] S081 [*] unnecessary semicolon
       |
     4 |   integer :: i
     5 |   integer :: j
@@ -795,9 +795,10 @@ end program foo
 
         fortitude explain X001,Y002,...
 
+    [*] 1 fixable with the `--fix` option.
 
     ----- stderr -----
-    warning: Syntax errors detected in file: [TEMP_FILE] Discarding subsequent violations from the AST and all fixes.
+    warning: Syntax errors detected in file: [TEMP_FILE] Discarding subsequent violations from the AST.
     ",);
     Ok(())
 }
@@ -828,7 +829,7 @@ end program foo
     success: false
     exit_code: 1
     ----- stdout -----
-    [TEMP_FILE] S081 unnecessary semicolon
+    [TEMP_FILE] S081 [*] unnecessary semicolon
       |
     4 |   integer :: i
     5 |   integer :: j
@@ -839,7 +840,7 @@ end program foo
       |
       = help: Remove this character
 
-    [TEMP_FILE] S081 unnecessary semicolon
+    [TEMP_FILE] S081 [*] unnecessary semicolon
       |
     6 |   i = 2;
     7 |   j = i ^ 2  ! This is a syntax error
@@ -856,9 +857,9 @@ end program foo
 
         fortitude explain X001,Y002,...
 
+    [*] 2 fixable with the `--fix` option.
 
     ----- stderr -----
-    warning: Syntax errors detected in file: [TEMP_FILE] Discarding all fixes. Some violations from the AST may be unreliable.
     ",);
     Ok(())
 }
@@ -890,7 +891,7 @@ end program foo
     success: false
     exit_code: 1
     ----- stdout -----
-    [TEMP_FILE] S081 unnecessary semicolon
+    [TEMP_FILE] S081 [*] unnecessary semicolon
       |
     4 |   integer :: i
     5 |   integer :: j
@@ -901,7 +902,7 @@ end program foo
       |
       = help: Remove this character
 
-    [TEMP_FILE] S081 unnecessary semicolon
+    [TEMP_FILE] S081 [*] unnecessary semicolon
        |
      7 |   ! allow(syntax-error)
      8 |   j = i ^ 2  ! This is a syntax error
@@ -918,9 +919,10 @@ end program foo
 
         fortitude explain X001,Y002,...
 
+    [*] 2 fixable with the `--fix` option.
 
     ----- stderr -----
-    warning: Syntax errors detected in file: [TEMP_FILE] Discarding subsequent violations from the AST and all fixes.
+    warning: Syntax errors detected in file: [TEMP_FILE] Discarding subsequent violations from the AST.
     ",);
     Ok(())
 }
@@ -951,7 +953,7 @@ end program foo
     success: false
     exit_code: 1
     ----- stdout -----
-    [TEMP_FILE] S081 unnecessary semicolon
+    [TEMP_FILE] S081 [*] unnecessary semicolon
       |
     6 |   i = 2
     7 |   j = i ^ 2  ! This is a syntax error
@@ -968,9 +970,9 @@ end program foo
 
         fortitude explain X001,Y002,...
 
+    [*] 1 fixable with the `--fix` option.
 
     ----- stderr -----
-    warning: Syntax errors detected in file: [TEMP_FILE] Discarding all fixes. Some violations from the AST may be unreliable.
     warning: Syntax errors detected in file: [TEMP_FILE] No fixes will be applied.
     ",);
     Ok(())
@@ -2314,7 +2316,6 @@ end program foo
 "#,
     )?;
 
-    apply_common_filters!();
     assert_cmd_snapshot!(FortitudeCheck::default()
                          .args(["--select=C003", "--ignore=E001"])
                          .file(&test_file)
@@ -2328,7 +2329,6 @@ end program foo
 
 
     ----- stderr -----
-    warning: Syntax errors detected in file: [TEMP_FILE] Discarding all fixes. Some violations from the AST may be unreliable.
     ");
 
     Ok(())

{fortitude_lint-0.8.0 → fortitude_lint-0.8.0rc1}/crates/fortitude_linter/src/lib.rs

@@ -350,50 +350,32 @@ pub(crate) fn check_path(
         }
     }
 
-    // Handle syntax errors
-    if root.has_error() {
-        // If syntax error violations are present, we can (probably) trust AST
-        // violations up to the first syntax error. If we aren't tracking syntax
-        // errors, we report everything but warn that the results are unreliable.
-        // In either case, fixes should be considered too risky to apply.
-        if rules.enabled(Rule::SyntaxError) {
-            // Check violations for any remaining syntax errors. If any are found, discard violations
-            // after it, as they may be false positives.
-            warn_user_once_by_message!(
-                "Syntax errors detected in file: {}. Discarding subsequent violations from the AST and all fixes.",
-                path.to_string_lossy()
-            );
-            // Sort by byte-offset in the file
-            violations.sort_by_key(|diagnostic| diagnostic.range.start());
-            // Retain all violations up to the first syntax error, inclusive.
-            // Text and path rules can be safely retained.
-            let syntax_error_idx = violations
-                .iter()
-                .position(|diagnostic| diagnostic.kind.rule() == Rule::SyntaxError);
-            if let Some(syntax_error_idx) = syntax_error_idx {
-                violations = violations
-                    .into_iter()
-                    .enumerate()
-                    .filter_map(|(idx, diagnostic)| {
-                        if idx <= syntax_error_idx || !diagnostic.kind.rule().is_ast_rule() {
-                            Some(diagnostic)
-                        } else {
-                            None
-                        }
-                    })
-                    .collect_vec();
-            }
-        } else {
-            // If syntax errors are present but the rule is disabled, just warn
-            // that false positives may be present.
-            warn_user_once_by_message!(
-                "Syntax errors detected in file: {}. Discarding all fixes. Some violations from the AST may be unreliable.",
-                path.to_string_lossy()
-            );
-        }
-        // Disable all fixes
-        for diagnostic in &mut violations {
-            diagnostic.fix = None;
+    // Check violations for any remaining syntax errors. If any are found, discard violations
+    // after it, as they may be false positives.
+    if rules.enabled(Rule::SyntaxError) && root.has_error() {
+        warn_user_once_by_message!(
+            "Syntax errors detected in file: {}. Discarding subsequent violations from the AST.",
+            path.to_string_lossy()
+        );
+        // Sort by byte-offset in the file
+        violations.sort_by_key(|diagnostic| diagnostic.range.start());
+        // Retain all violations up to the first syntax error, inclusive.
+        // Text and path rules can be safely retained.
+        let syntax_error_idx = violations
+            .iter()
+            .position(|diagnostic| diagnostic.kind.rule() == Rule::SyntaxError);
+        if let Some(syntax_error_idx) = syntax_error_idx {
+            violations = violations
+                .into_iter()
+                .enumerate()
+                .filter_map(|(idx, diagnostic)| {
+                    if idx <= syntax_error_idx || !diagnostic.kind.rule().is_ast_rule() {
+                        Some(diagnostic)
+                    } else {
+                        None
+                    }
+                })
+                .collect_vec();
         }
     }
 

{fortitude_lint-0.8.0 → fortitude_lint-0.8.0rc1}/crates/fortitude_linter/src/rules/correctness/assumed_size.rs

@@ -119,13 +119,11 @@ impl AstRule for AssumedSize {
 }
 
 /// ## What does it do?
-/// Checks `character` dummy arguments with an assumed-size length have
-/// `intent(in)` only.
+/// Checks `character` dummy arguments have `intent(in)` only
 ///
 /// ## Why is this bad?
-/// Character dummy arguments whose length is assumed size should only have
-/// `intent(in)`, as this can cause data loss with `intent([in]out)`. For
-/// example:
+/// Character dummy arguments with an assumed size should only have `intent(in)`, as
+/// this can cause data loss with `intent([in]out)`. For example:
 ///
 /// ```f90
 /// program example
@@ -170,14 +168,6 @@ impl AstRule for AssumedSize {
 ///     text = "hello world!"
 ///   end subroutine set_text
 /// ```
-///
-/// ## User derived type IO procedures
-/// The standard mandates assumed-size length with `intent(inout)` for the
-/// `iomsg` argument of user defined IO procedures for derived types, although
-/// it doesn't specify a minimum length. Unfortunately, Fortitude is currently
-/// unable to detect this use. You can use [`allow` (suppression)
-/// comments](https://fortitude.readthedocs.io/en/stable/linter/#error-suppression)
-/// to disable this rule for those uses only.
 #[derive(ViolationMetadata)]
 pub(crate) struct AssumedSizeCharacterIntent {
     name: String,

{fortitude_lint-0.8.0 → fortitude_lint-0.8.0rc1}/crates/fortitude_linter/src/rules/correctness/intent.rs

@@ -67,8 +67,8 @@ impl AstRule for MissingIntent {
                     symbol_table.get(param.to_text(src.source_text())?)
                 })
                 .filter(|param| {
-                    // Procedures are not allowed intent
-                    !(param.type_().is_procedure() || param.has_attribute(AttributeKind::External))
+                    // Not allowed intent
+                    !param.type_().is_procedure()
                 })
                 .filter(|param| {
                     // Intent only allowed on pointers after F2003

{fortitude_lint-0.8.0 → fortitude_lint-0.8.0rc1}/crates/fortitude_linter/src/rules/correctness/select_default.rs

@@ -12,56 +12,10 @@ use tree_sitter::Node;
 /// ## Why is this bad?
 /// Select statements without a default case can lead to incomplete handling of
 /// the possible options. If a value isn't handled by any of the cases, the
-/// program will continue execution, which may lead to surprising results.  This
-/// is a common source of bugs when adding new options, as it's easy to forget
-/// to update all `select` statements.  Unfortunately, because Fortran doesn't
-/// have proper enums, it's not possible for the compiler to issue warnings for
-/// non-exhaustive cases. Having a default case allows for the program to
-/// gracefully handle errors.
-///
-/// ## Examples
-///
-/// Instead of:
-///
-/// ```f90
-/// select case(ntype)
-/// case (1)
-///     call routine1()
-/// case (2)
-///     call routine2()
-/// end select
-/// ```
-///
-/// use:
-///
-/// ```f90
-/// select case(ntype)
-/// case (1)
-///     call routine1()
-/// case (2)
-///     call routine2()
-/// case default
-///     call handle_error("Invalid ntype: ", ntype)
-/// end select
-/// ```
-///
-/// If you do only intend to handle a subset of cases, you can use a `continue`
-/// statement with an explanatory comment:
-///
-/// ```f90
-/// select case(ntype)
-/// case (1)
-///     call routine1()
-/// case (2)
-///     call routine2()
-/// case default
-///     ! Other ntypes handled elsewhere
-///     continue
-/// end select
-/// ```
-///
-/// You may also consider instead using an `if` statement. This can make your
-/// intention more obvious.
+/// program will continue execution, which may lead to surprising results.
+/// Unfortunately, because Fortran doesn't have proper enums, it's not possible
+/// for the compiler to issue warnings for non-exhaustive cases. Having a default
+/// case allows for the program to gracefully handle errors.
 #[derive(ViolationMetadata)]
 pub(crate) struct MissingDefaultCase {}
 

fortitude_lint-0.8.0rc1/crates/fortitude_linter/src/rules/style/line_length.rs

@@ -0,0 +1,84 @@
+/// Defines rules that govern line length.
+use crate::settings::CheckSettings;
+use lazy_regex::regex_is_match;
+use ruff_diagnostics::{Diagnostic, Violation};
+use ruff_macros::{ViolationMetadata, derive_message_formats};
+use ruff_source_file::SourceFile;
+use ruff_source_file::UniversalNewlines;
+use ruff_text_size::{TextLen, TextRange, TextSize};
+
+/// ## What does it do?
+/// Checks line length isn't too long
+///
+/// ## Why is this bad?
+/// Long lines are more difficult to read, and may not fit on some developers'
+/// terminals. The line continuation character '&' may be used to split a long line
+/// across multiple lines, and overly long expressions may be broken down into
+/// multiple parts.
+///
+/// The maximum line length can be changed using the flag `--line-length=N`. The
+/// default maximum line length is 100 characters. This is a fair bit more than the
+/// traditional 80, but due to the verbosity of modern Fortran it can sometimes be
+/// difficult to squeeze lines into that width, especially when using large indents
+/// and multiple levels of indentation.
+///
+/// Some lines that are longer than the maximum length may be acceptable, such as
+/// long strings or comments. This is to allow for long URLs or other text that cannot
+/// be reasonably split across multiple lines.
+///
+/// Note that the Fortran standard states a maximum line length of 132 characters,
+/// and while some modern compilers will support longer lines, for portability it
+/// is recommended to stay beneath this limit.
+#[derive(ViolationMetadata)]
+pub(crate) struct LineTooLong {
+    max_length: usize,
+    actual_length: usize,
+}
+
+impl Violation for LineTooLong {
+    #[derive_message_formats]
+    fn message(&self) -> String {
+        let Self {
+            max_length,
+            actual_length,
+        } = self;
+        format!("line length of {actual_length}, exceeds maximum {max_length}")
+    }
+}
+
+impl LineTooLong {
+    pub fn check(settings: &CheckSettings, source_file: &SourceFile) -> Vec<Diagnostic> {
+        let source = source_file.to_source_code();
+        let max_length = settings.line_length;
+        let mut violations = Vec::new();
+        for line in source.text().universal_newlines() {
+            // Note: Can't use string.len(), as that gives byte length, not char length
+            let actual_length = line.chars().count();
+            if actual_length > max_length {
+                // Are we ending on a string or comment? If so, we'll allow it through, as it may
+                // contain something like a long URL that cannot be reasonably split across multiple
+                // lines.
+                if regex_is_match!(r#"(["']\w*&?$)|(!.*$)|(^\w*&)"#, line.as_str()) {
+                    continue;
+                }
+                // Get the byte range from the first character that oversteps the limit
+                // to the end of the line
+                let extra_bytes: TextSize = line
+                    .chars()
+                    .rev()
+                    .take(actual_length - max_length)
+                    .map(TextLen::text_len)
+                    .sum();
+                let range = TextRange::new(line.end() - extra_bytes, line.end());
+                violations.push(Diagnostic::new(
+                    Self {
+                        max_length,
+                        actual_length,
+                    },
+                    range,
+                ));
+            }
+        }
+        violations
+    }
+}

{fortitude_lint-0.8.0 → fortitude_lint-0.8.0rc1}/crates/fortitude_linter/src/rules/style/whitespace.rs

@@ -151,14 +151,7 @@ impl AstRule for IncorrectSpaceBeforeComment {
         }
         if whitespace < 2 {
             let edit = Edit::insertion("  "[whitespace..].to_string(), comment_start);
-            // Unwraps are fine here because we're guaranteed to be at least 2
-            // characters into the file, and `whitespace` is at most 1
-            let span_start = comment_start
-                .checked_sub(TextSize::try_from(whitespace).unwrap())
-                .unwrap();
-
-            let span = TextRange::new(span_start, comment_start);
-            return some_vec!(Diagnostic::new(Self {}, span).with_fix(Fix::safe_edit(edit)));
+            return some_vec!(Diagnostic::from_node(Self {}, node).with_fix(Fix::safe_edit(edit)));
         }
         None
     }