@spyglassmc/core 0.1.0 → 0.2.0

package/lib/processor/linter/builtin.js

@@ -1,17 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerLinters = exports.configValidator = exports.quote = exports.nameConvention = exports.noop = void 0;
-const locales_1 = require("@spyglassmc/locales");
-const parser_1 = require("../../parser");
-const service_1 = require("../../service");
-const symbol_1 = require("../../symbol");
-const undeclaredSymbol_1 = require("./builtin/undeclaredSymbol");
-const noop = () => { };
-exports.noop = noop;
+import { localeQuote, localize } from '@spyglassmc/locales';
+import { isAllowedCharacter } from '../../parser/index.js';
+import { SymbolLinterConfig } from '../../service/index.js';
+import { McdocCategories } from '../../symbol/index.js';
+import { undeclaredSymbol } from './builtin/undeclaredSymbol.js';
+export const noop = () => { };
 /**
  * @param key The name of the key on the {@link AstNode} that contains the value to be validated.
  */
-function nameConvention(key) {
+export function nameConvention(key) {
     return (node, ctx) => {
         if (typeof node[key] !== 'string') {
             throw new Error(`Trying to access property "${key}" of node type "${node.type}"`);
@@ -21,7 +17,7 @@ function nameConvention(key) {
             // SECURITY: ReDoS attack. The risk is acceptable at the moment.
             const regex = new RegExp(ctx.ruleValue);
             if (!name.match(regex)) {
-                ctx.err.lint((0, locales_1.localize)('linter.name-convention.illegal', (0, locales_1.localeQuote)(name), (0, locales_1.localeQuote)(ctx.ruleValue)), node);
+                ctx.err.lint(localize('linter.name-convention.illegal', localeQuote(name), localeQuote(ctx.ruleValue)), node);
             }
         }
         catch (e) {
@@ -29,11 +25,10 @@ function nameConvention(key) {
         }
     };
 }
-exports.nameConvention = nameConvention;
-const quote = (node, ctx) => {
+export const quote = (node, ctx) => {
     const config = ctx.ruleValue;
     const mustValueBeQuoted = node.options.unquotable
-        ? [...node.value].some(c => !(0, parser_1.isAllowedCharacter)(c, node.options.unquotable))
+        ? [...node.value].some(c => !isAllowedCharacter(c, node.options.unquotable))
         : true;
     const isQuoteRequired = config.always || mustValueBeQuoted;
     const isQuoteProhibited = config.always === false && !mustValueBeQuoted;
@@ -53,18 +48,17 @@ const quote = (node, ctx) => {
         // TODO: Error no quote expected
     }
 };
-exports.quote = quote;
-var configValidator;
+export var configValidator;
 (function (configValidator) {
     function getDocLink(name) {
         return `https://spyglassmc.com/user/lint/${name}`;
     }
     function wrapError(name, msg) {
-        return `[Invalid Linter Config] [${name}] ${(0, locales_1.localize)('linter-config-validator.wrapper', msg, getDocLink(name))}`;
+        return `[Invalid Linter Config] [${name}] ${localize('linter-config-validator.wrapper', msg, getDocLink(name))}`;
     }
     function nameConvention(name, val, logger) {
         if (typeof val !== 'string') {
-            logger.error(wrapError(name, (0, locales_1.localize)('linter-config-validator.name-convention.type')));
+            logger.error(wrapError(name, localize('linter-config-validator.name-convention.type')));
             return false;
         }
         try {
@@ -72,7 +66,7 @@ var configValidator;
             new RegExp(val);
         }
         catch (e) {
-            logger.error(wrapError(name, (0, locales_1.localize)('') // FIXME
+            logger.error(wrapError(name, localize('') // FIXME
             ), e);
             return false;
         }
@@ -80,16 +74,11 @@ var configValidator;
     }
     configValidator.nameConvention = nameConvention;
     function symbolLinterConfig(_name, value, _logger) {
-        return service_1.SymbolLinterConfig.is(value);
+        return SymbolLinterConfig.is(value);
     }
     configValidator.symbolLinterConfig = symbolLinterConfig;
-})(configValidator = exports.configValidator || (exports.configValidator = {}));
-function registerLinters(meta) {
-    meta.registerLinter('nameOfNbtKey', {
-        configValidator: configValidator.nameConvention,
-        linter: nameConvention('value'),
-        nodePredicate: n => n.parent?.parent?.type === 'nbt:compound' && n.parent.type === 'pair' && n.type === 'string',
-    });
+})(configValidator || (configValidator = {}));
+export function registerLinters(meta) {
     meta.registerLinter('nameOfObjective', {
         configValidator: configValidator.nameConvention,
         linter: nameConvention('value'),
@@ -112,9 +101,8 @@ function registerLinters(meta) {
     });
     meta.registerLinter('undeclaredSymbol', {
         configValidator: configValidator.symbolLinterConfig,
-        linter: undeclaredSymbol_1.undeclaredSymbol,
-        nodePredicate: n => n.symbol && !symbol_1.NbtdocCategories.includes(n.symbol.category),
+        linter: undeclaredSymbol,
+        nodePredicate: n => n.symbol && !McdocCategories.includes(n.symbol.category),
     });
 }
-exports.registerLinters = registerLinters;
 //# sourceMappingURL=builtin.js.map

package/lib/processor/linter/index.d.ts

@@ -1,3 +1,3 @@
-export * as linter from './builtin';
-export * from './Linter';
+export * as linter from './builtin.js';
+export * from './Linter.js';
 //# sourceMappingURL=index.d.ts.map

package/lib/processor/linter/index.js

@@ -1,28 +1,3 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.linter = void 0;
-exports.linter = __importStar(require("./builtin"));
-__exportStar(require("./Linter"), exports);
+export * as linter from './builtin.js';
+export * from './Linter.js';
 //# sourceMappingURL=index.js.map

package/lib/processor/util.d.ts

@@ -1,5 +1,5 @@
-import type { AstNode } from '../node';
-import { Range } from '../source';
+import type { AstNode } from '../node/index.js';
+import { Range } from '../source/index.js';
 declare type Callback<R> = (this: void, node: AstNode, parents: AstNode[]) => R;
 export declare function traversePreOrder(node: AstNode, shouldContinue: Callback<unknown>, shouldCallFn: Callback<unknown>, fn: Callback<unknown>): void;
 interface NodeResult {

package/lib/processor/util.js

@@ -1,11 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.findNode = exports.traversePreOrder = void 0;
-const source_1 = require("../source");
-function traversePreOrder(node, shouldContinue, shouldCallFn, fn) {
+import { Range } from '../source/index.js';
+export function traversePreOrder(node, shouldContinue, shouldCallFn, fn) {
     traversePreOrderImpl(node, shouldContinue, shouldCallFn, fn, []);
 }
-exports.traversePreOrder = traversePreOrder;
 function traversePreOrderImpl(node, shouldContinue, shouldCallFn, fn, parents) {
     if (shouldCallFn(node, parents)) {
         fn(node, parents);
@@ -22,11 +18,10 @@ function traversePreOrderImpl(node, shouldContinue, shouldCallFn, fn, parents) {
 /**
  * @returns The shallowest node that is fully contained within `range`.
  */
-function findNode(node, range) {
+export function findNode(node, range) {
     let ans = { node: undefined, parents: [] };
     // TODO: Binary search here.
-    traversePreOrder(node, (node) => ans.node === undefined && source_1.Range.intersects(node.range, range), (node) => source_1.Range.containsRange(range, node.range), (node, parents) => ans = { node, parents: [...parents] });
+    traversePreOrder(node, (node) => ans.node === undefined && Range.intersects(node.range, range), (node) => Range.containsRange(range, node.range), (node, parents) => ans = { node, parents: [...parents] });
     return ans;
 }
-exports.findNode = findNode;
 //# sourceMappingURL=util.js.map

package/lib/service/CacheService.d.ts

@@ -1,6 +1,6 @@
-import { SymbolTable } from '../symbol';
-import type { RootUriString } from './fileUtil';
-import type { Project } from './Project';
+import { SymbolTable } from '../symbol/index.js';
+import type { RootUriString } from './fileUtil.js';
+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.
@@ -35,13 +35,13 @@ export declare class CacheService {
      * @param cacheRoot File path to the directory where cache files by Spyglass should be stored.
      * @param project
      */
-    constructor(cacheRoot: string, project: Project);
+    constructor(cacheRoot: RootUriString, project: Project);
     /**
      * @throws
      *
-     * @returns `${cacheRoot}/symbols/${sha1(projectRoot)}.json`
+     * @returns `${cacheRoot}symbols/${sha1(projectRoot)}.json`
      */
-    private getCacheFilePath;
+    private getCacheFileUri;
     load(): Promise<LoadResult>;
     validate(): Promise<ValidateResult>;
     /**

package/lib/service/CacheService.js

@@ -1,30 +1,11 @@
-"use strict";
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-var _CacheService_cacheFilePath;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CacheService = exports.LatestCacheVersion = void 0;
-const path_1 = __importDefault(require("path"));
-const common_1 = require("../common");
-const symbol_1 = require("../symbol");
-const fileUtil_1 = require("./fileUtil");
+import { Uri } from '../common/index.js';
+import { SymbolTable } from '../symbol/index.js';
+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.
  */
-exports.LatestCacheVersion = 1;
+export const LatestCacheVersion = 1;
 var Checksums;
 (function (Checksums) {
     function create() {
@@ -36,7 +17,11 @@ var Checksums;
     }
     Checksums.create = create;
 })(Checksums || (Checksums = {}));
-class CacheService {
+export class CacheService {
+    cacheRoot;
+    project;
+    checksums = Checksums.create();
+    #hasValidatedFiles = false;
     /**
      * @param cacheRoot File path to the directory where cache files by Spyglass should be stored.
      * @param project
@@ -44,26 +29,30 @@ class CacheService {
     constructor(cacheRoot, project) {
         this.cacheRoot = cacheRoot;
         this.project = project;
-        this.checksums = Checksums.create();
-        _CacheService_cacheFilePath.set(this, void 0);
-        this.project.on('documentUpdated', ({ doc }) => {
+        this.project.on('documentUpdated', async ({ doc }) => {
+            if (!this.#hasValidatedFiles) {
+                return;
+            }
             try {
                 // TODO: Don't update this for every single change.
-                this.checksums.files[doc.uri] = (0, common_1.getSha1)(doc.getText());
+                this.checksums.files[doc.uri] = await this.project.externals.crypto.getSha1(doc.getText());
             }
             catch (e) {
-                if (!(0, common_1.isErrorCode)(e, 'EISDIR')) {
+                if (!this.project.externals.error.isKind(e, 'EISDIR')) {
                     this.project.logger.error(`[CacheService#hash-file] ${doc.uri}`);
                 }
             }
         });
         this.project.on('rootsUpdated', async ({ roots }) => {
+            if (!this.#hasValidatedFiles) {
+                return;
+            }
             for (const root of roots) {
                 try {
                     this.checksums.roots[root] = await this.project.fs.hash(root);
                 }
                 catch (e) {
-                    if (!(0, common_1.isErrorCode)(e, 'EISDIR')) {
+                    if (!this.project.externals.error.isKind(e, 'EISDIR')) {
                         this.project.logger.error(`[CacheService#hash-root] ${root}`);
                     }
                 }
@@ -75,34 +64,36 @@ class CacheService {
             }
         });
     }
+    #cacheFilePath;
     /**
      * @throws
      *
-     * @returns `${cacheRoot}/symbols/${sha1(projectRoot)}.json`
+     * @returns `${cacheRoot}symbols/${sha1(projectRoot)}.json`
      */
-    getCacheFilePath() {
-        return __classPrivateFieldSet(this, _CacheService_cacheFilePath, __classPrivateFieldGet(this, _CacheService_cacheFilePath, "f") ?? path_1.default.join(this.cacheRoot, 'symbols', `${(0, common_1.getSha1)(this.project.projectRoot)}.json.gz`), "f");
+    async getCacheFileUri() {
+        return this.#cacheFilePath ??= new Uri(`symbols/${await this.project.externals.crypto.getSha1(this.project.projectRoot)}.json.gz`, this.cacheRoot).toString();
     }
     async load() {
         const __profiler = this.project.profilers.get('cache#load');
         const ans = { symbols: {} };
         let filePath;
         try {
-            filePath = this.getCacheFilePath();
-            const cache = await fileUtil_1.fileUtil.readGzippedJson(filePath);
+            filePath = await this.getCacheFileUri();
+            this.project.logger.info(`[CacheService#load] symbolCachePath = “${filePath}”`);
+            const cache = await fileUtil.readGzippedJson(this.project.externals, filePath);
             __profiler.task('Read File');
-            if (cache.version === exports.LatestCacheVersion) {
+            if (cache.version === LatestCacheVersion) {
                 this.checksums = cache.checksums;
-                ans.symbols = symbol_1.SymbolTable.link(cache.symbols);
+                ans.symbols = SymbolTable.link(cache.symbols);
                 __profiler.task('Link Symbols');
             }
             else {
-                this.project.logger.info(`[CacheService#load] Unsupported cache format ${cache.version}; expected ${exports.LatestCacheVersion}`);
+                this.project.logger.info(`[CacheService#load] Unsupported cache format ${cache.version}; expected ${LatestCacheVersion}`);
             }
         }
         catch (e) {
-            if (!(0, common_1.isEnoent)(e)) {
-                this.project.logger.error(`[CacheService#load] path = “${filePath}”`, e);
+            if (!this.project.externals.error.isKind(e, 'ENOENT')) {
+                this.project.logger.error('[CacheService#load] ', e);
             }
         }
         __profiler.finalize();
@@ -124,7 +115,7 @@ class CacheService {
                 }
             }
             catch (e) {
-                if (!(0, common_1.isErrorCode)(e, 'EISDIR')) {
+                if (!this.project.externals.error.isKind(e, 'EISDIR')) {
                     this.project.logger.error(`[CacheService#hash-file] ${uri}`);
                 }
                 // Failed calculating hash. Assume the root has changed.
@@ -145,7 +136,7 @@ class CacheService {
                 }
             }
             catch (e) {
-                if ((0, common_1.isEnoent)(e) || (0, common_1.isErrorCode)(e, 'EISDIR')) {
+                if (this.project.externals.error.isKind(e, 'ENOENT') || this.project.externals.error.isKind(e, 'EISDIR')) {
                     ans.removedFiles.push(uri);
                 }
                 else {
@@ -160,6 +151,7 @@ class CacheService {
                 ans.addedFiles.push(uri);
             }
         }
+        this.#hasValidatedFiles = true;
         return ans;
     }
     /**
@@ -169,15 +161,15 @@ class CacheService {
         const __profiler = this.project.profilers.get('cache#save');
         let filePath;
         try {
-            filePath = this.getCacheFilePath();
+            filePath = await this.getCacheFileUri();
             const cache = {
                 checksums: this.checksums,
                 projectRoot: this.project.projectRoot,
-                symbols: symbol_1.SymbolTable.unlink(this.project.symbols.global),
-                version: exports.LatestCacheVersion,
+                symbols: SymbolTable.unlink(this.project.symbols.global),
+                version: LatestCacheVersion,
             };
             __profiler.task('Unlink Symbols');
-            await fileUtil_1.fileUtil.writeGzippedJson(filePath, cache);
+            await fileUtil.writeGzippedJson(this.project.externals, filePath, cache);
             __profiler.task('Write File').finalize();
             return true;
         }
@@ -190,6 +182,4 @@ class CacheService {
         this.checksums = Checksums.create();
     }
 }
-exports.CacheService = CacheService;
-_CacheService_cacheFilePath = new WeakMap();
 //# sourceMappingURL=CacheService.js.map

package/lib/service/Config.d.ts

@@ -1,8 +1,7 @@
-/// <reference types="node" />
-import EventEmitter from 'events';
-import { Arrayable } from '../common';
-import { ErrorSeverity } from '../source';
-import type { Project } from './Project';
+import type { ExternalEventEmitter } from '../common/index.js';
+import { Arrayable } from '../common/index.js';
+import { ErrorSeverity } from '../source/index.js';
+import type { Project } from './Project.js';
 export interface Config {
     /**
      * Environment settings. Unlike other configs, all involved root folders must have the same `env` settings. It is undocumented
@@ -24,15 +23,17 @@ export interface Config {
 }
 export interface EnvConfig {
     /**
-     * Where to download data like `mcmeta` or `mc-nbtdoc` from (case-insensitive).
+     * Where to download data like `mcmeta` or `vanilla-mcdoc` from (case-insensitive).
      *
-     * * `GitHub`
-     * * `jsDelivr`: Not recommended as files from there can be outdated. Only use this if you have trouble connecting to `raw.githubusercontent.com`.
+     * * `GitHub`: Recommended, unless you have trouble connecting to `raw.githubusercontent.com`.
+     * * `fastly`
+     * * `jsDelivr`
+     * * A custom URL, with placeholder variables: `${user}`, `${repo}`, `${tag}`, and `${path}`.
      */
     dataSource: string;
     /**
      * A list of data packs the current project depends on. Each value in this array can be either an absolute file path
-     * to a data pack folder or data pack archive (e.g. `.zip` or `.tar.gz`), or a special string like `@mc-nbtdoc`.
+     * to a data pack folder or data pack archive (e.g. `.zip` or `.tar.gz`), or a special string like `@vanilla-mcdoc`.
      */
     dependencies: string[];
     feature: {
@@ -198,21 +199,21 @@ declare type ErrorEvent = {
     error: unknown;
     uri: string;
 };
-export interface ConfigService {
+export declare class ConfigService implements ExternalEventEmitter {
+    #private;
+    private readonly project;
+    private readonly defaultConfig;
+    static readonly ConfigFileNames: readonly ["spyglass.json", ".spyglassrc.json"];
+    constructor(project: Project, defaultConfig?: Config);
     on(event: 'changed', callbackFn: (data: ConfigEvent) => void): this;
     on(event: 'error', callbackFn: (data: ErrorEvent) => void): this;
     once(event: 'changed', callbackFn: (data: ConfigEvent) => void): this;
     once(event: 'error', callbackFn: (data: ErrorEvent) => void): this;
     emit(event: 'changed', data: ConfigEvent): boolean;
     emit(event: 'error', data: ErrorEvent): boolean;
-}
-export declare class ConfigService extends EventEmitter {
-    private readonly project;
-    static readonly ConfigFileNames: readonly ["spyglass.json", ".spyglassrc.json"];
-    constructor(project: Project);
     load(): Promise<Config>;
     private static isConfigFile;
-    private merge;
+    static merge(base: Config, ...overrides: any[]): Config;
 }
 export {};
 //# sourceMappingURL=Config.d.ts.map