@spyglassmc/core 0.4.9 → 0.4.11

package/lib/common/externals/NodeJsExternals.js

@@ -105,8 +105,8 @@ export const NodeJsExternals = {
         unlink(location) {
             return fsp.unlink(toFsPathLike(location));
         },
-        watch(locations) {
-            return new ChokidarWatcherWrapper(chokidar.watch(locations.map(toPath)));
+        watch(locations, { usePolling = false } = {}) {
+            return new ChokidarWatcherWrapper(chokidar.watch(locations.map(toPath), { usePolling }));
         },
         writeFile(location, data, options) {
             return fsp.writeFile(toFsPathLike(location), data, options);

package/lib/common/externals/index.d.ts

@@ -72,7 +72,9 @@ export interface ExternalFileSystem {
         isFile(): boolean;
     }>;
     unlink(location: FsLocation): Promise<void>;
-    watch(locations: FsLocation[]): FsWatcher;
+    watch(locations: FsLocation[], options: {
+        usePolling?: boolean;
+    }): FsWatcher;
     /**
      * @param options `mode` - File mode bit mask (e.g. `0o775`).
      */

package/lib/parser/util.js

@@ -5,7 +5,7 @@ import { Range, Source } from '../source/index.js';
 import { Failure } from './Parser.js';
 export function attempt(parser, src, ctx) {
     const tmpSrc = src.clone();
-    const tmpCtx = { ...ctx, err: new ErrorReporter() };
+    const tmpCtx = { ...ctx, err: new ErrorReporter(ctx.err.source) };
     const result = parser(tmpSrc, tmpCtx);
     return {
         result,

package/lib/processor/binder/builtin.js

@@ -5,7 +5,11 @@ import { ErrorReporter } from '../../service/index.js';
 import { traversePreOrder } from '../util.js';
 import { AsyncBinder, SyncBinder } from './Binder.js';
 export function attempt(binder, node, ctx) {
-    const tempCtx = { ...ctx, err: new ErrorReporter(), symbols: ctx.symbols.clone() };
+    const tempCtx = {
+        ...ctx,
+        err: new ErrorReporter(ctx.err.source),
+        symbols: ctx.symbols.clone(),
+    };
     const processAfterBinder = () => {
         StateProxy.undoChanges(node);
         const totalErrorSpan = tempCtx.err.errors.map((e) => e.range.end - e.range.start).reduce((a, b) => a + b, 0);

package/lib/processor/checker/builtin.js

@@ -4,7 +4,7 @@ import { traversePreOrder } from '../util.js';
 export function attempt(checker, node, ctx) {
     const tempCtx = {
         ...ctx,
-        err: new ErrorReporter(),
+        err: new ErrorReporter(ctx.err.source),
         symbols: ctx.symbols.clone(),
     };
     // FIXME: await

package/lib/service/CacheService.d.ts

@@ -7,7 +7,7 @@ import type { Project } from './Project.js';
  * The format version of the cache. Should be increased when any changes that
  * could invalidate the cache are introduced to the Spyglass codebase.
  */
-export declare const LatestCacheVersion = 4;
+export declare const LatestCacheVersion = 5;
 /**
  * Checksums of cached files or roots.
  */

package/lib/service/CacheService.js

@@ -5,7 +5,7 @@ import { fileUtil } from './fileUtil.js';
  * The format version of the cache. Should be increased when any changes that
  * could invalidate the cache are introduced to the Spyglass codebase.
  */
-export const LatestCacheVersion = 4;
+export const LatestCacheVersion = 5;
 var Checksums;
 (function (Checksums) {
     function create() {

package/lib/service/Config.d.ts

@@ -112,6 +112,16 @@ export interface EnvConfig {
     }>>;
     permissionLevel: 1 | 2 | 3 | 4;
     plugins: string[];
+    /**
+     * Makes the file-watcher use polling to watch for file changes.
+     * Comes at a performance cost for very large datapacks.
+     *
+     * On Windows, enabling this can fix file-lock issues when Spyglass is running.
+     * See: https://github.com/SpyglassMC/Spyglass/issues/1414
+     *
+     * **You should only consider enabling this for Windows machines.**
+     */
+    useFilePolling: boolean;
 }
 export type LinterSeverity = 'hint' | 'information' | 'warning' | 'error';
 export declare namespace LinterSeverity {

package/lib/service/Config.js

@@ -1,5 +1,5 @@
 import rfdc from 'rfdc';
-import { Arrayable, bufferToString, TypePredicates } from '../common/index.js';
+import { Arrayable, bufferToString, merge, TypePredicates } from '../common/index.js';
 import { FileCategories, RegistryCategories } from '../symbol/index.js';
 export var LinterSeverity;
 (function (LinterSeverity) {
@@ -139,6 +139,7 @@ export const VanillaConfig = {
         permissionLevel: 2,
         plugins: [],
         mcmetaSummaryOverrides: {},
+        useFilePolling: false,
     },
     format: {
         blockStateBracketSpacing: { inside: 0 },
@@ -260,14 +261,7 @@ export class ConfigService {
         return ConfigService.ConfigFileNames.some((n) => uri.endsWith(`/${n}`));
     }
     static merge(base, ...overrides) {
-        // FIXME
-        const ans = rfdc()(base);
-        for (const override of overrides) {
-            for (const key of ['env', 'format', 'lint', 'snippet']) {
-                ans[key] = { ...ans[key], ...override[key] };
-            }
-        }
-        return ans;
+        return overrides.reduce(merge, rfdc()(base));
     }
 }
 //# sourceMappingURL=Config.js.map

package/lib/service/Context.js

@@ -24,7 +24,7 @@ export var ParserContext;
             ...ContextBase.create(project),
             config: project.config,
             doc: opts.doc,
-            err: opts.err ?? new ErrorReporter(),
+            err: opts.err ?? new ErrorReporter(project.ctx['errorSource']),
         };
     }
     ParserContext.create = create;
@@ -61,7 +61,7 @@ export var BinderContext;
     function create(project, opts) {
         return {
             ...ProcessorContext.create(project, opts),
-            err: opts.err ?? new ErrorReporter(),
+            err: opts.err ?? new ErrorReporter(project.ctx['errorSource']),
             ensureBindingStarted: project.ensureBindingStarted?.bind(project),
         };
     }
@@ -72,7 +72,7 @@ export var CheckerContext;
     function create(project, opts) {
         return {
             ...ProcessorContext.create(project, opts),
-            err: opts.err ?? new ErrorReporter(),
+            err: opts.err ?? new ErrorReporter(project.ctx['errorSource']),
             ensureBindingStarted: project.ensureBindingStarted?.bind(project),
         };
     }

package/lib/service/ErrorReporter.d.ts

@@ -1,8 +1,9 @@
 import type { LanguageErrorInfo, RangeLike } from '../source/index.js';
 import { ErrorSeverity, LanguageError } from '../source/index.js';
 export declare class ErrorReporter {
+    readonly source?: string | undefined;
     errors: LanguageError[];
-    constructor();
+    constructor(source?: string | undefined);
     /**
      * Reports a new error.
      */
@@ -20,7 +21,7 @@ export declare class ErrorReporter {
 export declare class LinterErrorReporter extends ErrorReporter {
     ruleName: string;
     ruleSeverity: ErrorSeverity;
-    constructor(ruleName: string, ruleSeverity: ErrorSeverity);
+    constructor(ruleName: string, ruleSeverity: ErrorSeverity, source?: string);
     lint(message: string, range: RangeLike, info?: LanguageErrorInfo, severityOverride?: ErrorSeverity): void;
     static fromErrorReporter(reporter: ErrorReporter, ruleName: string, ruleSeverity: ErrorSeverity): LinterErrorReporter;
 }

package/lib/service/ErrorReporter.js

@@ -1,8 +1,11 @@
 import { localize } from '@spyglassmc/locales';
 import { LanguageError, Range } from '../source/index.js';
 export class ErrorReporter {
+    source;
     errors = [];
-    constructor() { }
+    constructor(source) {
+        this.source = source;
+    }
     /**
      * Reports a new error.
      */
@@ -10,7 +13,7 @@ export class ErrorReporter {
         if (message.trim() === '') {
             throw new Error('Tried to report an error with no message');
         }
-        this.errors.push(LanguageError.create(message, Range.get(range), severity, info));
+        this.errors.push(LanguageError.create(message, Range.get(range), severity, info, this.source));
     }
     /**
      * @returns All reported errors, and then clears the error stack.
@@ -31,8 +34,8 @@ export class ErrorReporter {
 export class LinterErrorReporter extends ErrorReporter {
     ruleName;
     ruleSeverity;
-    constructor(ruleName, ruleSeverity) {
-        super();
+    constructor(ruleName, ruleSeverity, source) {
+        super(source);
         this.ruleName = ruleName;
         this.ruleSeverity = ruleSeverity;
     }
@@ -40,7 +43,7 @@ export class LinterErrorReporter extends ErrorReporter {
         return this.report(localize('linter.diagnostic-message-wrapper', message, this.ruleName), range, severityOverride ?? this.ruleSeverity, info);
     }
     static fromErrorReporter(reporter, ruleName, ruleSeverity) {
-        const ans = new LinterErrorReporter(ruleName, ruleSeverity);
+        const ans = new LinterErrorReporter(ruleName, ruleSeverity, reporter.source);
         ans.errors = reporter.errors;
         return ans;
     }

package/lib/service/Project.js

@@ -215,12 +215,12 @@ export class Project {
             this.tryClearingCache(uri);
         }).on('ready', () => {
             this.#isReady = true;
-            // // Recheck client managed files after the READY process, as they may have incomplete results and are user-facing.
-            // const promises: Promise<unknown>[] = []
-            // for (const { doc, node } of this.#clientManagedDocAndNodes.values()) {
-            // 	promises.push(this.check(doc, node))
-            // }
-            // Promise.all(promises).catch(e => this.logger.error('[Project#ready] Error occurred when rechecking client managed files after READY', e))
+            // Recheck client managed files after the READY process, as they may have incomplete results and are user-facing.
+            const promises = [];
+            for (const { doc, node } of this.#clientManagedDocAndNodes.values()) {
+                promises.push(this.check(doc, node));
+            }
+            Promise.all(promises).catch(e => this.logger.error('[Project#ready] Error occurred when rechecking client managed files after READY', e));
         });
     }
     setInitPromise() {
@@ -330,7 +330,9 @@ export class Project {
             }
             this.#watchedFiles.clear();
             this.#watcherReady = false;
-            this.#watcher = this.externals.fs.watch(this.projectRoots).once('ready', () => {
+            this.#watcher = this.externals.fs.watch(this.projectRoots, {
+                usePolling: this.config.env.useFilePolling,
+            }).once('ready', () => {
                 this.#watcherReady = true;
                 resolve();
             }).on('add', (uri) => {
@@ -603,7 +605,7 @@ export class Project {
                 }
                 const ctx = LinterContext.create(this, {
                     doc,
-                    err: new LinterErrorReporter(ruleName, ruleSeverity),
+                    err: new LinterErrorReporter(ruleName, ruleSeverity, this.ctx['errorSource']),
                     ruleName,
                     ruleValue,
                 });

package/lib/source/LanguageError.d.ts

@@ -6,6 +6,7 @@ export interface LanguageErrorData {
     message: string;
     severity: ErrorSeverity;
     info?: LanguageErrorInfo;
+    source?: string;
 }
 export interface LanguageError extends LanguageErrorData {
     range: Range;
@@ -17,7 +18,7 @@ export interface PosRangeLanguageError extends LanguageErrorData {
     posRange: PositionRange;
 }
 export declare namespace LanguageError {
-    function create(message: string, range: Range, severity?: ErrorSeverity, info?: LanguageErrorInfo): LanguageError;
+    function create(message: string, range: Range, severity?: ErrorSeverity, info?: LanguageErrorInfo, source?: string): LanguageError;
     /**
      * @returns A {@link PosRangeLanguageError}.
      */

package/lib/source/LanguageError.js

@@ -1,11 +1,14 @@
 import { PositionRange } from './PositionRange.js';
 export var LanguageError;
 (function (LanguageError) {
-    function create(message, range, severity = 3 /* ErrorSeverity.Error */, info) {
+    function create(message, range, severity = 3 /* ErrorSeverity.Error */, info, source) {
         const ans = { range, message, severity };
         if (info) {
             ans.info = info;
         }
+        if (source) {
+            ans.source = source;
+        }
         return ans;
     }
     LanguageError.create = create;
@@ -18,6 +21,7 @@ export var LanguageError;
             message: error.message,
             severity: error.severity,
             ...(error.info && { info: error.info }),
+            ...(error.source && { source: error.source }),
         };
     }
     LanguageError.withPosRange = withPosRange;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spyglassmc/core",
-  "version": "0.4.9",
+  "version": "0.4.11",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",