nuxt-layerscope 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.1.2
+
+- A note appears when `nuxt.config` is newer than the registry, because changes to its
+  `layerscope` key only apply after `nuxi prepare`, `dev` or `build`.
+- Layer errors caused by the `layerscope` key of `nuxt.config` name it as their source.
+
+## 0.1.1
+
+- Names inside type syntax are no longer reported as unresolved references: labeled tuple members
+  (`defineEmits<{ close: [value: boolean] }>()`) and parameters of function types
+  (`(...next: T[]) => void`) and `typeof` queries in types.
+- `$fetch` is a known global, so it is no longer reported in server code.
+- The docs show `defineConfig` imported from `nuxt-layerscope` in every `layerscope.config.ts` sample.
+
 ## 0.1.0
 
 Initial release.

package/dist/analyze-DVzyPH7N.mjs

@@ -0,0 +1,2 @@
+import { t as analyze } from "./analyze-QaYmBXyK.mjs";
+export { analyze };

package/dist/{analyze-DS51xy6X.mjs → analyze-QaYmBXyK.mjs}

@@ -1,9 +1,9 @@
-import { c as realPath, d as effectiveConfig, g as LayerscopeError, h as ruleSeverity, m as isRuleName, s as readJson } from "./layer-factory-xZmIAPrA.mjs";
+import { c as realPath, d as effectiveConfig, f as labelConfigError, g as ruleSeverity, h as isRuleName, s as readJson, v as LayerscopeError } from "./layer-factory-DFh7nkFH.mjs";
 import { r as pascalCase, t as compareStrings } from "./strings-CrOjNZmB.mjs";
 import { t as globComponents } from "./component-files-DgOXNE6l.mjs";
-import { c as createOwnerLookup, d as createAnalysisEnv, f as readRegistry, h as boundaryFindings, m as loadSymbolTable, n as analyzeFile, p as tableFromRegistry, r as collectFiles, u as resolveLayers, v as loadConfig } from "./file-analysis-Bkq_69x4.mjs";
+import { c as createOwnerLookup, d as createAnalysisEnv, f as readRegistry, h as boundaryFindings, m as loadSymbolTable, n as analyzeFile, p as tableFromRegistry, r as collectFiles, u as resolveLayers, v as loadConfig } from "./file-analysis-Bh7qcWUK.mjs";
 import { basename, extname, join, relative, resolve } from "pathe";
-import { existsSync, writeFileSync } from "node:fs";
+import { existsSync, statSync, writeFileSync } from "node:fs";
 import { escapePath, glob } from "tinyglobby";
 import { spawnSync } from "node:child_process";
 //#region src/baseline/index.ts
@@ -149,6 +149,24 @@ function runRules(input) {
 	};
 }
 //#endregion
+//#region src/analyze/config-freshness.ts
+const NUXT_CONFIG_FILES = [
+	"nuxt.config.ts",
+	"nuxt.config.mts",
+	"nuxt.config.js",
+	"nuxt.config.mjs"
+];
+/**
+* The registry holds the `layerscope` key of `nuxt.config` as it was at the last `nuxi prepare`,
+* `dev` or `build`, so an edit made since then does not apply yet.
+*/
+function staleConfigNote(rootDir, registryFile) {
+	const config = NUXT_CONFIG_FILES.map((name) => join(rootDir, name)).find((file) => existsSync(file));
+	if (config === void 0 || !existsSync(registryFile)) return null;
+	if (statSync(config).mtimeMs <= statSync(registryFile).mtimeMs) return null;
+	return "nuxt.config is newer than the layerscope registry, so changes to its \"layerscope\" key do not apply yet. Run \"nuxi prepare\" again, or pass --prepare.";
+}
+//#endregion
 //#region src/analyze/freshness.ts
 const RERUN_HINT = "Run \"nuxi prepare\" again, or pass --prepare.";
 const COMPONENT_SUFFIX = /(?:\.(?:client|server))?(?:\.global|\.island)*$/u;
@@ -266,13 +284,21 @@ function recordedConfig(buildDir, registry) {
 async function loadEnvironment(options) {
 	const { rootDir, buildDir } = options;
 	const { registry, table, ...symbols } = loadSymbols(buildDir, options.source);
-	const config = effectiveConfig(options.config, recordedConfig(buildDir, registry));
-	const { layers, ownerOf, notes } = await loadLayers(rootDir, config, registry?.layers);
+	const recorded = recordedConfig(buildDir, registry);
+	const config = effectiveConfig(options.config, recorded);
+	const { layers, ownerOf, notes } = await loadLayers(rootDir, config, registry?.layers).catch((error) => {
+		throw labelConfigError(error, recorded);
+	});
+	const stale = registry === null ? null : staleConfigNote(rootDir, symbols.sourceFile);
 	await (registry === null ? assertFresh(table, layers) : assertRegistryFresh(table, registry));
 	return {
 		...symbols,
 		config,
-		notes: [...symbols.notes, ...notes],
+		notes: [
+			...symbols.notes,
+			...notes,
+			...stale === null ? [] : [stale]
+		],
 		registry,
 		layers,
 		env: createAnalysisEnv(table, ownerOf, buildDir, config)

package/dist/api.mjs

@@ -1,6 +1,6 @@
-import { g as LayerscopeError, l as REGISTRY_FILE, u as REGISTRY_VERSION } from "./layer-factory-xZmIAPrA.mjs";
+import { l as REGISTRY_FILE, u as REGISTRY_VERSION, v as LayerscopeError } from "./layer-factory-DFh7nkFH.mjs";
 import { t as defineConfig } from "./define-l62B9fVk.mjs";
-import { i as createBaseline, n as BASELINE_FILE, r as BASELINE_VERSION, t as analyze } from "./analyze-DS51xy6X.mjs";
+import { i as createBaseline, n as BASELINE_FILE, r as BASELINE_VERSION, t as analyze } from "./analyze-QaYmBXyK.mjs";
 import { i as JSON_REPORT_VERSION, n as formatResult, t as OUTPUT_FORMATS } from "./report-BNW0GCl9.mjs";
-import { r as buildGraph, t as findUnused } from "./unused-Dxep1p6u.mjs";
+import { r as buildGraph, t as findUnused } from "./unused-BtsPSfxb.mjs";
 export { BASELINE_FILE, BASELINE_VERSION, JSON_REPORT_VERSION, LayerscopeError, OUTPUT_FORMATS, REGISTRY_FILE, REGISTRY_VERSION, analyze, buildGraph, createBaseline, defineConfig, findUnused, formatResult };

package/dist/bin.mjs

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
-import { g as LayerscopeError } from "./layer-factory-xZmIAPrA.mjs";
+import { v as LayerscopeError } from "./layer-factory-DFh7nkFH.mjs";
 import { i as plural, r as pascalCase } from "./strings-CrOjNZmB.mjs";
-import { a as writeBaseline, i as createBaseline, n as BASELINE_FILE, t as analyze } from "./analyze-DS51xy6X.mjs";
+import { a as writeBaseline, i as createBaseline, n as BASELINE_FILE, t as analyze } from "./analyze-QaYmBXyK.mjs";
 import { n as formatResult, r as isOutputFormat, t as OUTPUT_FORMATS } from "./report-BNW0GCl9.mjs";
-import { i as edgeStatus, n as GRAPH_LEVELS, r as buildGraph, t as findUnused } from "./unused-Dxep1p6u.mjs";
+import { i as edgeStatus, n as GRAPH_LEVELS, r as buildGraph, t as findUnused } from "./unused-BtsPSfxb.mjs";
 import { relative, resolve } from "pathe";
 import { cac } from "cac";
 //#region src/commands/shared.ts

package/dist/eslint.mjs

@@ -1,6 +1,6 @@
-import { d as effectiveConfig, l as REGISTRY_FILE } from "./layer-factory-xZmIAPrA.mjs";
-import { t as packageVersion } from "./version-D6whhsHH.mjs";
-import { _ as findConfigFile, a as lineColumn, c as createOwnerLookup, d as createAnalysisEnv, f as readRegistry, h as boundaryFindings, i as isCheckedFile, l as nameLayers, o as offsetAt, p as tableFromRegistry, s as scanFile, t as FileAnalysis, y as loadConfigSync } from "./file-analysis-Bkq_69x4.mjs";
+import { d as effectiveConfig, l as REGISTRY_FILE } from "./layer-factory-DFh7nkFH.mjs";
+import { t as packageVersion } from "./version-DFWOUgi5.mjs";
+import { _ as findConfigFile, a as lineColumn, c as createOwnerLookup, d as createAnalysisEnv, f as readRegistry, h as boundaryFindings, i as isCheckedFile, l as nameLayers, o as offsetAt, p as tableFromRegistry, s as scanFile, t as FileAnalysis, y as loadConfigSync } from "./file-analysis-Bh7qcWUK.mjs";
 import { dirname, join, relative, resolve } from "pathe";
 import { existsSync, readFileSync, statSync } from "node:fs";
 //#region src/eslint/lint-file.ts

package/dist/{file-analysis-Bkq_69x4.mjs → file-analysis-Bh7qcWUK.mjs}

@@ -1,4 +1,4 @@
-import { a as isClonedFrom, c as realPath, g as LayerscopeError, h as ruleSeverity, i as layerFromPath, l as REGISTRY_FILE, n as deriveDirectories, o as isFile, p as validateConfig, r as layerFromNuxt, s as readJson, t as ROOT_LAYER_NAME } from "./layer-factory-xZmIAPrA.mjs";
+import { _ as LayerConfigError, a as isClonedFrom, c as realPath, g as ruleSeverity, i as layerFromPath, l as REGISTRY_FILE, m as validateConfig, n as deriveDirectories, o as isFile, r as layerFromNuxt, s as readJson, t as ROOT_LAYER_NAME, v as LayerscopeError } from "./layer-factory-DFh7nkFH.mjs";
 import { n as escapeRegExp, r as pascalCase, t as compareStrings } from "./strings-CrOjNZmB.mjs";
 import { dirname, isAbsolute, join, relative, resolve } from "pathe";
 import { fileURLToPath, pathToFileURL } from "node:url";
@@ -328,6 +328,8 @@ const SFC_MACROS = [
 	"defineModel",
 	"withDefaults"
 ];
+/** Defined on `globalThis` by Nuxt (app) and Nitro (server), so absent from the registry there. */
+const RUNTIME_GLOBALS = ["$fetch"];
 /** Registered globally by Vue and vue-router, so never listed in components.d.ts. */
 const GLOBAL_COMPONENTS = ["RouterLink", "RouterView"];
 function knownIdentifiers(extra) {
@@ -336,6 +338,7 @@ function knownIdentifiers(extra) {
 		...Object.keys(globals.browser),
 		...Object.keys(globals.node),
 		...SFC_MACROS,
+		...RUNTIME_GLOBALS,
 		"undefined",
 		"arguments",
 		...extra
@@ -405,10 +408,10 @@ function validateLayers(layers, config) {
 	for (const [name, rule] of Object.entries(config.layers ?? {})) {
 		if (!names.has(name)) {
 			const known = [...names].toSorted().join(", ");
-			throw new LayerscopeError(`Unknown layer "${name}" in config. Known layers: ${known}`);
+			throw new LayerConfigError(`Unknown layer "${name}" in config. Known layers: ${known}`);
 		}
 		const unknown = rule.allow?.find((allowed) => !names.has(allowed));
-		if (unknown !== void 0) throw new LayerscopeError(`layers.${name}.allow: unknown layer "${unknown}"`);
+		if (unknown !== void 0) throw new LayerConfigError(`layers.${name}.allow: unknown layer "${unknown}"`);
 	}
 }
 //#endregion
@@ -540,6 +543,13 @@ const scriptVisitors = {
 	},
 	TSModuleDeclaration: skip,
 	TSImportType: skip,
+	TSTypeQuery: skip,
+	TSNamedTupleMember: skip,
+	TSFunctionType: skip,
+	TSConstructorType: skip,
+	TSMethodSignature: skip,
+	TSCallSignatureDeclaration: skip,
+	TSConstructSignatureDeclaration: skip,
 	CallExpression(node, _parent, { scan, mapOffset }) {
 		if (node.type !== "CallExpression" || node.callee.type !== "Identifier") return;
 		const [arg] = node.arguments;

package/dist/index.mjs

@@ -1,7 +1,7 @@
-import { f as pickProjectConfig, l as REGISTRY_FILE, r as layerFromNuxt } from "./layer-factory-xZmIAPrA.mjs";
+import { l as REGISTRY_FILE, p as pickProjectConfig, r as layerFromNuxt } from "./layer-factory-DFh7nkFH.mjs";
 import { t as summarize } from "./summary-DiUYKMPe.mjs";
 import { i as plural, t as compareStrings } from "./strings-CrOjNZmB.mjs";
-import { t as packageVersion } from "./version-D6whhsHH.mjs";
+import { t as packageVersion } from "./version-DFWOUgi5.mjs";
 import { t as globComponents } from "./component-files-DgOXNE6l.mjs";
 import { t as defineConfig } from "./define-l62B9fVk.mjs";
 import { mkdir, writeFile } from "node:fs/promises";
@@ -106,7 +106,7 @@ function renderError(message) {
 //#region src/devtools/index.ts
 const DEVTOOLS_ROUTE = "/__layerscope";
 async function renderReport(nuxt, format) {
-	const [{ analyze }, { formatResult }] = await Promise.all([import("./analyze-YePAJEVS.mjs"), import("./report-DtAi0vPb.mjs")]);
+	const [{ analyze }, { formatResult }] = await Promise.all([import("./analyze-DVzyPH7N.mjs"), import("./report-DtAi0vPb.mjs")]);
 	const { rootDir, app } = nuxt.options;
 	const result = await analyze({ rootDir });
 	if (format === "json") return formatResult(result, "json", rootDir);

package/dist/{layer-factory-xZmIAPrA.mjs → layer-factory-DFh7nkFH.mjs}

@@ -9,6 +9,15 @@ var LayerscopeError = class extends Error {
 	}
 };
 //#endregion
+//#region src/layer-config-error.ts
+/** A layer name in the config that matches no layer. */
+var LayerConfigError = class extends LayerscopeError {
+	constructor(..._args) {
+		super(..._args);
+		this.name = "LayerConfigError";
+	}
+};
+//#endregion
 //#region src/config/rules.ts
 const DEFAULT_SEVERITY = {
 	"layer-boundary": "error",
@@ -70,6 +79,11 @@ function effectiveConfig(fileConfig, recorded) {
 		...recorded
 	};
 }
+/** Names the `nuxt.config` key in a layer error, when the settings that caused it came from there. */
+function labelConfigError(error, recorded) {
+	if (error instanceof LayerConfigError && recorded !== void 0 && hasProjectConfig(recorded)) return new LayerscopeError(`${NUXT_CONFIG_LABEL}: ${error.message}`);
+	return error;
+}
 //#endregion
 //#region src/registry/schema.ts
 /** Bumped on breaking changes to `registry.json`; readers fall back to the `.d.ts` files. */
@@ -165,4 +179,4 @@ function layerFromPath(name, root) {
 	};
 }
 //#endregion
-export { isClonedFrom as a, realPath as c, effectiveConfig as d, pickProjectConfig as f, LayerscopeError as g, ruleSeverity as h, layerFromPath as i, REGISTRY_FILE as l, isRuleName as m, deriveDirectories as n, isFile as o, validateConfig as p, layerFromNuxt as r, readJson as s, ROOT_LAYER_NAME as t, REGISTRY_VERSION as u };
+export { LayerConfigError as _, isClonedFrom as a, realPath as c, effectiveConfig as d, labelConfigError as f, ruleSeverity as g, isRuleName as h, layerFromPath as i, REGISTRY_FILE as l, validateConfig as m, deriveDirectories as n, isFile as o, pickProjectConfig as p, layerFromNuxt as r, readJson as s, ROOT_LAYER_NAME as t, REGISTRY_VERSION as u, LayerscopeError as v };

package/dist/{unused-Dxep1p6u.mjs → unused-BtsPSfxb.mjs}

@@ -1,5 +1,5 @@
 import { t as compareStrings } from "./strings-CrOjNZmB.mjs";
-import { c as createOwnerLookup, g as isAllowed } from "./file-analysis-Bkq_69x4.mjs";
+import { c as createOwnerLookup, g as isAllowed } from "./file-analysis-Bh7qcWUK.mjs";
 import { relative } from "pathe";
 //#region src/rules/edge-status.ts
 /** How the layer rules see one edge. */

package/dist/{version-D6whhsHH.mjs → version-DFWOUgi5.mjs}

@@ -1,4 +1,4 @@
-import { s as readJson } from "./layer-factory-xZmIAPrA.mjs";
+import { s as readJson } from "./layer-factory-DFh7nkFH.mjs";
 import { fileURLToPath } from "node:url";
 //#region src/version.ts
 /** Both `src/` and the bundled `dist/` sit next to package.json. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-layerscope",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Layer boundary checks for Nuxt apps that see auto-imports",
   "keywords": [
     "architecture",

package/dist/analyze-YePAJEVS.mjs

@@ -1,2 +0,0 @@
-import { t as analyze } from "./analyze-DS51xy6X.mjs";
-export { analyze };