Merge pull request #11 from joshraphael/update_functions

update RATools functions to match new spec

Author: joshraphael

CHANGELOG.md

@@ -5,20 +5,29 @@ All notable changes to the "vscode-rascript" extension will be documented in thi
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [[0.3.2](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.3.2)] - 2025-XX-XX
+## [[0.4.0](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.4.0)] - 2025-09-18
 
-[diff](https://github.com/joshraphael/vscode-rascript/compare/v0.3.1...v0.3.2)
+[diff](https://github.com/joshraphael/vscode-rascript/compare/v0.3.1...v0.4.0)
 
 ### Added
 
+- New built-in function definition `achievement_set()`
+
 ### Changed
 
 - Syntax highlighting to use upstream [rascript-syntax](https://github.com/joshraphael/rascript-syntax) repo
-- Bug involving incorrect comment bounds detected for hover, definition and completion data
 - Unify document parser to align with language server
+- `achievement()` built-in function definition to support new `set` parameter
+- `leaderboard()` built-in function definition to support new `set` parameter
 
 ### Removed
 
+### Fixed
+
+- Bug involving incorrect comment bounds detected for hover, definition and completion data
+
+### Security
+
 ## [[0.3.1](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.3.1)] - 2025-08-07
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.3.0...v0.3.1)
@@ -28,10 +37,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Allow function names, parameters class names, and variables to start with an underscore
-- Fix extension package distribution pipeline
 
 ### Removed
 
+### Fixed
+
+- Extension package distribution pipeline
+
+### Security
+
 ## [[0.3.0](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.3.0)] - 2025-08-03
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.2.4...v0.3.0)
@@ -46,12 +60,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Fixed code jumping, hover text, and code completion to ignore any functions or classes defined in a comment
-- Duplicate function and variable names being show in auto completion
 - Improved illegal name detection on functions and parameters
-- Bump dependencies to fix multiple vulnerabilities [#3](https://github.com/joshraphael/vscode-rascript/security/dependabot/3), [#4](https://github.com/joshraphael/vscode-rascript/security/dependabot/4), [#5](https://github.com/joshraphael/vscode-rascript/security/dependabot/5), [#7](https://github.com/joshraphael/vscode-rascript/security/dependabot/7), [#10](https://github.com/joshraphael/vscode-rascript/security/dependabot/10)
 
 ### Removed
 
+### Fixed
+
+- Duplicate function and variable names being show in auto completion
+
+### Security
+
+- Bump dependencies to fix multiple vulnerabilities [#3](https://github.com/joshraphael/vscode-rascript/security/dependabot/3), [#4](https://github.com/joshraphael/vscode-rascript/security/dependabot/4), [#5](https://github.com/joshraphael/vscode-rascript/security/dependabot/5), [#7](https://github.com/joshraphael/vscode-rascript/security/dependabot/7), [#10](https://github.com/joshraphael/vscode-rascript/security/dependabot/10)
+
 ## [[0.2.4](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.2.4)] - 2025-06-16
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.2.3...v0.2.4)
@@ -64,6 +84,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+### Fixed
+
+### Security
+
 ## [[0.2.3](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.2.3)] - 2025-06-15
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.2.2...v0.2.3)
@@ -76,6 +100,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - File system check for language server before launch causing extension to not activate
 
+### Fixed
+
+### Security
+
 ## [[0.2.2](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.2.2)] - 2025-06-15
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.2.1...v0.2.2)
@@ -88,6 +116,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+### Fixed
+
+### Security
+
 ## [[0.2.1](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.2.1)] - 2025-06-14
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.2.0...v0.2.1)
@@ -100,6 +132,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+### Fixed
+
+### Security
+
 ## [[0.2.0](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.2.0)] - 2025-06-14
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.1.3...v0.2.0)
@@ -110,10 +146,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Bump `@vscode/test-web` to version 0.0.70 ([security vulnerability](https://github.com/joshraphael/vscode-rascript/security/dependabot/2))
-
 ### Removed
 
+### Fixed
+
+### Security
+
+- Bump `@vscode/test-web` to version 0.0.70 ([security vulnerability](https://github.com/joshraphael/vscode-rascript/security/dependabot/2))
+
 ## [[0.1.3](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.1.3)] - 2025-06-05
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.1.2...v0.1.3)
@@ -126,6 +166,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+### Fixed
+
+### Security
+
 ## [[0.1.2](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.1.2)] - 2025-05-27
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.1.1...v0.1.2)
@@ -139,10 +183,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Bump `@vscode/test-web` to version 0.0.69 ([security vulnerability](https://github.com/joshraphael/vscode-rascript/security/dependabot/1))
-
 ### Removed
 
+### Fixed
+
+### Security
+
+- Bump `@vscode/test-web` to version 0.0.69 ([security vulnerability](https://github.com/joshraphael/vscode-rascript/security/dependabot/1))
+
 ## [[0.1.1](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.1.1)] - 2025-03-01
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.1.0...v0.1.1)
@@ -157,6 +205,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+### Fixed
+
+### Security
+
 ## [[0.1.0](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.1.0)] - 2025-02-28
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.0.4...v0.1.0)
@@ -171,6 +223,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+### Fixed
+
+### Security
+
 ## [[0.0.4](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.0.4)] - 2025-02-25
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.0.3...v0.0.4)
@@ -186,6 +242,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+### Fixed
+
+### Security
+
 ## [[0.0.3](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.0.3)] - 2025-02-24
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.0.2...v0.0.3)
@@ -205,6 +265,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+### Fixed
+
+### Security
+
 ## [[0.0.2](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.0.2)] - 2025-02-23
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/v0.0.1...v0.0.2)
@@ -218,6 +282,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+### Fixed
+
+### Security
+
 ## [[0.0.1](https://github.com/joshraphael/vscode-rascript/releases/tag/v0.0.1)] - 2025-02-22
 
 [diff](https://github.com/joshraphael/vscode-rascript/compare/8f97b037538abae0e892b19c86ba3e4cd9f87c73...v0.0.1)
@@ -241,4 +309,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-### Removed
+### Removed
+
+### Fixed
+
+### Security

src/clients/shared/functionDefinitions.ts

@@ -604,7 +604,7 @@ export const builtinFunctionDefinitions: readonly FunctionDefinition[] = [
   },
   {
     key: "achievement",
-    url: "https://github.com/Jamiras/RATools/wiki/Achievement-Functions",
+    url: "https://github.com/Jamiras/RATools/wiki/Achievement-Functions#achievementtitle-description-points-trigger-id0-published-modified-badge0-type-set0",
     args: [
       "title",
       "description",
@@ -615,6 +615,7 @@ export const builtinFunctionDefinitions: readonly FunctionDefinition[] = [
       "modified",
       "badge",
       "type",
+      "set",
     ],
     commentDoc: [
       "// Defines a new achievement with the specified `title` (string), `description` (string), `points` (integer), and `trigger`.",
@@ -640,6 +641,8 @@ export const builtinFunctionDefinitions: readonly FunctionDefinition[] = [
       '// | `"progression"` | Progression |',
       '// | `"win_condition"` | Win condition |',
       "// ",
+      "// `set` specifies the unique identifier of the [achievement set](https://github.com/Jamiras/RATools/wiki/Achievement-Functions#achievement_settitle-typebonus-id0-game_id0) the achievement should be partitioned into.",
+      "// ",
       "// #### Example",
       "// ",
       "// ```rascript",
@@ -661,6 +664,30 @@ export const builtinFunctionDefinitions: readonly FunctionDefinition[] = [
       "// ```",
     ],
   },
+  {
+    key: "achievement_set",
+    url: "https://github.com/Jamiras/RATools/wiki/Achievement-Functions#achievement_settitle-typebonus-id0-game_id0",
+    args: ["title", "type", "id", "game_id"],
+    commentDoc: [
+      "// Defines a new achievement set (subset) with the specified `title`.",
+      "// ",
+      "// `type` defines how the subset is associated to the base set. Valid values are `BONUS`, `SPECIALTY`, and `EXCLUSIVE`.",
+      "// ",
+      "// `id` is the achievement set id. This should match the `set=` parameter from the game's subset page.",
+      "// ",
+      "// `game_id` is the legacy game ID for subsets created before sets were merged into the base game.",
+      "// ",
+      "// The return value is the unique identifier of the set to be passed to the achievement/leaderboard functions. If `id` is provided, it will be returned, otherwise a local value will be generated.",
+      "// ",
+      "// #### Example",
+      "// ",
+      "// ```rascript",
+      '// bonus_set = achievement_set("Bonus")',
+      '// achievement("Impossible", "Complete the game without dying", 100, set=bonus_set,',
+      "//     trigger = complete_game() && never(lives() < prev(lives))",
+      "// ```",
+    ],
+  },
   {
     key: "rich_presence_display",
     url: "https://github.com/Jamiras/RATools/wiki/Rich-Presence-Functions#rich_presence_displayformat_string-parameters",
@@ -819,6 +846,7 @@ export const builtinFunctionDefinitions: readonly FunctionDefinition[] = [
       "format",
       "lower_is_better",
       "id",
+      "set",
     ],
     commentDoc: [
       "// Defines a leaderboard. `title` and `description` must be strings.",
@@ -844,6 +872,8 @@ export const builtinFunctionDefinitions: readonly FunctionDefinition[] = [
       "// if `lower_is_better` is `true`, lower scores will be ranked higher in the leaderboard.",
       "// ",
       "// if `id` is provided when calling the `leaderboard` function, the script will generate a local leaderboard definition that the toolkit will merge into the existing leaderboard instead of putting as a separate local leaderboard.",
+      "// ",
+      "// `set` specifies the unique identifier of the [achievement set](https://github.com/Jamiras/RATools/wiki/Achievement-Functions#achievement_settitle-typebonus-id0-game_id0) the achievement should be partitioned into.",
     ],
   },
   {

src/clients/shared/models.ts

@@ -30,6 +30,7 @@ export interface ClassFunction {
 export interface HoverData {
   key: string;
   index: number;
+  type: string;
   className: string;
   hover: vscode.Hover;
   args: string[];