@malloydata/malloy 0.0.360 → 0.0.361

package/dist/lang/lib/Malloy/MalloyParserListener.d.ts

@@ -88,7 +88,11 @@ import { MalloyStatementContext } from "./MalloyParser";
 import { DefineSourceStatementContext } from "./MalloyParser";
 import { DefineQueryContext } from "./MalloyParser";
 import { TopLevelAnonQueryDefContext } from "./MalloyParser";
+import { AnnotationContext } from "./MalloyParser";
 import { TagsContext } from "./MalloyParser";
+import { BlockAnnotationContext } from "./MalloyParser";
+import { DocAnnotationContext } from "./MalloyParser";
+import { DocBlockAnnotationContext } from "./MalloyParser";
 import { IsDefineContext } from "./MalloyParser";
 import { RunStatementContext } from "./MalloyParser";
 import { SqlStringContext } from "./MalloyParser";
@@ -1308,6 +1312,16 @@ export interface MalloyParserListener extends ParseTreeListener {
      * @param ctx the parse tree
      */
     exitTopLevelAnonQueryDef?: (ctx: TopLevelAnonQueryDefContext) => void;
+    /**
+     * Enter a parse tree produced by `MalloyParser.annotation`.
+     * @param ctx the parse tree
+     */
+    enterAnnotation?: (ctx: AnnotationContext) => void;
+    /**
+     * Exit a parse tree produced by `MalloyParser.annotation`.
+     * @param ctx the parse tree
+     */
+    exitAnnotation?: (ctx: AnnotationContext) => void;
     /**
      * Enter a parse tree produced by `MalloyParser.tags`.
      * @param ctx the parse tree
@@ -1318,6 +1332,36 @@ export interface MalloyParserListener extends ParseTreeListener {
      * @param ctx the parse tree
      */
     exitTags?: (ctx: TagsContext) => void;
+    /**
+     * Enter a parse tree produced by `MalloyParser.blockAnnotation`.
+     * @param ctx the parse tree
+     */
+    enterBlockAnnotation?: (ctx: BlockAnnotationContext) => void;
+    /**
+     * Exit a parse tree produced by `MalloyParser.blockAnnotation`.
+     * @param ctx the parse tree
+     */
+    exitBlockAnnotation?: (ctx: BlockAnnotationContext) => void;
+    /**
+     * Enter a parse tree produced by `MalloyParser.docAnnotation`.
+     * @param ctx the parse tree
+     */
+    enterDocAnnotation?: (ctx: DocAnnotationContext) => void;
+    /**
+     * Exit a parse tree produced by `MalloyParser.docAnnotation`.
+     * @param ctx the parse tree
+     */
+    exitDocAnnotation?: (ctx: DocAnnotationContext) => void;
+    /**
+     * Enter a parse tree produced by `MalloyParser.docBlockAnnotation`.
+     * @param ctx the parse tree
+     */
+    enterDocBlockAnnotation?: (ctx: DocBlockAnnotationContext) => void;
+    /**
+     * Exit a parse tree produced by `MalloyParser.docBlockAnnotation`.
+     * @param ctx the parse tree
+     */
+    exitDocBlockAnnotation?: (ctx: DocBlockAnnotationContext) => void;
     /**
      * Enter a parse tree produced by `MalloyParser.isDefine`.
      * @param ctx the parse tree

package/dist/lang/lib/Malloy/MalloyParserVisitor.d.ts

@@ -88,7 +88,11 @@ import { MalloyStatementContext } from "./MalloyParser";
 import { DefineSourceStatementContext } from "./MalloyParser";
 import { DefineQueryContext } from "./MalloyParser";
 import { TopLevelAnonQueryDefContext } from "./MalloyParser";
+import { AnnotationContext } from "./MalloyParser";
 import { TagsContext } from "./MalloyParser";
+import { BlockAnnotationContext } from "./MalloyParser";
+import { DocAnnotationContext } from "./MalloyParser";
+import { DocBlockAnnotationContext } from "./MalloyParser";
 import { IsDefineContext } from "./MalloyParser";
 import { RunStatementContext } from "./MalloyParser";
 import { SqlStringContext } from "./MalloyParser";
@@ -871,12 +875,36 @@ export interface MalloyParserVisitor<Result> extends ParseTreeVisitor<Result> {
      * @return the visitor result
      */
     visitTopLevelAnonQueryDef?: (ctx: TopLevelAnonQueryDefContext) => Result;
+    /**
+     * Visit a parse tree produced by `MalloyParser.annotation`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitAnnotation?: (ctx: AnnotationContext) => Result;
     /**
      * Visit a parse tree produced by `MalloyParser.tags`.
      * @param ctx the parse tree
      * @return the visitor result
      */
     visitTags?: (ctx: TagsContext) => Result;
+    /**
+     * Visit a parse tree produced by `MalloyParser.blockAnnotation`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitBlockAnnotation?: (ctx: BlockAnnotationContext) => Result;
+    /**
+     * Visit a parse tree produced by `MalloyParser.docAnnotation`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitDocAnnotation?: (ctx: DocAnnotationContext) => Result;
+    /**
+     * Visit a parse tree produced by `MalloyParser.docBlockAnnotation`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitDocBlockAnnotation?: (ctx: DocBlockAnnotationContext) => Result;
     /**
      * Visit a parse tree produced by `MalloyParser.isDefine`.
      * @param ctx the parse tree

package/dist/lang/malloy-to-ast.d.ts

@@ -1,5 +1,5 @@
 import { ParserRuleContext } from 'antlr4ts';
-import type { ParseTree, TerminalNode } from 'antlr4ts/tree';
+import type { ParseTree } from 'antlr4ts/tree';
 import { AbstractParseTreeVisitor } from 'antlr4ts/tree/AbstractParseTreeVisitor';
 import type { MalloyParserVisitor } from './lib/Malloy/MalloyParserVisitor';
 import type * as parse from './lib/Malloy/MalloyParser';
@@ -21,7 +21,7 @@ declare class IgnoredElement extends ast.MalloyElement {
     constructor(src: string);
 }
 type HasAnnotations = ParserRuleContext & {
-    ANNOTATION: () => TerminalNode[];
+    annotation: () => parse.AnnotationContext[];
 };
 /**
  * ANTLR visitor pattern parse tree traversal. Generates a Malloy
@@ -79,11 +79,7 @@ export declare class MalloyToAST extends AbstractParseTreeVisitor<ast.MalloyElem
      * the parse, make sure it highlights properly
      */
     protected parseTime(pcx: ParserRuleContext, parse: (s: string) => ast.ExpressionDef | undefined): ast.ExpressionDef;
-    /**
-     * Get all the possibly missing annotations from this parse rule
-     * @param cx Any parse context which has an ANNOTATION* rules
-     * @returns Array of texts for the annotations
-     */
+    protected getAnnotation(cx: parse.AnnotationContext): Note;
     protected getNotes(cx: HasAnnotations): Note[];
     protected getIsNotes(cx: parse.IsDefineContext): Note[];
     visitMalloyDocument(pcx: parse.MalloyDocumentContext): ast.Document;

package/dist/lang/malloy-to-ast.js

@@ -99,7 +99,7 @@ class MalloyToAST extends AbstractParseTreeVisitor_1.AbstractParseTreeVisitor {
     }
     getCompilerFlags() {
         if (!this.compilerFlagTag) {
-            this.compilerFlagTag = (0, malloy_tag_1.parseTag)(this.compilerFlagSrc).tag;
+            this.compilerFlagTag = (0, malloy_tag_1.parseAnnotation)(this.compilerFlagSrc).tag;
         }
         return this.compilerFlagTag;
     }
@@ -256,18 +256,16 @@ class MalloyToAST extends AbstractParseTreeVisitor_1.AbstractParseTreeVisitor {
         }
         return this.astAt(def, pcx);
     }
-    /**
-     * Get all the possibly missing annotations from this parse rule
-     * @param cx Any parse context which has an ANNOTATION* rules
-     * @returns Array of texts for the annotations
-     */
-    getNotes(cx) {
-        return cx.ANNOTATION().map(a => {
-            return {
-                text: a.text,
-                at: this.getLocation(cx),
-            };
+    getAnnotation(cx) {
+        const text = (0, parse_utils_1.getAnnotationText)(cx, (wcx, msg) => {
+            this.contextError(wcx, 'block-annotation-warning', msg, {
+                severity: 'warn',
+            });
         });
+        return { text: text, at: this.getLocation(cx) };
+    }
+    getNotes(cx) {
+        return cx.annotation().map(a => this.getAnnotation(a));
     }
     getIsNotes(cx) {
         const before = this.getNotes(cx._beforeIs);
@@ -456,14 +454,14 @@ class MalloyToAST extends AbstractParseTreeVisitor_1.AbstractParseTreeVisitor {
         if (onCx) {
             join.joinOn = this.getFieldExpr(onCx);
         }
-        join.extendNote({ notes: this.getNotes(pcx).concat(notes) });
+        join.extendNote({ notes: this.getNotes(pcx.tags()).concat(notes) });
         return this.astAt(join, pcx);
     }
     visitJoinWith(pcx) {
         const { joinAs, joinFrom, notes } = this.getJoinFrom(pcx.joinFrom());
         const joinOn = this.getFieldExpr(pcx.fieldExpr());
         const join = new ast.KeyJoin(joinAs, joinFrom, joinOn);
-        join.extendNote({ notes: this.getNotes(pcx).concat(notes) });
+        join.extendNote({ notes: this.getNotes(pcx.tags()).concat(notes) });
         return this.astAt(join, pcx);
     }
     getFieldDef(pcx, makeFieldDef) {
@@ -855,7 +853,7 @@ class MalloyToAST extends AbstractParseTreeVisitor_1.AbstractParseTreeVisitor {
     visitExploreQueryDef(pcx) {
         const name = (0, parse_utils_1.getId)(pcx.exploreQueryNameDef());
         const queryDef = new ast.ViewFieldDeclaration(name, this.getVExpr(pcx.vExpr()));
-        const notes = this.getNotes(pcx).concat(this.getIsNotes(pcx.isDefine()));
+        const notes = this.getNotes(pcx.tags()).concat(this.getIsNotes(pcx.isDefine()));
         queryDef.extendNote({ notes });
         return this.astAt(queryDef, pcx);
     }
@@ -1294,7 +1292,7 @@ class MalloyToAST extends AbstractParseTreeVisitor_1.AbstractParseTreeVisitor {
         if (newLines.length > 0) {
             const oldLength = this.compilerFlagSrc.length;
             this.compilerFlagSrc.push(...newLines);
-            const { tag, log } = (0, malloy_tag_1.parseTag)(this.compilerFlagSrc);
+            const { tag, log } = (0, malloy_tag_1.parseAnnotation)(this.compilerFlagSrc);
             this.compilerFlagTag = tag;
             for (const err of log) {
                 if (err.line >= oldLength) {
@@ -1309,22 +1307,44 @@ class MalloyToAST extends AbstractParseTreeVisitor_1.AbstractParseTreeVisitor {
         this.timer.contribute([parseCompilerFlagsTimer.stop()]);
     }
     visitDocAnnotations(pcx) {
-        const allNotes = pcx.DOC_ANNOTATION().map(note => {
-            return {
-                text: note.text,
-                at: this.getLocation(pcx),
-            };
-        });
+        for (const a of pcx.docAnnotation()) {
+            const block = a.docBlockAnnotation();
+            if (block && !block.BLOCK_ANNOTATION_END()) {
+                this.contextError(pcx, 'unclosed-block-annotation', 'Block annotation is not closed, add correctly indented "|##"');
+            }
+        }
+        const allNotes = pcx.docAnnotation().map(a => ({
+            text: (0, parse_utils_1.getAnnotationText)(a),
+            at: this.getLocation(pcx),
+        }));
         const tags = new ast.ModelAnnotation(allNotes);
         this.updateCompilerFlags(tags);
         return tags;
     }
     visitIgnoredObjectAnnotations(pcx) {
-        this.contextError(pcx, 'orphaned-object-annotation', 'Object annotation not connected to any object');
+        const hasUnclosedBlock = pcx.annotation().some(a => {
+            const block = a.blockAnnotation();
+            return block && !block.BLOCK_ANNOTATION_END();
+        });
+        if (hasUnclosedBlock) {
+            this.contextError(pcx, 'unclosed-block-annotation', 'Block annotation is not closed, add correctly indented "|#"');
+        }
+        else {
+            this.contextError(pcx, 'orphaned-object-annotation', 'Object annotation not connected to any object');
+        }
         return new IgnoredElement(pcx.text);
     }
     visitIgnoredModelAnnotations(pcx) {
-        this.contextError(pcx, 'misplaced-model-annotation', 'Model annotations not allowed at this scope');
+        const hasUnclosedBlock = pcx.docAnnotation().some(a => {
+            const block = a.docBlockAnnotation();
+            return block && !block.BLOCK_ANNOTATION_END();
+        });
+        if (hasUnclosedBlock) {
+            this.contextError(pcx, 'unclosed-block-annotation', 'Block annotation is not closed, add correctly indented "|##"');
+        }
+        else {
+            this.contextError(pcx, 'misplaced-model-annotation', 'Model annotations not allowed at this scope');
+        }
         return new IgnoredElement(pcx.text);
     }
     visitDefExploreAnnotation(pcx) {
@@ -1412,7 +1432,7 @@ class MalloyToAST extends AbstractParseTreeVisitor_1.AbstractParseTreeVisitor {
     }
     getExcludeList(pcx) {
         return pcx.includeExceptListItem().map(fcx => {
-            if (fcx.tags().ANNOTATION().length > 0) {
+            if (fcx.tags().annotation().length > 0) {
                 this.contextError(fcx.tags(), 'cannot-tag-include-except', 'Tags on `except:` are ignored', { severity: 'warn' });
             }
             const fieldNameCx = fcx.fieldPath();

package/dist/lang/malloy-to-stable-query.d.ts

@@ -1,5 +1,5 @@
 import { ParserRuleContext } from 'antlr4ts';
-import type { ParseTree, TerminalNode } from 'antlr4ts/tree';
+import type { ParseTree } from 'antlr4ts/tree';
 import { AbstractParseTreeVisitor } from 'antlr4ts/tree/AbstractParseTreeVisitor';
 import type { MalloyParserVisitor } from './lib/Malloy/MalloyParserVisitor';
 import type * as Malloy from '@malloydata/malloy-interfaces';
@@ -9,7 +9,7 @@ import type { DocumentLocation } from '../model/malloy_types';
 import type { ParseInfo } from './utils';
 import type { TimeLiteral } from './ast';
 type HasAnnotations = ParserRuleContext & {
-    ANNOTATION: () => TerminalNode[];
+    annotation: () => parse.AnnotationContext[];
 };
 type Node = Malloy.Query | Malloy.QueryDefinitionWithArrow | Malloy.QueryDefinitionWithQueryReference | Malloy.QueryDefinitionWithRefinement | null;
 /**
@@ -38,7 +38,7 @@ export declare class MalloyToQuery extends AbstractParseTreeVisitor<Node> implem
     protected defaultResult(): Node;
     /**
      * Get all the possibly missing annotations from this parse rule
-     * @param cx Any parse context which has an ANNOTATION* rules
+     * @param cx Any parse context which has an annotation* rule
      * @returns Array of texts for the annotations
      */
     protected getAnnotations(cx: HasAnnotations): Malloy.Annotation[] | undefined;

package/dist/lang/malloy-to-stable-query.js

@@ -97,12 +97,12 @@ class MalloyToQuery extends AbstractParseTreeVisitor_1.AbstractParseTreeVisitor
     }
     /**
      * Get all the possibly missing annotations from this parse rule
-     * @param cx Any parse context which has an ANNOTATION* rules
+     * @param cx Any parse context which has an annotation* rule
      * @returns Array of texts for the annotations
      */
     getAnnotations(cx) {
-        const annotations = cx.ANNOTATION().map(a => {
-            return { value: a.text };
+        const annotations = cx.annotation().map(a => {
+            return { value: (0, parse_utils_1.getAnnotationText)(a) };
         });
         return annotations.length > 0 ? annotations : undefined;
     }

package/dist/lang/parse-log.d.ts

@@ -315,6 +315,8 @@ type MessageParameterTypes = {
     'unexpected-malloy-type': string;
     'failed-to-parse-function-name': string;
     'orphaned-object-annotation': string;
+    'unclosed-block-annotation': string;
+    'block-annotation-warning': string;
     'misplaced-model-annotation': string;
     'unexpected-non-source-query-expression-node': string;
     'sql-not-like': string;

package/dist/lang/parse-malloy.js

@@ -486,7 +486,7 @@ class TranslateStep {
 }
 class MalloyTranslation {
     getCompilerFlags() {
-        return (0, malloy_tag_1.parseTag)(this.compilerFlagSrc).tag;
+        return (0, malloy_tag_1.parseAnnotation)(this.compilerFlagSrc).tag;
     }
     constructor(sourceURL, importBaseURL = null, grammarRule = 'malloyDocument') {
         this.sourceURL = sourceURL;

package/dist/lang/parse-tree-walkers/model-annotation-walker.js

@@ -24,6 +24,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.walkForModelAnnotation = walkForModelAnnotation;
 const ParseTreeWalker_1 = require("antlr4ts/tree/ParseTreeWalker");
+const parse_utils_1 = require("../parse-utils");
 class ModelAnnotationWalker {
     constructor(translator, tokens, parseInfo) {
         this.translator = translator;
@@ -38,12 +39,10 @@ class ModelAnnotationWalker {
         };
     }
     enterDocAnnotations(pcx) {
-        const allNotes = pcx.DOC_ANNOTATION().map(note => {
-            return {
-                text: note.text,
-                at: this.getLocation(pcx),
-            };
-        });
+        const allNotes = pcx.docAnnotation().map(a => ({
+            text: (0, parse_utils_1.getAnnotationText)(a),
+            at: this.getLocation(pcx),
+        }));
         this.notes.push(...allNotes);
     }
     get annotation() {

package/dist/lang/parse-utils.d.ts

@@ -1,5 +1,6 @@
 import type { ParserRuleContext } from 'antlr4ts';
-import type { StringContext, ShortStringContext, SqlStringContext, IdContext } from './lib/Malloy/MalloyParser';
+import type { DocAnnotationContext } from './lib/Malloy/MalloyParser';
+import { type StringContext, type ShortStringContext, type SqlStringContext, type IdContext, AnnotationContext } from './lib/Malloy/MalloyParser';
 /**
  * Take the text of a matched string, including the matching quote
  * characters, and return the actual contents of the string after
@@ -34,4 +35,6 @@ export declare function unIndent(parts: (string | unknown)[]): void;
  * @returns string part and an error list.
  */
 export declare function getPlainString(cx: HasString, strictCheck?: boolean): [string | undefined, ParserRuleContext[]];
+type AnnotationWarn = (cx: ParserRuleContext, msg: string) => void;
+export declare function getAnnotationText(cx: AnnotationContext | DocAnnotationContext, warn?: AnnotationWarn): string;
 export {};

package/dist/lang/parse-utils.js

@@ -30,6 +30,8 @@ exports.idToStr = idToStr;
 exports.getOptionalId = getOptionalId;
 exports.unIndent = unIndent;
 exports.getPlainString = getPlainString;
+exports.getAnnotationText = getAnnotationText;
+const MalloyParser_1 = require("./lib/Malloy/MalloyParser");
 const malloy_tag_1 = require("@malloydata/malloy-tag");
 /**
  * Take the text of a matched string, including the matching quote
@@ -180,4 +182,51 @@ function getPlainString(cx, strictCheck = false) {
     // string: shortString | sqlString; So this will never happen
     return ['', errorList];
 }
+function stripBlockIndent(lines, column, cx, warn) {
+    if (column === 0) {
+        return lines.join('');
+    }
+    const prefix = ' '.repeat(column);
+    let warnedLeft = false;
+    let warnedTab = false;
+    return lines
+        .map(line => {
+        if (warn && !warnedTab && line.slice(0, column).includes('\t')) {
+            warn(cx, 'Block annotation indentation contains tabs, use spaces');
+            warnedTab = true;
+        }
+        if (line.startsWith(prefix)) {
+            return line.slice(column);
+        }
+        if (warn && !warnedLeft && !warnedTab && line.match(/\S/)) {
+            warn(cx, 'Block annotation content is left of the opening #|');
+            warnedLeft = true;
+        }
+        return line;
+    })
+        .join('');
+}
+function stripTrailingNewline(s) {
+    return s.endsWith('\n') ? s.slice(0, -1) : s;
+}
+function getAnnotationText(cx, warn) {
+    if (cx instanceof MalloyParser_1.AnnotationContext) {
+        const annot = cx.ANNOTATION();
+        if (annot)
+            return annot.text;
+        const block = cx.blockAnnotation();
+        const beginToken = block.BLOCK_ANNOTATION_BEGIN();
+        const textLines = block.BLOCK_ANNOTATION_TEXT().map(t => t.text);
+        return stripTrailingNewline(beginToken.text +
+            stripBlockIndent(textLines, beginToken.symbol.charPositionInLine, cx, warn));
+    }
+    const doc = cx.DOC_ANNOTATION();
+    if (doc)
+        return doc.text;
+    const block = cx.docBlockAnnotation();
+    const beginToken = block.DOC_BLOCK_ANNOTATION_BEGIN();
+    const textLines = block.BLOCK_ANNOTATION_TEXT().map(t => t.text);
+    return stripTrailingNewline(beginToken.text +
+        stripBlockIndent(textLines, beginToken.symbol.charPositionInLine, cx, warn));
+}
 //# sourceMappingURL=parse-utils.js.map

package/dist/lang/syntax-errors/malloy-parser-error-listener.js

@@ -22,7 +22,7 @@ const utils_1 = require("../utils");
 exports.malloyCustomErrorCases = [
     {
         errorMessage: "'view:' must be followed by '<identifier> is {'",
-        ruleContextOptions: ['exploreQueryDef'],
+        ruleContextOptions: ['exploreQueryDef', 'exploreQueryNameDef', 'id'],
         offendingSymbol: MalloyParser_1.MalloyParser.OCURLY,
         precedingTokenOptions: [[MalloyParser_1.MalloyParser.VIEW], [MalloyParser_1.MalloyParser.COLON]],
     },

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const MALLOY_VERSION = "0.0.360";
+export declare const MALLOY_VERSION = "0.0.361";

package/dist/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MALLOY_VERSION = void 0;
 // generated with 'generate-version-file' script; do not edit manually
-exports.MALLOY_VERSION = '0.0.360';
+exports.MALLOY_VERSION = '0.0.361';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@malloydata/malloy",
-  "version": "0.0.360",
+  "version": "0.0.361",
   "license": "MIT",
   "exports": {
     ".": "./dist/index.js",
@@ -47,9 +47,9 @@
     "generate-version-file": "VERSION=$(npm pkg get version --workspaces=false | tr -d \\\")\necho \"// generated with 'generate-version-file' script; do not edit manually\\nexport const MALLOY_VERSION = '$VERSION';\" > src/version.ts"
   },
   "dependencies": {
-    "@malloydata/malloy-filter": "0.0.360",
-    "@malloydata/malloy-interfaces": "0.0.360",
-    "@malloydata/malloy-tag": "0.0.360",
+    "@malloydata/malloy-filter": "0.0.361",
+    "@malloydata/malloy-interfaces": "0.0.361",
+    "@malloydata/malloy-tag": "0.0.361",
     "@noble/hashes": "^1.8.0",
     "antlr4ts": "^0.5.0-alpha.4",
     "assert": "^2.0.0",