@spyglassmc/core 0.1.1 → 0.3.0

package/lib/service/Config.js

@@ -1,15 +1,7 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigService = exports.VanillaConfig = exports.SymbolLinterConfig = exports.LinterConfigValue = exports.LinterSeverity = void 0;
-const events_1 = __importDefault(require("events"));
-const fs_1 = require("fs");
-const rfdc_1 = __importDefault(require("rfdc"));
-const common_1 = require("../common");
-const symbol_1 = require("../symbol");
-var LinterSeverity;
+import rfdc from 'rfdc';
+import { Arrayable, bufferToString, TypePredicates } from '../common/index.js';
+import { FileCategories, RegistryCategories } from '../symbol/index.js';
+export var LinterSeverity;
 (function (LinterSeverity) {
     function is(value) {
         return value === 'hint' ||
@@ -21,18 +13,18 @@ var LinterSeverity;
     function toErrorSeverity(value) {
         switch (value) {
             case 'error':
-                return 3 /* Error */;
+                return 3 /* ErrorSeverity.Error */;
             case 'hint':
-                return 0 /* Hint */;
+                return 0 /* ErrorSeverity.Hint */;
             case 'information':
-                return 1 /* Information */;
+                return 1 /* ErrorSeverity.Information */;
             case 'warning':
-                return 2 /* Warning */;
+                return 2 /* ErrorSeverity.Warning */;
         }
     }
     LinterSeverity.toErrorSeverity = toErrorSeverity;
-})(LinterSeverity = exports.LinterSeverity || (exports.LinterSeverity = {}));
-var LinterConfigValue;
+})(LinterSeverity || (LinterSeverity = {}));
+export var LinterConfigValue;
 (function (LinterConfigValue) {
     function destruct(value) {
         if (value === null || value === undefined) {
@@ -51,16 +43,16 @@ var LinterConfigValue;
             };
         }
         return {
-            ruleSeverity: 2 /* Warning */,
+            ruleSeverity: 2 /* ErrorSeverity.Warning */,
             ruleValue: value,
         };
     }
     LinterConfigValue.destruct = destruct;
-})(LinterConfigValue = exports.LinterConfigValue || (exports.LinterConfigValue = {}));
-var SymbolLinterConfig;
+})(LinterConfigValue || (LinterConfigValue = {}));
+export var SymbolLinterConfig;
 (function (SymbolLinterConfig) {
     function is(value) {
-        return common_1.Arrayable.is(value, Complex.is) || Action.is(value);
+        return Arrayable.is(value, Complex.is) || Action.is(value);
     }
     SymbolLinterConfig.is = is;
     let Complex;
@@ -70,9 +62,9 @@ var SymbolLinterConfig;
                 return false;
             }
             const value = v;
-            return ((value.if === undefined || common_1.Arrayable.is(value.if, Condition.is)) &&
+            return ((value.if === undefined || Arrayable.is(value.if, Condition.is)) &&
                 (value.then === undefined || Action.is(value.then)) &&
-                (value.override === undefined || common_1.Arrayable.is(value.override, Complex.is)));
+                (value.override === undefined || Arrayable.is(value.override, Complex.is)));
         }
         Complex.is = is;
     })(Complex = SymbolLinterConfig.Complex || (SymbolLinterConfig.Complex = {}));
@@ -83,11 +75,11 @@ var SymbolLinterConfig;
                 return false;
             }
             const value = v;
-            return ((value.category === undefined || common_1.Arrayable.is(value.category, common_1.TypePredicates.isString)) &&
-                (value.pattern === undefined || common_1.Arrayable.is(value.pattern, common_1.TypePredicates.isString)) &&
-                (value.excludePattern === undefined || common_1.Arrayable.is(value.excludePattern, common_1.TypePredicates.isString)) &&
-                (value.namespace === undefined || common_1.Arrayable.is(value.namespace, common_1.TypePredicates.isString)) &&
-                (value.excludeNamespace === undefined || common_1.Arrayable.is(value.excludeNamespace, common_1.TypePredicates.isString)));
+            return ((value.category === undefined || Arrayable.is(value.category, TypePredicates.isString)) &&
+                (value.pattern === undefined || Arrayable.is(value.pattern, TypePredicates.isString)) &&
+                (value.excludePattern === undefined || Arrayable.is(value.excludePattern, TypePredicates.isString)) &&
+                (value.namespace === undefined || Arrayable.is(value.namespace, TypePredicates.isString)) &&
+                (value.excludeNamespace === undefined || Arrayable.is(value.excludeNamespace, TypePredicates.isString)));
         }
         Condition.is = is;
     })(Condition = SymbolLinterConfig.Condition || (SymbolLinterConfig.Condition = {}));
@@ -110,15 +102,15 @@ var SymbolLinterConfig;
         }
         Action.is = is;
     })(Action = SymbolLinterConfig.Action || (SymbolLinterConfig.Action = {}));
-})(SymbolLinterConfig = exports.SymbolLinterConfig || (exports.SymbolLinterConfig = {}));
+})(SymbolLinterConfig || (SymbolLinterConfig = {}));
 /**
 * Config which simulates the default vanilla command system.
 */
-exports.VanillaConfig = {
+export const VanillaConfig = {
     env: {
         dataSource: 'GitHub',
         dependencies: [
-            '@mc-nbtdoc',
+            '@vanilla-mcdoc',
         ],
         feature: {
             codeActions: true,
@@ -195,8 +187,8 @@ exports.VanillaConfig = {
         undeclaredSymbol: [
             {
                 if: [
-                    { category: symbol_1.RegistryCategories, namespace: 'minecraft' },
-                    { category: [...symbol_1.FileCategories, 'bossbar', 'objective', 'team'] },
+                    { category: RegistryCategories, namespace: 'minecraft' },
+                    { category: [...FileCategories, 'bossbar', 'objective', 'team'] },
                 ],
                 then: { report: 'warning' },
             },
@@ -210,10 +202,18 @@ exports.VanillaConfig = {
         summonAec: 'summon minecraft:area_effect_cloud ~ ~ ~ {Age: -2147483648, Duration: -1, WaitTime: -2147483648, Tags: ["${1:tag}"]}',
     },
 };
-class ConfigService extends events_1.default {
-    constructor(project) {
-        super();
+export class ConfigService {
+    project;
+    defaultConfig;
+    static ConfigFileNames = Object.freeze([
+        'spyglass.json',
+        '.spyglassrc.json',
+    ]);
+    #eventEmitter;
+    constructor(project, defaultConfig = VanillaConfig) {
         this.project = project;
+        this.defaultConfig = defaultConfig;
+        this.#eventEmitter = new project.externals.event.EventEmitter();
         const handler = async ({ uri }) => {
             if (ConfigService.isConfigFile(uri)) {
                 this.emit('changed', { config: await this.load() });
@@ -223,31 +223,41 @@ class ConfigService extends events_1.default {
         project.on('fileModified', handler);
         project.on('fileDeleted', handler);
     }
+    on(event, callbackFn) {
+        this.#eventEmitter.on(event, callbackFn);
+        return this;
+    }
+    once(event, callbackFn) {
+        this.#eventEmitter.once(event, callbackFn);
+        return this;
+    }
+    emit(event, ...args) {
+        return this.#eventEmitter.emit(event, ...args);
+    }
     async load() {
-        let ans = exports.VanillaConfig;
+        let ans = this.defaultConfig;
         for (const name of ConfigService.ConfigFileNames) {
-            const uriString = this.project.projectRoot + name;
-            const uri = new common_1.Uri(uriString);
+            const uri = this.project.projectRoot + name;
             try {
-                ans = JSON.parse((0, common_1.bufferToString)(await fs_1.promises.readFile(uri)));
+                ans = JSON.parse(bufferToString(await this.project.externals.fs.readFile(uri)));
             }
             catch (e) {
-                if ((0, common_1.isEnoent)(e)) {
+                if (this.project.externals.error.isKind(e, 'ENOENT')) {
                     // File doesn't exist.
                     continue;
                 }
-                this.emit('error', { error: e, uri: uriString });
+                this.emit('error', { error: e, uri });
             }
             break;
         }
-        return this.merge(exports.VanillaConfig, ans);
+        return ConfigService.merge(this.defaultConfig, ans);
     }
     static isConfigFile(uri) {
         return ConfigService.ConfigFileNames.some(n => uri.endsWith(`/${n}`));
     }
-    merge(base, ...overrides) {
+    static merge(base, ...overrides) {
         // FIXME
-        const ans = (0, rfdc_1.default)()(base);
+        const ans = rfdc()(base);
         for (const override of overrides) {
             for (const key of ['env', 'format', 'lint', 'snippet']) {
                 ans[key] = { ...ans[key], ...override[key] };
@@ -256,9 +266,4 @@ class ConfigService extends events_1.default {
         return ans;
     }
 }
-exports.ConfigService = ConfigService;
-ConfigService.ConfigFileNames = Object.freeze([
-    'spyglass.json',
-    '.spyglassrc.json',
-]);
 //# sourceMappingURL=Config.js.map

package/lib/service/Context.d.ts

@@ -1,22 +1,21 @@
 import type { TextDocument } from 'vscode-languageserver-textdocument';
-import type { LinterErrorReporter } from '.';
-import type { Range } from '../source';
-import { ReadonlySource } from '../source';
-import type { SymbolTable, SymbolUtil } from '../symbol';
-import type { Config } from './Config';
-import { ErrorReporter } from './ErrorReporter';
-import type { FileService } from './FileService';
-import type { RootUriString } from './fileUtil';
-import type { Logger } from './Logger';
-import type { MetaRegistry } from './MetaRegistry';
-import { Operations } from './Operations';
-import type { DocAndNode, ProjectData } from './Project';
+import type { Logger } from '../common/index.js';
+import type { Range } from '../source/index.js';
+import { ReadonlySource } from '../source/index.js';
+import type { SymbolUtil } from '../symbol/index.js';
+import type { Config } from './Config.js';
+import { ErrorReporter } from './ErrorReporter.js';
+import type { FileService } from './FileService.js';
+import type { RootUriString } from './fileUtil.js';
+import type { LinterErrorReporter } from './index.js';
+import type { MetaRegistry } from './MetaRegistry.js';
+import type { ProfilerFactory } from './Profiler.js';
+import type { ProjectData } from './Project.js';
 export interface ContextBase {
     fs: FileService;
-    getDocAndNode: (uri: string) => DocAndNode | undefined;
-    global: SymbolTable;
     logger: Logger;
     meta: MetaRegistry;
+    profilers: ProfilerFactory;
     project: Record<string, string>;
     roots: readonly RootUriString[];
 }
@@ -27,8 +26,6 @@ export interface ParserContext extends ContextBase {
     config: Config;
     doc: TextDocument;
     err: ErrorReporter;
-    /** @deprecated */
-    symbols: SymbolUtil;
 }
 interface ParserContextOptions {
     doc: TextDocument;
@@ -41,7 +38,6 @@ export interface ProcessorContext extends ContextBase {
     config: Config;
     doc: TextDocument;
     src: ReadonlySource;
-    /** @deprecated */
     symbols: SymbolUtil;
 }
 interface ProcessorContextOptions {
@@ -69,14 +65,22 @@ interface ProcessorWithOffsetContextOptions extends ProcessorContextOptions {
 declare namespace ProcessorWithOffsetContext {
     function create(project: ProjectData, opts: ProcessorWithOffsetContextOptions): ProcessorWithOffsetContext;
 }
+export interface BinderContext extends ProcessorContext {
+    err: ErrorReporter;
+    ensureBindingStarted: (this: void, uri: string) => Promise<unknown>;
+}
+interface BinderContextOptions extends ProcessorContextOptions {
+    err?: ErrorReporter;
+}
+export declare namespace BinderContext {
+    function create(project: ProjectData, opts: BinderContextOptions): BinderContext;
+}
 export interface CheckerContext extends ProcessorContext {
     err: ErrorReporter;
-    ops: Operations;
-    ensureChecked: (this: void, uri: string) => Promise<unknown>;
+    ensureBindingStarted: (this: void, uri: string) => Promise<unknown>;
 }
 interface CheckerContextOptions extends ProcessorContextOptions {
     err?: ErrorReporter;
-    ops?: Operations;
 }
 export declare namespace CheckerContext {
     function create(project: ProjectData, opts: CheckerContextOptions): CheckerContext;
@@ -133,7 +137,6 @@ export declare namespace SignatureHelpProviderContext {
     function create(project: ProjectData, opts: SignatureHelpProviderContextOptions): SignatureHelpProviderContext;
 }
 export interface UriBinderContext extends ContextBase {
-    /** @deprecated */
     symbols: SymbolUtil;
 }
 export declare namespace UriBinderContext {

package/lib/service/Context.js

@@ -1,52 +1,46 @@
-"use strict";
 /* istanbul ignore file */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UriBinderContext = exports.SignatureHelpProviderContext = exports.CompleterContext = exports.ColorizerContext = exports.FormatterContext = exports.LinterContext = exports.CheckerContext = exports.ProcessorContext = exports.ParserContext = exports.ContextBase = void 0;
-const processor_1 = require("../processor");
-const source_1 = require("../source");
-const ErrorReporter_1 = require("./ErrorReporter");
-const Operations_1 = require("./Operations");
-var ContextBase;
+import { formatterContextIndentation } from '../processor/index.js';
+import { ReadonlySource } from '../source/index.js';
+import { ErrorReporter } from './ErrorReporter.js';
+export var ContextBase;
 (function (ContextBase) {
     function create(project) {
         return {
             fs: project.fs,
-            getDocAndNode: project.get.bind(project),
-            global: project.symbols.global,
             logger: project.logger,
             meta: project.meta,
+            profilers: project.profilers,
             roots: project.roots,
             project: project.ctx,
         };
     }
     ContextBase.create = create;
-})(ContextBase = exports.ContextBase || (exports.ContextBase = {}));
-var ParserContext;
+})(ContextBase || (ContextBase = {}));
+export var ParserContext;
 (function (ParserContext) {
     function create(project, opts) {
         return {
             ...ContextBase.create(project),
             config: project.config,
             doc: opts.doc,
-            err: opts.err ?? new ErrorReporter_1.ErrorReporter(),
-            symbols: project.symbols,
+            err: opts.err ?? new ErrorReporter(),
         };
     }
     ParserContext.create = create;
-})(ParserContext = exports.ParserContext || (exports.ParserContext = {}));
-var ProcessorContext;
+})(ParserContext || (ParserContext = {}));
+export var ProcessorContext;
 (function (ProcessorContext) {
     function create(project, opts) {
         return {
             ...ContextBase.create(project),
             config: project.config,
             doc: opts.doc,
-            src: opts.src ?? new source_1.ReadonlySource(opts.doc.getText()),
+            src: opts.src ?? new ReadonlySource(opts.doc.getText()),
             symbols: project.symbols,
         };
     }
     ProcessorContext.create = create;
-})(ProcessorContext = exports.ProcessorContext || (exports.ProcessorContext = {}));
+})(ProcessorContext || (ProcessorContext = {}));
 var ProcessorWithRangeContext;
 (function (ProcessorWithRangeContext) {
     function create(project, opts) {
@@ -67,19 +61,29 @@ var ProcessorWithOffsetContext;
     }
     ProcessorWithOffsetContext.create = create;
 })(ProcessorWithOffsetContext || (ProcessorWithOffsetContext = {}));
-var CheckerContext;
+export var BinderContext;
+(function (BinderContext) {
+    function create(project, opts) {
+        return {
+            ...ProcessorContext.create(project, opts),
+            err: opts.err ?? new ErrorReporter(),
+            ensureBindingStarted: project.ensureBindingStarted?.bind(project),
+        };
+    }
+    BinderContext.create = create;
+})(BinderContext || (BinderContext = {}));
+export var CheckerContext;
 (function (CheckerContext) {
     function create(project, opts) {
         return {
             ...ProcessorContext.create(project, opts),
-            err: opts.err ?? new ErrorReporter_1.ErrorReporter(),
-            ops: opts.ops ?? new Operations_1.Operations(),
-            ensureChecked: project.ensureParsedAndChecked?.bind(project),
+            err: opts.err ?? new ErrorReporter(),
+            ensureBindingStarted: project.ensureBindingStarted?.bind(project),
         };
     }
     CheckerContext.create = create;
-})(CheckerContext = exports.CheckerContext || (exports.CheckerContext = {}));
-var LinterContext;
+})(CheckerContext || (CheckerContext = {}));
+export var LinterContext;
 (function (LinterContext) {
     function create(project, opts) {
         return {
@@ -90,8 +94,8 @@ var LinterContext;
         };
     }
     LinterContext.create = create;
-})(LinterContext = exports.LinterContext || (exports.LinterContext = {}));
-var FormatterContext;
+})(LinterContext || (LinterContext = {}));
+export var FormatterContext;
 (function (FormatterContext) {
     function create(project, opts) {
         return {
@@ -99,20 +103,20 @@ var FormatterContext;
             ...opts,
             indentLevel: 0,
             indent(additionalLevels) {
-                return (0, processor_1.formatterContextIndentation)(this, additionalLevels);
+                return formatterContextIndentation(this, additionalLevels);
             },
         };
     }
     FormatterContext.create = create;
-})(FormatterContext = exports.FormatterContext || (exports.FormatterContext = {}));
-var ColorizerContext;
+})(FormatterContext || (FormatterContext = {}));
+export var ColorizerContext;
 (function (ColorizerContext) {
     function create(project, opts) {
         return ProcessorWithRangeContext.create(project, opts);
     }
     ColorizerContext.create = create;
-})(ColorizerContext = exports.ColorizerContext || (exports.ColorizerContext = {}));
-var CompleterContext;
+})(ColorizerContext || (ColorizerContext = {}));
+export var CompleterContext;
 (function (CompleterContext) {
     function create(project, opts) {
         return {
@@ -122,15 +126,15 @@ var CompleterContext;
         };
     }
     CompleterContext.create = create;
-})(CompleterContext = exports.CompleterContext || (exports.CompleterContext = {}));
-var SignatureHelpProviderContext;
+})(CompleterContext || (CompleterContext = {}));
+export var SignatureHelpProviderContext;
 (function (SignatureHelpProviderContext) {
     function create(project, opts) {
         return ProcessorWithOffsetContext.create(project, opts);
     }
     SignatureHelpProviderContext.create = create;
-})(SignatureHelpProviderContext = exports.SignatureHelpProviderContext || (exports.SignatureHelpProviderContext = {}));
-var UriBinderContext;
+})(SignatureHelpProviderContext || (SignatureHelpProviderContext = {}));
+export var UriBinderContext;
 (function (UriBinderContext) {
     function create(project) {
         return {
@@ -139,5 +143,5 @@ var UriBinderContext;
         };
     }
     UriBinderContext.create = create;
-})(UriBinderContext = exports.UriBinderContext || (exports.UriBinderContext = {}));
+})(UriBinderContext || (UriBinderContext = {}));
 //# sourceMappingURL=Context.js.map

package/lib/service/Dependency.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DependencyKey = void 0;
-var DependencyKey;
+export var DependencyKey;
 (function (DependencyKey) {
     function is(value) {
         return value.startsWith('@');
     }
     DependencyKey.is = is;
-})(DependencyKey = exports.DependencyKey || (exports.DependencyKey = {}));
+})(DependencyKey || (DependencyKey = {}));
 //# sourceMappingURL=Dependency.js.map

package/lib/service/Downloader.d.ts

@@ -1,20 +1,15 @@
-/// <reference types="node" />
-import type { Logger } from './Logger';
-declare type RemoteProtocol = 'http:' | 'https:';
-export declare type RemoteUriString = `${RemoteProtocol}${string}`;
-export declare namespace RemoteUriString {
-    function getProtocol(uri: RemoteUriString): RemoteProtocol;
-}
+import type { ExternalDownloaderOptions, Externals, Logger, RemoteUriString } from '../common/index.js';
+import type { RootUriString } from './fileUtil.js';
 export interface DownloaderDownloadOut {
-    cachePath?: string;
+    cacheUri?: string;
     checksum?: string;
 }
 export declare class Downloader {
     #private;
     private readonly cacheRoot;
+    private readonly externals;
     private readonly logger;
-    private readonly lld;
-    constructor(cacheRoot: string, logger: Logger, lld?: LowLevelDownloader);
+    constructor(cacheRoot: RootUriString, externals: Externals, logger: Logger);
     download<R>(job: Job<R>, out?: DownloaderDownloadOut): Promise<R | undefined>;
 }
 interface Job<R> {
@@ -31,37 +26,12 @@ interface Job<R> {
          */
         checksumJob: Omit<Job<string>, 'cache' | 'id'>;
         checksumExtension: `.${string}`;
-        serializer?: (data: Buffer) => Buffer;
-        deserializer?: (cache: Buffer) => Buffer;
+        serializer?: (data: Uint8Array) => Uint8Array;
+        deserializer?: (cache: Uint8Array) => Uint8Array;
     };
-    transformer: (data: Buffer) => PromiseLike<R> | R;
-    options?: LowLevelDownloadOptions;
+    transformer: (data: Uint8Array) => PromiseLike<R> | R;
+    options?: ExternalDownloaderOptions;
     ttl?: number;
 }
-interface LowLevelDownloadOptions {
-    /**
-     * Use an string array to set multiple values to the header.
-     */
-    headers?: Record<string, string | string[]>;
-    timeout?: number;
-}
-export interface LowLevelDownloader {
-    /**
-     * @throws
-     */
-    get(uri: RemoteUriString, options?: LowLevelDownloadOptions): Promise<Buffer>;
-}
-export declare namespace LowLevelDownloader {
-    function create(): LowLevelDownloader;
-    function mock(options: LowLevelDownloaderMockOptions): LowLevelDownloader;
-}
-interface LowLevelDownloaderMockOptions {
-    /**
-     * A record from URIs to fixture data. The {@link LowLevelDownloader.get} only returns a {@link Buffer},
-     * therefore `string` fixtures will be turned into a `Buffer` and `object` fixtures will be transformed
-     * into JSON and then turned into a `Buffer`.
-     */
-    fixtures: Record<RemoteUriString, string | Buffer | object>;
-}
 export {};
 //# sourceMappingURL=Downloader.d.ts.map