@aardarch/aardink-web 0.6.0-rc1 → 0.6.0-rc2

package/README.md

@@ -102,9 +102,7 @@ the measurements and the device checklist.
 - **A disposed editor is not fully released** (about 275 KB each) until Aardink moves to Compose
   Multiplatform 1.13. Reuse one editor with `setValue` and `updateOptions` rather than mounting
   one per view.
-- Themes are colours only: bold and italic in theme rules are ignored.
-- Whitespace is not rendered (`renderWhitespace`), and a completion inserts plain text: snippet
-  placeholders such as `$1` are not expanded.
+- A theme rule's `background` is ignored; its `foreground` and `fontStyle` apply.
 
 ## Licence
 

package/index.d.ts

@@ -35,6 +35,8 @@ export interface AardinkOptions {
   insertSpaces?: boolean;
   /** Monaco's `renderLineHighlight`: anything but `'none'` highlights each caret's line. */
   renderLineHighlight?: 'none' | 'line' | 'gutter' | 'all';
+  /** Which spaces and tabs are drawn, as dots and arrows. `'selection'` by default. */
+  renderWhitespace?: 'none' | 'boundary' | 'selection' | 'trailing' | 'all';
   /** Colours brackets by nesting depth. On by default. */
   bracketPairColorization?: { enabled?: boolean } | boolean;
   /** A picture of the whole text at the side, with a slider over what is shown. Off by default. */
@@ -137,10 +139,21 @@ export interface AardinkLanguageDefinition {
   comments?: { lineComment?: string; blockComment?: [string, string] };
 }
 
+/** Monaco's flags for a completion's `insertText`. */
+export declare const CompletionItemInsertTextRule: {
+  readonly None: 0;
+  /** Insert the snippet's whitespace as written, rather than indented as the line it lands on. */
+  readonly KeepWhitespace: 1;
+  /** `insertText` is a snippet: `$1`, `${1:placeholder}` and `${1|a,b|}` are tab stops, `$0` the final caret. */
+  readonly InsertAsSnippet: 4;
+};
+
 export interface AardinkCompletionItem {
   label: string;
-  /** What accepting it types; the label when absent. */
+  /** What accepting it types; the label when absent. A snippet with `InsertAsSnippet`. */
   insertText?: string;
+  /** `CompletionItemInsertTextRule` flags, as in Monaco. */
+  insertTextRules?: number;
   kind?: 'element' | 'attribute' | 'value' | 'snippet' | 'module' | 'property';
   detail?: string;
   documentation?: string;
@@ -161,9 +174,10 @@ export interface AardinkLanguageProviders {
 export function registerLanguage(definition: AardinkLanguageDefinition, providers?: AardinkLanguageProviders): Promise<void>;
 
 /**
- * Monaco's `defineTheme` data. Token rules name a grammar's tokens; `tag` also colours
- * `tag.aardflex`. Themes are colours only: a rule's `fontStyle` and `background` are accepted, so
- * Monaco theme data passes as it is, and ignored.
+ * Monaco's `defineTheme` data. Token rules name tokens as Monaco does, and the longest matching
+ * prefix wins: `tag` also colours `tag.aardflex`, `comment.doc` only documentation comments. A
+ * rule's `fontStyle` (`'bold'`, `'italic'`, `'underline'`, `'strikethrough'`, or `''` for none)
+ * applies too; its `background` is accepted, so Monaco theme data passes as it is, and ignored.
  */
 export interface AardinkThemeData {
   base: 'vs' | 'vs-dark' | 'hc-black' | 'hc-light';

package/index.js

@@ -17,7 +17,10 @@
 // Adapts the Kotlin module's integer-handle exports (aardinkCreate, aardinkGetValue, ...) into
 // the Monaco-shaped object described in index.d.ts.
 
-export const version = '0.6.0-rc1';
+export const version = '0.6.0-rc2';
+
+/** Monaco's flags for a completion's `insertText`. */
+export const CompletionItemInsertTextRule = Object.freeze({ None: 0, KeepWhitespace: 1, InsertAsSnippet: 4 });
 
 let kotlinModule;
 
@@ -112,9 +115,16 @@ function toVsCodeTheme(theme) {
     type: base === 'vscode-light' ? 'light' : 'dark',
     base: theme.inherit === false ? undefined : base,
     colors: theme.colors ?? {},
+    // A rule's colour and font style; its background is not drawn.
     tokenColors: theme.rules
-      .filter((rule) => rule.foreground)
-      .map((rule) => ({ scope: rule.token, settings: { foreground: `#${rule.foreground.replace(/^#/, '')}` } })),
+      .filter((rule) => rule.foreground || rule.fontStyle !== undefined)
+      .map((rule) => ({
+        scope: rule.token,
+        settings: {
+          ...(rule.foreground ? { foreground: `#${rule.foreground.replace(/^#/, '')}` } : {}),
+          ...(rule.fontStyle !== undefined ? { fontStyle: rule.fontStyle } : {}),
+        },
+      })),
   };
 }
 
@@ -134,7 +144,7 @@ export const defineTheme = registerTheme;
  */
 function toKotlinOptions(options) {
   const out = {};
-  for (const key of ['language', 'theme', 'fontSize', 'readOnly', 'showGutter', 'showLineNumbers', 'showFoldMarkers', 'tabSize', 'insertSpaces', 'highlightCurrentLine']) {
+  for (const key of ['language', 'theme', 'fontSize', 'readOnly', 'showGutter', 'showLineNumbers', 'showFoldMarkers', 'tabSize', 'insertSpaces', 'highlightCurrentLine', 'renderWhitespace']) {
     if (options[key] !== undefined) out[key] = options[key];
   }
   if (options.wordWrap !== undefined) out.wordWrap = options.wordWrap === 'on';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aardarch/aardink-web",
-  "version": "0.6.0-rc1",
+  "version": "0.6.0-rc2",
   "description": "The Aardink code editor for the browser: Compose Multiplatform on WebAssembly behind a Monaco-shaped API.",
   "keywords": [
     "code-editor",