@cratis/screenplay-language 4.1.0 → 4.2.0

package/dist/file-references.d.ts

@@ -0,0 +1,11 @@
+export declare const fileReferenceKeyword = "file";
+export interface FileReference {
+    path: string;
+    line: number;
+    startColumn: number;
+    endColumn: number;
+}
+export declare function isAbsoluteFileReferencePath(path: string): boolean;
+export declare function fileReferenceOn(line: string, lineIndex: number): FileReference | undefined;
+export declare function fileReferences(lines: string[]): FileReference[];
+//# sourceMappingURL=file-references.d.ts.map

package/dist/file-references.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-references.d.ts","sourceRoot":"","sources":["../file-references.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,oBAAoB,SAAS,CAAC;AAK3C,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACrB;AAYD,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEjE;AA0BD,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAe1F;AAID,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,aAAa,EAAE,CAW/D"}

package/dist/file-references.js

@@ -0,0 +1,70 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+import { fenceMap, firstWord, indentOf } from './document-context';
+// The keyword the directive opens with — the single word the language points at a file with.
+export const fileReferenceKeyword = 'file';
+// `file String` is a property named `file`; `file Invoices/Register.cs` is the directive. The two are
+// told apart by shape, the way the compiler tells them apart: a type reference is a bare identifier,
+// so anything carrying a separator or an extension is a path and nothing else. The property wins the
+// tie, because a document that used the name before the directive existed keeps meaning what it meant.
+const typeReferencePattern = /^[A-Za-z_]\w*(?:\[\])?\??$/;
+// A path naming a place on one machine rather than a place in the repository. The compiler warns about
+// these; nothing here rejects one, so a resolver can still probe it and come up empty on other machines.
+const absolutePathPattern = /^(?:[/\\]|[A-Za-z]:[/\\]|~[/\\])/;
+export function isAbsoluteFileReferencePath(path) {
+    return absolutePathPattern.test(path);
+}
+// Drops a trailing `//` comment without cutting into a string or a template, mirroring how the
+// compiler strips one before it reads the line.
+function withoutComment(text) {
+    let inString = false;
+    let inTemplate = false;
+    for (let index = 0; index < text.length; index++) {
+        const current = text[index];
+        if (current === '\\' && inString && index + 1 < text.length) {
+            index++;
+        }
+        else if (current === '"' && !inTemplate) {
+            inString = !inString;
+        }
+        else if (current === '`' && !inString) {
+            inTemplate = !inTemplate;
+        }
+        else if (!inString && !inTemplate && current === '/' && text[index + 1] === '/') {
+            return text.slice(0, index);
+        }
+    }
+    return text;
+}
+// The `file` directive on a single line, or undefined when the line is not one. Callers that scan a
+// whole document go through fileReferences instead, so code fences are accounted for.
+export function fileReferenceOn(line, lineIndex) {
+    const indent = indentOf(line);
+    const content = withoutComment(line.slice(indent)).trimEnd();
+    if (firstWord(content) !== fileReferenceKeyword)
+        return undefined;
+    const afterKeyword = content.slice(fileReferenceKeyword.length);
+    const path = afterKeyword.trim();
+    // A bare `file` leaves the word available as a name to whatever the enclosing block reads a bare
+    // word as, and a bare identifier after it is a property type rather than a path.
+    if (path.length === 0 || typeReferencePattern.test(path))
+        return undefined;
+    const separatorLength = afterKeyword.length - afterKeyword.trimStart().length;
+    const startColumn = indent + fileReferenceKeyword.length + separatorLength + 1;
+    return { path, line: lineIndex, startColumn, endColumn: startColumn + path.length };
+}
+// Every `file` directive in a document, in document order. Lines inside a code fence are skipped, so
+// a `file` line in an inline C# or TypeScript block is never mistaken for one of ours.
+export function fileReferences(lines) {
+    const fences = fenceMap(lines);
+    const references = [];
+    for (let index = 0; index < lines.length; index++) {
+        if (fences[index])
+            continue;
+        const reference = fileReferenceOn(lines[index], index);
+        if (reference)
+            references.push(reference);
+    }
+    return references;
+}
+//# sourceMappingURL=file-references.js.map

package/dist/file-references.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-references.js","sourceRoot":"","sources":["../file-references.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG;AAErG,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEnE,6FAA6F;AAC7F,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAY3C,sGAAsG;AACtG,qGAAqG;AACrG,qGAAqG;AACrG,uGAAuG;AACvG,MAAM,oBAAoB,GAAG,4BAA4B,CAAC;AAE1D,uGAAuG;AACvG,yGAAyG;AACzG,MAAM,mBAAmB,GAAG,kCAAkC,CAAC;AAE/D,MAAM,UAAU,2BAA2B,CAAC,IAAY;IACpD,OAAO,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC;AAED,+FAA+F;AAC/F,gDAAgD;AAChD,SAAS,cAAc,CAAC,IAAY;IAChC,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,UAAU,GAAG,KAAK,CAAC;IAEvB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5B,IAAI,OAAO,KAAK,IAAI,IAAI,QAAQ,IAAI,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1D,KAAK,EAAE,CAAC;QACZ,CAAC;aAAM,IAAI,OAAO,KAAK,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,QAAQ,GAAG,CAAC,QAAQ,CAAC;QACzB,CAAC;aAAM,IAAI,OAAO,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtC,UAAU,GAAG,CAAC,UAAU,CAAC;QAC7B,CAAC;aAAM,IAAI,CAAC,QAAQ,IAAI,CAAC,UAAU,IAAI,OAAO,KAAK,GAAG,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YAChF,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,oGAAoG;AACpG,sFAAsF;AACtF,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,SAAiB;IAC3D,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC7D,IAAI,SAAS,CAAC,OAAO,CAAC,KAAK,oBAAoB;QAAE,OAAO,SAAS,CAAC;IAElE,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAChE,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,CAAC;IAEjC,iGAAiG;IACjG,iFAAiF;IACjF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,SAAS,CAAC;IAE3E,MAAM,eAAe,GAAG,YAAY,CAAC,MAAM,GAAG,YAAY,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC;IAC9E,MAAM,WAAW,GAAG,MAAM,GAAG,oBAAoB,CAAC,MAAM,GAAG,eAAe,GAAG,CAAC,CAAC;IAC/E,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;AACxF,CAAC;AAED,qGAAqG;AACrG,uFAAuF;AACvF,MAAM,UAAU,cAAc,CAAC,KAAe;IAC1C,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC/B,MAAM,UAAU,GAAoB,EAAE,CAAC;IAEvC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QAChD,IAAI,MAAM,CAAC,KAAK,CAAC;YAAE,SAAS;QAC5B,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QACvD,IAAI,SAAS;YAAE,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,UAAU,CAAC;AACtB,CAAC"}

package/dist/index.d.ts

@@ -10,6 +10,8 @@ export { cdl } from './sub-languages/cdl';
 export { screenplayDarkThemeName } from './themes/screenplay-dark';
 export { screenplayLightThemeName } from './themes/screenplay-light';
 export { enclosingChain, fenceMap, firstWord, indentOf } from './document-context';
+export { fileReferenceKeyword, fileReferenceOn, fileReferences, isAbsoluteFileReferencePath, } from './file-references';
+export type { FileReference } from './file-references';
 export { builtInTriggerNames, knownEventNames, knownTriggerNames, knownTypeNames, scanDocument } from './symbols';
 export type { CommandSymbol, ConceptSymbol, DocumentSymbols, EventSymbol, ImportSymbol, NamedSymbol, PolicySymbol, PropertySymbol, QuerySymbol, TypeSymbol, } from './symbols';
 export { attributeDocs, contextVariableDocs, keywordDocs } from './keyword-docs';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAGA,OAAO,EACH,MAAM,EAIT,MAAM,YAAY,CAAC;AA2BpB,wBAAgB,yBAAyB,IAAI,IAAI,CAGhD;AAED,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAe7C;AAED,OAAO,EACH,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,YAAY,EACZ,UAAU,EACV,cAAc,EACd,UAAU,GACb,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC/F,YAAY,EACR,iBAAiB,EACjB,WAAW,EACX,qBAAqB,EACrB,qBAAqB,GACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,iBAAiB,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAClH,YAAY,EACR,aAAa,EACb,aAAa,EACb,eAAe,EACf,WAAW,EACX,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,cAAc,EACd,WAAW,EACX,UAAU,GACb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACjF,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACzE,YAAY,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC7E,YAAY,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,YAAY,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAGA,OAAO,EACH,MAAM,EAIT,MAAM,YAAY,CAAC;AA2BpB,wBAAgB,yBAAyB,IAAI,IAAI,CAGhD;AAED,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAe7C;AAED,OAAO,EACH,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,YAAY,EACZ,UAAU,EACV,cAAc,EACd,UAAU,GACb,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC/F,YAAY,EACR,iBAAiB,EACjB,WAAW,EACX,qBAAqB,EACrB,qBAAqB,GACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACnF,OAAO,EACH,oBAAoB,EACpB,eAAe,EACf,cAAc,EACd,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,iBAAiB,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAClH,YAAY,EACR,aAAa,EACb,aAAa,EACb,eAAe,EACf,WAAW,EACX,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,cAAc,EACd,WAAW,EACX,UAAU,GACb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACjF,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACzE,YAAY,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC7E,YAAY,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,YAAY,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -45,6 +45,7 @@ export { cdl } from './sub-languages/cdl';
 export { screenplayDarkThemeName } from './themes/screenplay-dark';
 export { screenplayLightThemeName } from './themes/screenplay-light';
 export { enclosingChain, fenceMap, firstWord, indentOf } from './document-context';
+export { fileReferenceKeyword, fileReferenceOn, fileReferences, isAbsoluteFileReferencePath, } from './file-references';
 export { builtInTriggerNames, knownEventNames, knownTriggerNames, knownTypeNames, scanDocument } from './symbols';
 export { attributeDocs, contextVariableDocs, keywordDocs } from './keyword-docs';
 export { contextVariableItems, producesItems } from './completion-items';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG;AAErG,OAAO,EAEH,qBAAqB,EACrB,sBAAsB,EACtB,UAAU,GACb,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EACH,cAAc,EACd,eAAe,EACf,qBAAqB,EACrB,mBAAmB,GACtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AACnF,OAAO,EAAE,eAAe,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAEtF,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAU,CAAC;AAE9C,SAAS,mBAAmB,CAAC,MAAc;IACvC,MAAM,CAAC,SAAS,CAAC,wBAAwB,CAAC,UAAU,EAAE,oBAAoB,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;AACnG,CAAC;AAED,gFAAgF;AAChF,qBAAqB,CAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC;AAE9E,iFAAiF;AACjF,mFAAmF;AACnF,MAAM,UAAU,yBAAyB;IACrC,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC;QAAE,mBAAmB,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAC1E,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC;QAAE,mBAAmB,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAc;IACnC,IAAI,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC;QAAE,OAAO;IAE5C,yBAAyB,EAAE,CAAC;IAE5B,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAEhC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC;IAClD,MAAM,CAAC,SAAS,CAAC,wBAAwB,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC;IAC7E,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,CAAC,SAAS,CAAC,8BAA8B,CAAC,UAAU,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9F,MAAM,CAAC,SAAS,CAAC,qBAAqB,CAAC,UAAU,EAAE,mBAAmB,EAAE,CAAC,CAAC;IAC1E,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,uBAAuB,EAAE,cAAc,CAAC,CAAC;IACnE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,wBAAwB,EAAE,eAAe,CAAC,CAAC;IACrE,iBAAiB,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED,OAAO,EACH,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,YAAY,EACZ,UAAU,EACV,cAAc,EACd,UAAU,GACb,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAO/F,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,iBAAiB,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAalH,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACjF,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEzE,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE7E,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG;AAErG,OAAO,EAEH,qBAAqB,EACrB,sBAAsB,EACtB,UAAU,GACb,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EACH,cAAc,EACd,eAAe,EACf,qBAAqB,EACrB,mBAAmB,GACtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AACnF,OAAO,EAAE,eAAe,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAEtF,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAU,CAAC;AAE9C,SAAS,mBAAmB,CAAC,MAAc;IACvC,MAAM,CAAC,SAAS,CAAC,wBAAwB,CAAC,UAAU,EAAE,oBAAoB,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;AACnG,CAAC;AAED,gFAAgF;AAChF,qBAAqB,CAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC;AAE9E,iFAAiF;AACjF,mFAAmF;AACnF,MAAM,UAAU,yBAAyB;IACrC,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC;QAAE,mBAAmB,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAC1E,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC;QAAE,mBAAmB,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAc;IACnC,IAAI,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC;QAAE,OAAO;IAE5C,yBAAyB,EAAE,CAAC;IAE5B,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAEhC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC;IAClD,MAAM,CAAC,SAAS,CAAC,wBAAwB,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC;IAC7E,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,CAAC,SAAS,CAAC,8BAA8B,CAAC,UAAU,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9F,MAAM,CAAC,SAAS,CAAC,qBAAqB,CAAC,UAAU,EAAE,mBAAmB,EAAE,CAAC,CAAC;IAC1E,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,uBAAuB,EAAE,cAAc,CAAC,CAAC;IACnE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,wBAAwB,EAAE,eAAe,CAAC,CAAC;IACrE,iBAAiB,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED,OAAO,EACH,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,YAAY,EACZ,UAAU,EACV,cAAc,EACd,UAAU,GACb,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAO/F,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACnF,OAAO,EACH,oBAAoB,EACpB,eAAe,EACf,cAAc,EACd,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,iBAAiB,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAalH,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACjF,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEzE,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE7E,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC"}

package/file-references.ts

@@ -0,0 +1,87 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { fenceMap, firstWord, indentOf } from './document-context';
+
+// The keyword the directive opens with — the single word the language points at a file with.
+export const fileReferenceKeyword = 'file';
+
+// A `file <path>` directive, with the path exactly as written and the span it occupies on its line.
+// The span is measured against the raw line, and its columns are one-based like every other position
+// this package reports, so an editor places a range on it the same way it does a validation issue.
+export interface FileReference {
+    path: string;
+    line: number;
+    startColumn: number;
+    endColumn: number;
+}
+
+// `file String` is a property named `file`; `file Invoices/Register.cs` is the directive. The two are
+// told apart by shape, the way the compiler tells them apart: a type reference is a bare identifier,
+// so anything carrying a separator or an extension is a path and nothing else. The property wins the
+// tie, because a document that used the name before the directive existed keeps meaning what it meant.
+const typeReferencePattern = /^[A-Za-z_]\w*(?:\[\])?\??$/;
+
+// A path naming a place on one machine rather than a place in the repository. The compiler warns about
+// these; nothing here rejects one, so a resolver can still probe it and come up empty on other machines.
+const absolutePathPattern = /^(?:[/\\]|[A-Za-z]:[/\\]|~[/\\])/;
+
+export function isAbsoluteFileReferencePath(path: string): boolean {
+    return absolutePathPattern.test(path);
+}
+
+// Drops a trailing `//` comment without cutting into a string or a template, mirroring how the
+// compiler strips one before it reads the line.
+function withoutComment(text: string): string {
+    let inString = false;
+    let inTemplate = false;
+
+    for (let index = 0; index < text.length; index++) {
+        const current = text[index];
+        if (current === '\\' && inString && index + 1 < text.length) {
+            index++;
+        } else if (current === '"' && !inTemplate) {
+            inString = !inString;
+        } else if (current === '`' && !inString) {
+            inTemplate = !inTemplate;
+        } else if (!inString && !inTemplate && current === '/' && text[index + 1] === '/') {
+            return text.slice(0, index);
+        }
+    }
+
+    return text;
+}
+
+// The `file` directive on a single line, or undefined when the line is not one. Callers that scan a
+// whole document go through fileReferences instead, so code fences are accounted for.
+export function fileReferenceOn(line: string, lineIndex: number): FileReference | undefined {
+    const indent = indentOf(line);
+    const content = withoutComment(line.slice(indent)).trimEnd();
+    if (firstWord(content) !== fileReferenceKeyword) return undefined;
+
+    const afterKeyword = content.slice(fileReferenceKeyword.length);
+    const path = afterKeyword.trim();
+
+    // A bare `file` leaves the word available as a name to whatever the enclosing block reads a bare
+    // word as, and a bare identifier after it is a property type rather than a path.
+    if (path.length === 0 || typeReferencePattern.test(path)) return undefined;
+
+    const separatorLength = afterKeyword.length - afterKeyword.trimStart().length;
+    const startColumn = indent + fileReferenceKeyword.length + separatorLength + 1;
+    return { path, line: lineIndex, startColumn, endColumn: startColumn + path.length };
+}
+
+// Every `file` directive in a document, in document order. Lines inside a code fence are skipped, so
+// a `file` line in an inline C# or TypeScript block is never mistaken for one of ours.
+export function fileReferences(lines: string[]): FileReference[] {
+    const fences = fenceMap(lines);
+    const references: FileReference[] = [];
+
+    for (let index = 0; index < lines.length; index++) {
+        if (fences[index]) continue;
+        const reference = fileReferenceOn(lines[index], index);
+        if (reference) references.push(reference);
+    }
+
+    return references;
+}

package/for_fileReferences/when_recognizing_an_absolute_path/with_paths_of_every_shape.ts

@@ -0,0 +1,26 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { describe, it } from 'vitest';
+import { isAbsoluteFileReferencePath } from '../../file-references';
+
+// A reference is relative to the repository root, so it means the same thing on every machine. An
+// absolute one names a place on one machine and is wrong without looking anything up.
+describe('when recognizing an absolute path', () => {
+    it('should recognize a posix path', () => {
+        isAbsoluteFileReferencePath('/Users/someone/Invoices/Register.cs').should.be.true;
+    });
+
+    it('should recognize a windows path', () => {
+        isAbsoluteFileReferencePath('C:/repos/Invoices/Register.cs').should.be.true;
+        isAbsoluteFileReferencePath('C:\\repos\\Invoices\\Register.cs').should.be.true;
+    });
+
+    it('should recognize a home-relative path', () => {
+        isAbsoluteFileReferencePath('~/repos/Invoices/Register.cs').should.be.true;
+    });
+
+    it('should not recognize a repository-relative path', () => {
+        isAbsoluteFileReferencePath('Invoices/Register.cs').should.be.false;
+    });
+});

package/for_fileReferences/when_scanning_a_document/inside_a_code_fence.ts

@@ -0,0 +1,26 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { describe, beforeEach, it } from 'vitest';
+import { FileReference, fileReferences } from '../../file-references';
+
+// An inline C# block may well contain the word `file` at the start of a line — it is a C# modifier —
+// and none of it is Screenplay.
+describe('when scanning a document with a file line inside a code fence', () => {
+    let result: FileReference[];
+
+    beforeEach(() => {
+        result = fileReferences([
+            'handler',
+            '    ```',
+            '    file static class Helpers/NotAPath.cs',
+            '    ```',
+            '    file Handlers/Real.cs',
+        ]);
+    });
+
+    it('should find only the reference outside the fence', () => {
+        result.should.have.lengthOf(1);
+        result[0].path.should.equal('Handlers/Real.cs');
+    });
+});

package/for_fileReferences/when_scanning_a_document/with_a_bare_file_keyword.ts

@@ -0,0 +1,19 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { describe, beforeEach, it } from 'vitest';
+import { FileReference, fileReferences } from '../../file-references';
+
+// A bare `file` carries no path, so it leaves the word available as a name to whatever the enclosing
+// block reads a bare word as.
+describe('when scanning a document with a bare file keyword', () => {
+    let result: FileReference[];
+
+    beforeEach(() => {
+        result = fileReferences(['reaction', '    file', '    file   ', 'filename Something.cs']);
+    });
+
+    it('should find no reference', () => {
+        result.should.be.empty;
+    });
+});

package/for_fileReferences/when_scanning_a_document/with_a_file_directive.ts

@@ -0,0 +1,30 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { describe, beforeEach, it } from 'vitest';
+import { FileReference, fileReferences } from '../../file-references';
+
+describe('when scanning a document with a file directive', () => {
+    let result: FileReference[];
+
+    beforeEach(() => {
+        result = fileReferences(['command RegisterInvoice', '    handler', '        file Handlers/RegisterInvoice.cs']);
+    });
+
+    it('should find the reference', () => {
+        result.should.have.lengthOf(1);
+    });
+
+    it('should carry the declared path verbatim', () => {
+        result[0].path.should.equal('Handlers/RegisterInvoice.cs');
+    });
+
+    it('should report the line it sits on', () => {
+        result[0].line.should.equal(2);
+    });
+
+    it('should span the path and not the keyword', () => {
+        result[0].startColumn.should.equal(14);
+        result[0].endColumn.should.equal(14 + 'Handlers/RegisterInvoice.cs'.length);
+    });
+});

package/for_fileReferences/when_scanning_a_document/with_a_property_named_file.ts

@@ -0,0 +1,25 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { describe, beforeEach, it } from 'vitest';
+import { FileReference, fileReferences } from '../../file-references';
+
+// `file String` declares a property called `file`; only a path is the directive. The two are told
+// apart by shape, and the property has to keep winning the tie.
+describe('when scanning a document with a property named file', () => {
+    let result: FileReference[];
+
+    beforeEach(() => {
+        result = fileReferences([
+            'type Attachment',
+            '    file String',
+            '    name String',
+            '    thumbnails String[]',
+            '    caption String?',
+        ]);
+    });
+
+    it('should find no reference', () => {
+        result.should.be.empty;
+    });
+});

package/for_fileReferences/when_scanning_a_document/with_a_trailing_comment.ts

@@ -0,0 +1,25 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { describe, beforeEach, it } from 'vitest';
+import { FileReference, fileReferences } from '../../file-references';
+
+describe('when scanning a document with a trailing comment after a file directive', () => {
+    let result: FileReference[];
+
+    beforeEach(() => {
+        result = fileReferences(['    file Screens/InvoiceLineReport.tsx  // generated by Arc']);
+    });
+
+    it('should find the reference', () => {
+        result.should.have.lengthOf(1);
+    });
+
+    it('should leave the comment out of the path', () => {
+        result[0].path.should.equal('Screens/InvoiceLineReport.tsx');
+    });
+
+    it('should span only the path', () => {
+        result[0].endColumn.should.equal(result[0].startColumn + 'Screens/InvoiceLineReport.tsx'.length);
+    });
+});

package/for_fileReferences/when_scanning_a_document/with_directives_on_several_constructs.ts

@@ -0,0 +1,41 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { describe, beforeEach, it } from 'vitest';
+import { FileReference, fileReferences } from '../../file-references';
+
+// The shape a captured application actually has — the directive appears under validation rules,
+// constraints, handlers, screens, performers and reactions alike, at whatever depth they sit.
+describe('when scanning a document with directives on several constructs', () => {
+    let result: FileReference[];
+
+    beforeEach(() => {
+        result = fileReferences([
+            'rule BeUnusedInvoiceNumber',
+            '            file Validations/BeUnusedInvoiceNumber.cs',
+            'constraint InvoiceStatusTransition',
+            '        file Constraints/InvoiceStatusTransitionConstraint.cs',
+            'screen InvoiceLineReport',
+            '        file Screens/InvoiceLineReport.tsx',
+            'performer',
+            '          file Queries/InvoiceSummaryPerformer.cs',
+        ]);
+    });
+
+    it('should find every reference', () => {
+        result.should.have.lengthOf(4);
+    });
+
+    it('should find them in document order', () => {
+        result.map((reference) => reference.path).should.deep.equal([
+            'Validations/BeUnusedInvoiceNumber.cs',
+            'Constraints/InvoiceStatusTransitionConstraint.cs',
+            'Screens/InvoiceLineReport.tsx',
+            'Queries/InvoiceSummaryPerformer.cs',
+        ]);
+    });
+
+    it('should report the line each one sits on', () => {
+        result.map((reference) => reference.line).should.deep.equal([1, 3, 5, 7]);
+    });
+});

package/index.ts

@@ -79,6 +79,13 @@ export { cdl } from './sub-languages/cdl';
 export { screenplayDarkThemeName } from './themes/screenplay-dark';
 export { screenplayLightThemeName } from './themes/screenplay-light';
 export { enclosingChain, fenceMap, firstWord, indentOf } from './document-context';
+export {
+    fileReferenceKeyword,
+    fileReferenceOn,
+    fileReferences,
+    isAbsoluteFileReferencePath,
+} from './file-references';
+export type { FileReference } from './file-references';
 export { builtInTriggerNames, knownEventNames, knownTriggerNames, knownTypeNames, scanDocument } from './symbols';
 export type {
     CommandSymbol,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cratis/screenplay-language",
-    "version": "4.1.0",
+    "version": "4.2.0",
     "description": "Monaco language service for the Cratis Screenplay DSL — syntax highlighting, IntelliSense, hover and diagnostics for .play files",
     "license": "MIT",
     "repository": {
@@ -33,16 +33,20 @@
         "**/*.ts"
     ],
     "scripts": {
-        "build": "tsc -p tsconfig.json",
+        "build": "tsc -p tsconfig.build.json",
         "compile": "tsc --noEmit -p tsconfig.json",
         "lint": "yarn g:lint",
-        "lint:ci": "yarn g:lint:ci"
+        "lint:ci": "yarn g:lint:ci",
+        "test": "vitest run"
     },
     "peerDependencies": {
         "monaco-editor": ">=0.44.0"
     },
     "devDependencies": {
+        "@types/chai": "^5.2.3",
+        "chai": "^6.2.2",
         "monaco-editor": "^0.55.1",
-        "typescript": "6.0.3"
+        "typescript": "6.0.3",
+        "vitest": "^4.1.11"
     }
 }

package/vitest.setup.ts

@@ -0,0 +1,5 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// Installs Chai's `.should` fluent interface, which every spec asserts through.
+import 'chai/register-should';