Merge branch 'main' into setting-explicit_path

Kampfkarren · Aug 11, 2024 · 3ded06b · 3ded06b
2 parents 8c04c77 + 6e02c2f
commit 3ded06b
Show file tree

Hide file tree

Showing 21 changed files with 232 additions and 40 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -78,6 +78,18 @@ jobs:
       with:
         name: selene-linux
         path: ./target/release/selene
+    - name: Build arm64 (Default features)
+      uses: actions-rs/cargo@v1
+      with:
+        working-directory: selene
+        use-cross: true
+        command: build
+        args: --locked --release --target aarch64-unknown-linux-gnu
+    - name: Upload selene arm64
+      uses: actions/upload-artifact@v1
+      with:
+        name: selene-linux-aarch64
+        path: ./target/aarch64-unknown-linux-gnu/release/selene
   build_linux_light:
     runs-on: ubuntu-latest
     steps:
@@ -91,6 +103,18 @@ jobs:
       with:
         name: selene-light-linux
         path: ./target/release/selene
+    - name: Build arm64 (Lightweight)
+      uses: actions-rs/cargo@v1
+      with:
+        working-directory: selene
+        use-cross: true
+        command: build
+        args: --locked --release --verbose --no-default-features --target aarch64-unknown-linux-gnu
+    - name: Upload selene-light arm64
+      uses: actions/upload-artifact@v1
+      with:
+        name: selene-light-linux-aarch64
+        path: ./target/aarch64-unknown-linux-gnu/release/selene
   release:
     runs-on: ubuntu-latest
     needs: ['build_windows_light', 'build_windows', 'build_mac', 'build_mac_light', 'build_linux', 'build_linux_light']

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,22 @@
 # Changelog
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/Kampfkarren/selene/compare/0.26.1...HEAD)
+## [Unreleased](https://github.com/Kampfkarren/selene/compare/0.27.1...HEAD)
+### Added
+- Added `Path2DControlPoint.new` to the Roblox standard library
+
+## [0.27.1](https://github.com/Kampfkarren/selene/releases/tag/0.27.1) - 2024-04-28
+### Fixed
+- Fixed `Instance.new`'s second parameter being incorrectly marked as required.
+
+## [0.27.0](https://github.com/Kampfkarren/selene/releases/tag/0.27.0) - 2024-04-28
 ### Added
 - Added `CFrame.lookAlong` to the Roblox standard library
+- Added `deprecated` config field to standard library function parameters
+
+### Changed
+- Updated the warning message for the `mixed_table` lint to include why mixed tables should be avoided
+- Properly deprecated `Instance.new`'s second argument in the Roblox standard library
 
 ## [0.26.1](https://github.com/Kampfkarren/selene/releases/tag/0.26.1) - 2023-11-11
 ### Fixed

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -3,7 +3,7 @@ members = ["selene", "selene-lib"]
 resolver = "2"
 
 [workspace.package]
-version = "0.26.1"
+version = "0.27.1"
 authors = ["Kampfkarren <[email protected]>"]
 edition = "2021"
 homepage = "https://kampfkarren.github.io/selene/"
@@ -15,4 +15,4 @@ full_moon = "0.19.0"
 toml = "0.7.2"
 
 # Do not update this without confirming profiling uses the same version of tracy-client as selene
-profiling = "1.0.7"
+profiling = "1.0.7"
diff --git a/docs/src/cli/installation.md b/docs/src/cli/installation.md
@@ -16,4 +16,4 @@ cargo install --branch main --git https://github.com/Kampfkarren/selene selene
 ```
 
 ### Disabling Roblox features
-selene is built with Roblox specific lints by default. If you don't want these, type `--no-default-features` after whichever command you choose.
+selene is built with Roblox specific lints by default. If you don't want these, then pass `--no-default-features` to the `cargo install` command.
diff --git a/docs/src/usage/std.md b/docs/src/usage/std.md
@@ -154,7 +154,7 @@ globals:
 A field is understood as a table if it has fields of its own. Notice that `math` is not defined anywhere, but its fields are. This will create an implicit `math` with the property writability of `read-only`.
 
 ### Deprecated
-Any field can have a deprecation notice added to it, which will then be read by [the deprecated lint](../lints/deprecated.md).
+Any field or arg can have a deprecation notice added to it, which will then be read by [the deprecated lint](../lints/deprecated.md).
 
 ```yaml
 ---

diff --git a/selene-lib/default_std/roblox_base.yml b/selene-lib/default_std/roblox_base.yml
@@ -320,6 +320,11 @@ globals:
   Instance.new:
     args:
       - type: string
+      - required: false
+        type:
+          display: Instance
+        deprecated:
+          message: set the instance's parent separately
     # This is only must_use because we don't allow the second parameter
     must_use: true
   NumberRange.new:
@@ -344,6 +349,18 @@ globals:
   OverlapParams.new:
     args: []
     must_use: true
+  Path2DControlPoint.new:
+    args:
+      - required: false
+        type:
+          display: UDim2
+      - required: false
+        type:
+          display: UDim2
+      - required: false
+        type:
+          display: UDim2
+    must_use: true
   PathWaypoint.new:
     args:
       - required: false

diff --git a/selene-lib/src/ast_util/scopes.rs b/selene-lib/src/ast_util/scopes.rs
@@ -830,11 +830,7 @@ impl Visitor for ScopeVisitor {
 
     fn visit_block(&mut self, block: &ast::Block) {
         if let Some((start, end)) = block.range() {
-            if self
-                .else_blocks
-                .get(&(start.bytes(), end.bytes()))
-                .is_some()
-            {
+            if self.else_blocks.contains(&(start.bytes(), end.bytes())) {
                 self.close_scope(); // close the if or elseif's block
                 self.open_scope(block);
             }
@@ -843,11 +839,7 @@ impl Visitor for ScopeVisitor {
 
     fn visit_block_end(&mut self, block: &ast::Block) {
         if let Some((start, end)) = block.range() {
-            if self
-                .else_blocks
-                .get(&(start.bytes(), end.bytes()))
-                .is_some()
-            {
+            if self.else_blocks.contains(&(start.bytes(), end.bytes())) {
                 self.close_scope();
             }
         }

diff --git a/selene-lib/src/lints/deprecated.rs b/selene-lib/src/lints/deprecated.rs
@@ -3,7 +3,7 @@ use std::convert::Infallible;
 use full_moon::{ast, visitors::Visitor};
 use serde::Deserialize;
 
-use crate::ast_util::{name_paths::*, scopes::ScopeManager};
+use crate::ast_util::{name_paths::*, range, scopes::ScopeManager};
 
 use super::{super::standard_library::*, *};
 
@@ -48,6 +48,11 @@ struct DeprecatedVisitor<'a> {
     standard_library: &'a StandardLibrary,
 }
 
+struct Argument {
+    display: String,
+    range: (usize, usize),
+}
+
 impl<'a> DeprecatedVisitor<'a> {
     fn new(
         config: &DeprecatedLintConfig,
@@ -94,7 +99,7 @@ impl<'a> DeprecatedVisitor<'a> {
         node: &N,
         what: &str,
         name_path: &[String],
-        parameters: &[String],
+        arguments: &[Argument],
     ) {
         assert!(!name_path.is_empty());
 
@@ -115,7 +120,12 @@ impl<'a> DeprecatedVisitor<'a> {
 
             let mut notes = vec![deprecated.message.to_owned()];
 
-            if let Some(replace_with) = deprecated.try_instead(parameters) {
+            if let Some(replace_with) = deprecated.try_instead(
+                &arguments
+                    .iter()
+                    .map(|arg| arg.display.clone())
+                    .collect::<Vec<_>>(),
+            ) {
                 notes.push(format!("try: {replace_with}"));
             }
 
@@ -130,6 +140,28 @@ impl<'a> DeprecatedVisitor<'a> {
                 Vec::new(),
             ));
         }
+
+        if let Some(Field {
+            field_kind: FieldKind::Function(function),
+            ..
+        }) = self.standard_library.find_global(name_path)
+        {
+            for (arg, arg_std) in arguments
+                .iter()
+                .zip(&function.arguments)
+                .filter(|(arg, _)| arg.display != "nil")
+            {
+                if let Some(deprecated) = &arg_std.deprecated {
+                    self.diagnostics.push(Diagnostic::new_complete(
+                        "deprecated",
+                        "this parameter is deprecated".to_string(),
+                        Label::new(arg.range),
+                        vec![deprecated.message.clone()],
+                        Vec::new(),
+                    ));
+                };
+            }
+        }
     }
 }
 
@@ -194,21 +226,32 @@ impl Visitor for DeprecatedVisitor<'_> {
             feature = "force_exhaustive_checks",
             deny(non_exhaustive_omitted_patterns)
         )]
-        let argument_displays = match function_args {
+        let arguments = match function_args {
             ast::FunctionArgs::Parentheses { arguments, .. } => arguments
                 .iter()
-                .map(|argument| argument.to_string())
+                .map(|argument| Argument {
+                    display: argument.to_string().trim_end().to_string(),
+                    range: range(argument),
+                })
                 .collect(),
 
-            ast::FunctionArgs::String(token) => vec![token.to_string()],
+            ast::FunctionArgs::String(token) => vec![
+                (Argument {
+                    display: token.to_string(),
+                    range: range(token),
+                }),
+            ],
             ast::FunctionArgs::TableConstructor(table_constructor) => {
-                vec![table_constructor.to_string()]
+                vec![Argument {
+                    display: table_constructor.to_string(),
+                    range: range(table_constructor),
+                }]
             }
 
             _ => Vec::new(),
         };
 
-        self.check_name_path(call, "function", &name_path, &argument_displays);
+        self.check_name_path(call, "function", &name_path, &arguments);
     }
 }
 
@@ -234,6 +277,15 @@ mod tests {
         );
     }
 
+    #[test]
+    fn test_deprecated_params() {
+        test_lint(
+            DeprecatedLint::new(DeprecatedLintConfig::default()).unwrap(),
+            "deprecated",
+            "deprecated_params",
+        );
+    }
+
     #[test]
     fn test_specific_allow() {
         test_lint(
@@ -242,6 +294,7 @@ mod tests {
                     "deprecated_allowed".to_owned(),
                     "more.*".to_owned(),
                     "wow.*.deprecated_allowed".to_owned(),
+                    "deprecated_param".to_owned(),
                 ],
             })
             .unwrap(),

diff --git a/selene-lib/src/lints/mixed_table.rs b/selene-lib/src/lints/mixed_table.rs
@@ -30,7 +30,7 @@ impl Lint for MixedTableLint {
         for mixed_table in visitor.mixed_tables {
             diagnostics.push(Diagnostic::new_complete(
                 "mixed_table",
-                "mixed tables are not allowed".to_owned(),
+                "mixed tables should be avoided, as they can cause confusing and hard to debug issues such as during iteration or encoding".to_owned(),
                 Label::new(mixed_table.range),
                 vec!["help: change this table to either an array or dictionary".to_owned()],
                 Vec::new(),

diff --git a/selene-lib/src/lints/roblox_incorrect_roact_usage.rs b/selene-lib/src/lints/roblox_incorrect_roact_usage.rs
@@ -18,7 +18,7 @@ use if_chain::if_chain;
 pub struct IncorrectRoactUsageLint;
 
 // Assumes string includes quotes at start and end
-fn is_lua_valid_table_key_identifier(string: &String) -> bool {
+fn is_lua_valid_table_key_identifier(string: &str) -> bool {
     // Valid identifier cannot start with numbers
     let first_char = string.chars().nth(1).unwrap();
     if !first_char.is_alphabetic() && first_char != '_' {

diff --git a/selene-lib/src/standard_library/mod.rs b/selene-lib/src/standard_library/mod.rs
@@ -603,6 +603,10 @@ pub struct Argument {
     #[serde(default)]
     #[serde(skip_serializing_if = "is_default")]
     pub observes: Observes,
+
+    #[serde(default)]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub deprecated: Option<Deprecated>,
 }
 
 #[derive(Clone, Debug, Hash, PartialEq, Eq)]

diff --git a/selene-lib/src/standard_library/v1_upgrade.rs b/selene-lib/src/standard_library/v1_upgrade.rs
@@ -41,6 +41,7 @@ impl From<v1::Argument> for Argument {
             required: v1_argument.required.into(),
             argument_type: v1_argument.argument_type.into(),
             observes: Observes::ReadWrite,
+            deprecated: None,
         }
     }
 }

diff --git a/selene-lib/tests/lints/deprecated/deprecated_params.lua b/selene-lib/tests/lints/deprecated/deprecated_params.lua
@@ -0,0 +1,8 @@
+local _ = Instance.new(a)
+local _ = Instance.new(a, b)
+local _ = Instance.new(a,    nil     )
+local _ = Instance.new(a, "nil")
+
+a(1)
+a ""
+a {}
diff --git a/selene-lib/tests/lints/deprecated/deprecated_params.std.yml b/selene-lib/tests/lints/deprecated/deprecated_params.std.yml
@@ -0,0 +1,17 @@
+---
+globals:
+  Instance.new:
+    args:
+      - type: string
+      - required: false
+        type:
+          display: Instance
+        deprecated:
+          message: set the instance's parent separately
+  a:
+    args:
+      - required: false
+        type:
+          display: any
+        deprecated:
+          message: this is deprecated