@arcgis/arcade-languageservice 5.2.0-next.93 → 5.2.0-next.94

package/dist/services/api-context.d.ts

@@ -0,0 +1,7 @@
+import type { ApiContext } from "@arcgis/languages-api-utils";
+import type { FormattingOptions } from "./arcade-formatting/options.js";
+
+export interface ArcadeApiContext extends ApiContext {
+  /** Options to control how the script should be formatted */
+  formattingOptions?: FormattingOptions;
+}

package/dist/services/api-diagnostic.d.ts

@@ -0,0 +1,62 @@
+import type * as Parser from "@arcgis/arcade-parser";
+import type { Range, DiagnosticSeverity } from "vscode-languageserver-types";
+
+export { DiagnosticSeverity } from "vscode-languageserver-types";
+
+/**
+ * Represents the data associated with a diagnostic.
+ * For example in case of an error associated to an identifier,
+ * the DiagnosticData will contain a key 'identifier' and its value.
+ */
+export type DiagnosticData = Record<string, number | string>;
+
+/** The combined diagnostic codes */
+export type DiagnosticCodes = Parser.DiagnosticCodes | ValidationDiagnosticCodes;
+
+/** Represents a diagnostic, such as a parsing error or warning. */
+export interface Diagnostic {
+  /** The range at which the message applies */
+  range: Range;
+  /**
+   * The diagnostic's severity. Can be omitted. If omitted it is up to the
+   * client to interpret diagnostics as error, warning, info or hint.
+   */
+  severity?: DiagnosticSeverity;
+  /** The diagnostic's code. */
+  code: DiagnosticCodes;
+  /** The diagnostic's message. It usually appears in the user interface */
+  message: string;
+  /**
+   * A data entry field that is preserved between a `textDocument/publishDiagnostics`
+   * notification and `textDocument/codeAction` request.
+   */
+  data?: DiagnosticData | null;
+}
+
+export const ValidationDiagnosticCodes: {
+    readonly AlreadyDefined: "AlreadyDefined";
+    readonly ApiConflict: "ApiConflict";
+    readonly AssignedNeverUsed: "AssignedNeverUsed";
+    readonly DefinedNeverAssigned: "DefinedNeverAssigned";
+    readonly DefinedNeverUsed: "DefinedNeverUsed";
+    readonly EmptyBlockStatement: "EmptyBlockStatement";
+    readonly ExecutionError: "ExecutionError";
+    readonly InvalidApiFunctionUsage: "InvalidApiFunctionUsage";
+    readonly InvalidConstantIdentifier: "InvalidConstantIdentifier";
+    readonly InvalidPropertyIdentifier: "InvalidPropertyIdentifier";
+    readonly NoArgumentExpected: "NoArgumentExpected";
+    readonly NotADictionary: "NotADictionary";
+    readonly NotDefined: "NotDefined";
+    readonly NotEnoughArguments: "NotEnoughArguments";
+    readonly ProfileVariablesAreImmutable: "ProfileVariablesAreImmutable";
+    readonly ProfileVariablesConflict: "ProfileVariablesConflict";
+    readonly ReservedKeyword: "ReservedKeyword";
+    readonly TooManyArguments: "TooManyArguments";
+    readonly UnexpectedEmptyFunction: "UnexpectedEmptyFunction";
+    readonly UnexpectedPropertyIdentifier: "UnexpectedPropertyIdentifier";
+    readonly UnknownPropertyIdentifier: "UnknownPropertyIdentifier";
+};
+
+export type ValidationDiagnosticCodes = (typeof ValidationDiagnosticCodes)[keyof typeof ValidationDiagnosticCodes];
+
+export const DiagnosticMessages: Record<Parser.DiagnosticCodes | ValidationDiagnosticCodes, string>;

package/dist/services/arcade-formatting/arcade-formatting.d.ts

@@ -0,0 +1,18 @@
+import type { TextDocument } from "vscode-languageserver-textdocument";
+import type { TextEdit } from "vscode-languageserver-types";
+import type { ArcadeApiContext } from "../api-context.js";
+import type { FormattingOptions } from "./options.js";
+
+/**
+ * @param document
+ * @param context
+ */
+export function arcadeFormat(document: TextDocument, context?: ArcadeApiContext): TextEdit[];
+
+/**
+ * Format code using options.
+ *
+ * @param script
+ * @param options
+ */
+export function format(script: string, options?: FormattingOptions): string;

package/dist/services/arcade-formatting/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./arcade-formatting.js";
+

package/dist/services/arcade-formatting/options.d.ts

@@ -0,0 +1,28 @@
+/** Describes the formatting options */
+export interface FormattingOptions {
+  /**
+   * Number of spaces the formatter should use for indentation.
+   * If you do not pass this option explicitly, it will be
+   * (quite reliably!) inferred from the original code.
+   *
+   * @default 2
+   */
+  indentWidth?: number;
+  /**
+   * Some of the formatter code (such as that for printing function
+   * parameter lists) makes a valiant attempt to prevent really long
+   * lines. You can adjust the limit by changing this option; however,
+   * there is no guarantee that line length will fit inside this limit.
+   *
+   * @default 80
+   */
+  wrapColumn?: number;
+  /**
+   * If you want to override the quotes used in string literals, specify
+   * either "single", "double", or "auto" here ("auto" will select the one
+   * which results in the shorter literal) Otherwise, use double quotes.
+   *
+   * @default null
+   */
+  quote?: "auto" | "double" | "single" | null;
+}

package/dist/services/languageKeywords.d.ts

@@ -0,0 +1,7 @@
+import type { Keywords, Literals } from "@arcgis/arcade-parser";
+
+export const ArcadeKeywords: Keywords[];
+
+export const ArcadeLiterals: Literals[];
+
+export const ArcadeReservedKeywords: (string | string | string | string | string)[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/arcade-languageservice",
-  "version": "5.2.0-next.93",
+  "version": "5.2.0-next.94",
   "description": "Arcade Language Service",
   "homepage": "https://developers.arcgis.com/javascript/latest/",
   "type": "module",
@@ -12,7 +12,8 @@
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@arcgis/languages-api-utils": "5.2.0-next.93",
+    "@arcgis/arcade-parser": "5.2.0-next.94",
+    "@arcgis/languages-api-utils": "5.2.0-next.94",
     "tslib": "^2.8.1",
     "vscode-languageserver-textdocument": "^1.0.11",
     "vscode-languageserver-types": "^3.17.5"