@eriknaslund/skiss 0.4.0 → 0.6.0

package/dist/index.d.ts

@@ -55,6 +55,12 @@ interface FieldNode {
 }
 interface ClassNode {
     name: Name;
+    /**
+     * The class after `<` (SPEC §3.10), set by `parse` whenever one is written.
+     * `resolve` clears it on the class whose `<` closes a circle, as it clears
+     * `identifier` on a second `*`, so no generator has to know about circles.
+     */
+    parent?: Name;
     system?: Name;
     similarTo?: Name;
     description?: string;
@@ -65,10 +71,11 @@ interface ClassNode {
 type Severity = 'error' | 'warning';
 /**
  * Codes from the tables in docs/ARCHITECTURE.md. `parse` adds the `E_` codes,
- * `resolve` the `W_` codes, and `importLinkML` the one code of its own,
+ * `resolve` the `W_` codes and `E_INHERITANCE_CYCLE`, the one error no single
+ * line can see (SPEC §7), and `importLinkML` the one code of its own,
  * `E_NOT_YAML`, for a text no schema can be read out of.
  */
-type DiagnosticCode = 'E_UNPARSABLE' | 'E_FIELD_WITHOUT_CLASS' | 'E_MISSING_TYPE' | 'E_UNCLOSED_MANY' | 'E_BAD_NAME' | 'W_UNKNOWN_TYPE' | 'W_UNDECLARED_CLASS' | 'W_UNDECLARED_FIELD' | 'W_DUPLICATE_CLASS' | 'W_DUPLICATE_FIELD' | 'W_DUPLICATE_ENUM_VALUE' | 'W_MULTIPLE_IDENTIFIERS' | 'E_NOT_YAML';
+type DiagnosticCode = 'E_UNPARSABLE' | 'E_FIELD_WITHOUT_CLASS' | 'E_MISSING_TYPE' | 'E_UNCLOSED_MANY' | 'E_BAD_NAME' | 'E_INHERITANCE_CYCLE' | 'W_UNKNOWN_TYPE' | 'W_UNDECLARED_CLASS' | 'W_UNDECLARED_FIELD' | 'W_DUPLICATE_CLASS' | 'W_DUPLICATE_FIELD' | 'W_DUPLICATE_ENUM_VALUE' | 'W_MULTIPLE_IDENTIFIERS' | 'W_REDUNDANT_OVERRIDE' | 'E_NOT_YAML';
 interface Diagnostic {
     severity: Severity;
     code: DiagnosticCode;
@@ -106,9 +113,10 @@ interface LinkMLAttribute {
     identifier?: boolean;
     annotations?: LinkMLAnnotations;
 }
-/** One entry under `classes`. Key order is SPEC §5.3. */
+/** One entry under `classes`. Key order is SPEC §5.1, Inheritance. */
 interface LinkMLClass {
     description?: string;
+    is_a?: string;
     annotations?: LinkMLAnnotations;
     close_mappings?: string[];
     attributes?: Record<string, LinkMLAttribute>;
@@ -197,6 +205,51 @@ declare function formatDropped(dropped: Dropped[]): string;
 
 declare function toSkiss(doc: Document): string;
 
+/**
+ * Where the words of a Skiss line are, so an editor can colour them.
+ *
+ * This is not a parser and holds no language logic (AGENTS.md §2): nothing
+ * here decides whether a line is valid, what it means or what it compiles to.
+ * It reads the shapes of SPEC §3 and §4 far enough to say "this run of
+ * characters is a class name, that one is an operator", and says nothing at
+ * all about a run it does not recognise, which is what leaves a half-typed
+ * line looking calm instead of wrong. Diagnostics stay the compiler's, and
+ * reach the editor through the gutter.
+ *
+ * Every line is read on its own, as the language is (SPEC §4): no state is
+ * carried from one line to the next, so an edit is never more than one line
+ * of work.
+ *
+ * The productions come from `parse.ts` — the name shapes, the primitive
+ * table, what a word is and where a trailer starts — so that the colours and
+ * the compiler can never disagree about them (ADR 0010).
+ */
+/** What a run of characters is, as far as colour is concerned. */
+type TokenKind = 'class' | 'field' | 'system' | 'primitive'
+/** A lowercase word after `:` that is no primitive. The compiler warns; the colour does not. */
+ | 'type' | 'enum'
+/** The operators of SPEC §4, `<` included, and the `.` of a `= Class.field` join. */
+ | 'operator'
+/** The `*` that marks the identifier. */
+ | 'marker'
+/** A `#` trailer, the `#` included. */
+ | 'description'
+/** A `?` trailer, the `?` included. */
+ | 'doubt'
+/** A whole `#` line at column 0. */
+ | 'comment';
+/** A run of one line, from `from` up to but not including `to`. */
+interface Token {
+    kind: TokenKind;
+    from: number;
+    to: number;
+}
+/**
+ * The tokens of one line, in the order they appear, never overlapping. A blank
+ * line, and a line of nothing the tokenizer recognises, has none.
+ */
+declare function tokenizeLine(line: string): Token[];
+
 interface ImportResult {
     /** The projected sketch as canonical Skiss text, `\n`-terminated. */
     output: string;
@@ -215,6 +268,6 @@ interface ResolvedDocument extends Document {
 }
 declare function resolve(doc: Document): ResolvedDocument;
 
-declare const VERSION = "0.4.0";
+declare const VERSION = "0.6.0";
 
-export { type ClassNode, type CompileOptions, type CompileResult, type Diagnostic, type DiagnosticCode, type Document, type Dropped, type FieldNode, type FromLinkMLResult, type ImportResult, type JoinRef, type LinkMLAnnotations, type LinkMLAttribute, type LinkMLClass, type LinkMLCompileOptions, type LinkMLEnum, type LinkMLOptions, type LinkMLSchema, type MermaidCompileOptions, type MermaidOptions, type Name, type Primitive, type ResolvedDocument, type SerializeFormat, type Severity, type TypeRef, VERSION, compile, formatDiagnostic, formatDropped, fromLinkML, importLinkML, parse, resolve, serialize, toLinkML, toMermaid, toSkiss };
+export { type ClassNode, type CompileOptions, type CompileResult, type Diagnostic, type DiagnosticCode, type Document, type Dropped, type FieldNode, type FromLinkMLResult, type ImportResult, type JoinRef, type LinkMLAnnotations, type LinkMLAttribute, type LinkMLClass, type LinkMLCompileOptions, type LinkMLEnum, type LinkMLOptions, type LinkMLSchema, type MermaidCompileOptions, type MermaidOptions, type Name, type Primitive, type ResolvedDocument, type SerializeFormat, type Severity, type Token, type TokenKind, type TypeRef, VERSION, compile, formatDiagnostic, formatDropped, fromLinkML, importLinkML, parse, resolve, serialize, toLinkML, toMermaid, toSkiss, tokenizeLine };