metascope 0.3.0 → 0.4.0

package/dist/lib/metadata-types.d.ts

@@ -7,6 +7,7 @@ import { FileStatsData } from "./sources/file-stats.js";
 import { GitConfigData } from "./sources/git-config.js";
 import { GitStatsData } from "./sources/git-stats.js";
 import { GitHubData } from "./sources/github.js";
+import { GitHubActionsData } from "./sources/github-actions.js";
 import { GoGoModData } from "./sources/go-go-mod.js";
 import { GoGoreleaserYamlData } from "./sources/go-goreleaser-yaml.js";
 import { JavaPomXmlData } from "./sources/java-pom-xml.js";
@@ -47,6 +48,7 @@ type MetadataContext = {
   fileStats: FileStatsData;
   gitConfig: GitConfigData;
   github: GitHubData;
+  githubActions: GitHubActionsData;
   gitStats: GitStatsData;
   goGoMod: GoGoModData;
   goGoreleaserYaml: GoGoreleaserYamlData;

package/dist/lib/metadata.js

@@ -11,6 +11,7 @@ import { fileStatsSource } from "./sources/file-stats.js";
 import { gitConfigSource } from "./sources/git-config.js";
 import { gitStatsSource } from "./sources/git-stats.js";
 import { githubSource } from "./sources/github.js";
+import { githubActionsSource } from "./sources/github-actions.js";
 import { goGoModSource } from "./sources/go-go-mod.js";
 import { goGoreleaserYamlSource } from "./sources/go-goreleaser-yaml.js";
 import { javaPomXmlSource } from "./sources/java-pom-xml.js";
@@ -56,6 +57,7 @@ const sources = [
 	cinderCinderblockXmlSource,
 	codemetaJsonSource,
 	gitConfigSource,
+	githubActionsSource,
 	goGoModSource,
 	goGoreleaserYamlSource,
 	javaPomXmlSource,
@@ -172,6 +174,7 @@ async function getMetadata(options) {
 		fileStats: void 0,
 		gitConfig: void 0,
 		github: void 0,
+		githubActions: void 0,
 		gitStats: void 0,
 		goGoMod: void 0,
 		goGoreleaserYaml: void 0,

package/dist/lib/package.js

@@ -1,5 +1,5 @@
 //#region package.json
 var name = "metascope";
-var version = "0.3.0";
+var version = "0.4.0";
 //#endregion
 export { name, version };

package/dist/lib/sources/dependency-updates.js

@@ -1,7 +1,5 @@
 import { log } from "../log.js";
 import { defineSource } from "../source.js";
-import { dirname, join } from "node:path";
-import { readFileSync } from "node:fs";
 import { exec } from "tinyexec";
 import { z } from "zod";
 import { fileURLToPath } from "node:url";
@@ -15,19 +13,13 @@ const depSchema = z.object({
 });
 const updatesOutputSchema = z.object({ results: z.record(z.string(), z.record(z.string(), z.record(z.string(), depSchema))) });
 /**
-* Resolve the path to the `updates` CLI binary from its installed package.
+* Resolve the path to the `updates` CLI binary.
 *
-* Uses `import.meta.resolve` instead of `createRequire` so that resolution
-* works even when metascope's code is re-bundled by a downstream consumer
-* (where `import.meta.url` would point to the consumer's output, not to
-* metascope's node_modules).
+* Consumers that bundle metascope must externalize it (e.g. via `neverBundle`)
+* so that `import.meta.resolve` can find the `updates` dependency.
 */
 function resolveUpdatesBinary() {
-	const packageJsonPath = fileURLToPath(import.meta.resolve("updates/package.json"));
-	const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf8"));
-	const bin = typeof packageJson === "object" && packageJson !== null && "bin" in packageJson && typeof packageJson.bin === "string" ? packageJson.bin : void 0;
-	if (!bin) throw new Error("Could not resolve updates binary path");
-	return join(dirname(packageJsonPath), bin);
+	return fileURLToPath(import.meta.resolve("updates/dist/index.js"));
 }
 /**
 * Parse an age string from the `updates` CLI (via the `timerel` library) into fractional years.

package/dist/lib/sources/github-actions.d.ts

@@ -0,0 +1,12 @@
+import { OneOrMany, SourceRecord } from "../source.js";
+import { z } from "zod";
+
+//#region src/lib/sources/github-actions.d.ts
+declare const githubActionSchema: z.ZodObject<{
+  file: z.ZodString;
+  name: z.ZodString;
+}, z.core.$strip>;
+type GitHubAction = z.infer<typeof githubActionSchema>;
+type GitHubActionsData = OneOrMany<SourceRecord<GitHubAction>> | undefined;
+//#endregion
+export { GitHubActionsData };

package/dist/lib/sources/github-actions.js

@@ -0,0 +1,41 @@
+import { getMatches } from "../file-matching.js";
+import { formatPath } from "../utilities/formatting.js";
+import { defineSource } from "../source.js";
+import { readFile } from "node:fs/promises";
+import { resolve } from "node:path";
+import { z } from "zod";
+import { parse } from "yaml";
+//#region src/lib/sources/github-actions.ts
+/**
+* Source for GitHub Actions workflow files.
+*
+* Discovers `.github/workflows/*.yml` and `*.yaml` files and extracts the
+* workflow name and file path from each.
+*/
+const githubActionSchema = z.object({
+	file: z.string(),
+	name: z.string()
+});
+const githubActionsSource = defineSource({
+	async discover(context) {
+		return getMatches(context.options, [".github/workflows/*.{yml,yaml}"]);
+	},
+	key: "githubActions",
+	async parse(input, context) {
+		const parsed = parse(await readFile(resolve(context.options.path, input), "utf8"));
+		if (typeof parsed !== "object" || parsed === null || !("name" in parsed)) return;
+		const { name } = parsed;
+		if (typeof name !== "string") return;
+		const file = formatPath(resolve(context.options.path, input), context.options.path, context.options.absolute);
+		return {
+			data: githubActionSchema.parse({
+				file,
+				name
+			}),
+			source: input
+		};
+	},
+	phase: 1
+});
+//#endregion
+export { githubActionsSource };

package/dist/lib/sources/github.js

@@ -361,12 +361,12 @@ function mapRepoData(data, extras) {
 const githubSource = defineSource({
 	async discover(context) {
 		if (context.options.offline) {
-			log.warn("Skipping GitHub data source since we're in offline mode");
+			log.debug("Skipping GitHub data source since we're in offline mode");
 			return [];
 		}
 		let gitRemotes = ensureArray(context.metadata?.gitConfig).map((config) => config.data.remote).filter((remote) => remote !== void 0);
 		if (gitRemotes.length === 0 && !context.completedSources?.has("gitConfig")) {
-			log.warn(`Missing gitConfig in source context metadata for ${context.options.path}, extracting it now...`);
+			log.debug(`Missing gitConfig in source context metadata for ${context.options.path}, extracting it now...`);
 			gitRemotes = ensureArray(await gitConfigSource.extract(context)).map((config) => config.data.remote).filter((remote) => remote !== void 0);
 		}
 		return [...new Set(gitRemotes.map((config) => getGitHubRemoteFromConfig(config)).filter((remote) => remote !== void 0).map((remote) => `${remote.owner}/${remote.repo}`))];

package/dist/lib/sources/node-npm-registry.js

@@ -10,12 +10,12 @@ import packageJson from "package-json";
 const nodeNpmRegistrySource = defineSource({
 	async discover(context) {
 		if (context.options.offline) {
-			log.warn("Skipping Node NPM registry data source since we're in offline mode");
+			log.debug("Skipping Node NPM registry data source since we're in offline mode");
 			return [];
 		}
 		let packages = ensureArray(context.metadata?.nodePackageJson);
 		if (packages.length === 0 && !context.completedSources?.has("nodePackageJson")) {
-			log.warn(`Missing nodePackageJson in source context metadata for ${context.options.path}, extracting it now...`);
+			log.debug(`Missing nodePackageJson in source context metadata for ${context.options.path}, extracting it now...`);
 			packages = ensureArray(await nodePackageJsonSource.extract(context));
 		}
 		return packages.filter((packageJson) => {

package/dist/lib/sources/obsidian-plugin-registry.js

@@ -10,12 +10,12 @@ const pluginStatsSchema = z.record(z.string(), z.record(z.string(), z.number()))
 const obsidianPluginRegistrySource = defineSource({
 	async discover(context) {
 		if (context.options.offline) {
-			log.warn("Skipping Obsidian plugin registry data source since we're in offline mode");
+			log.debug("Skipping Obsidian plugin registry data source since we're in offline mode");
 			return [];
 		}
 		let pluginIds = ensureArray(context.metadata?.obsidianPluginManifestJson).map((value) => value.data.id);
 		if (pluginIds.length === 0 && !context.completedSources?.has("obsidianPluginManifestJson")) {
-			log.warn(`Missing obsidianPluginManifestJson in source context metadata for ${context.options.path}, extracting it now...`);
+			log.debug(`Missing obsidianPluginManifestJson in source context metadata for ${context.options.path}, extracting it now...`);
 			pluginIds = ensureArray(await obsidianPluginManifestJsonSource.extract(context)).map((value) => value.data.id);
 		}
 		return pluginIds;

package/dist/lib/sources/python-pypi-registry.js

@@ -32,7 +32,7 @@ const pypistatsOverallSchema = z.object({ data: z.array(z.object({
 const pythonPypiRegistrySource = defineSource({
 	async discover(context) {
 		if (context.options.offline) {
-			log.warn("Skipping Python PyPI registry data source since we're in offline mode");
+			log.debug("Skipping Python PyPI registry data source since we're in offline mode");
 			return [];
 		}
 		let packageNames = [];

package/dist/lib/sources/readme-file.d.ts

@@ -3,6 +3,7 @@ import { z } from "zod";
 
 //#region src/lib/sources/readme-file.d.ts
 declare const readmeSchema: z.ZodObject<{
+  frontmatter: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
   name: z.ZodString;
 }, z.core.$strip>;
 type Readme = z.infer<typeof readmeSchema>;

package/dist/lib/sources/readme-file.js

@@ -3,10 +3,14 @@ import { defineSource } from "../source.js";
 import { readFile } from "node:fs/promises";
 import { resolve } from "node:path";
 import { z } from "zod";
+import { matter } from "gray-matter-es";
 import remarkParse from "remark-parse";
 import { unified } from "unified";
 //#region src/lib/sources/readme-file.ts
-const readmeSchema = z.object({ name: z.string() });
+const readmeSchema = z.object({
+	frontmatter: z.record(z.string(), z.unknown()).optional(),
+	name: z.string()
+});
 /**
 * Recursively extract plain text from mdast phrasing content.
 */
@@ -33,9 +37,13 @@ function extractFirstH1(markdown) {
 * @returns Parsed metadata, or `undefined` if no H1 heading is found.
 */
 function parse(content) {
-	const name = extractFirstH1(content);
+	const { content: markdown, data } = matter(content);
+	const name = extractFirstH1(markdown);
 	if (!name) return void 0;
-	return readmeSchema.parse({ name });
+	return readmeSchema.parse({
+		frontmatter: Object.keys(data).length > 0 ? data : void 0,
+		name
+	});
 }
 const readmeFileSource = defineSource({
 	async discover(context) {

package/dist/lib/templates/frontmatter.d.ts

@@ -18,7 +18,7 @@ declare const frontmatter: Template<{
   Public: boolean;
   Fork: boolean;
   Published: boolean;
-  Status: "unknown" | "maintainer" | "author" | "observer";
+  Status: "author" | "maintainer" | "unknown" | "observer";
   Tags: string[] | null;
   Aliases: (string | null | undefined)[] | null;
   License: string[] | null;

package/dist/lib/templates/index.d.ts

@@ -157,7 +157,7 @@ declare const templates: {
     Public: boolean;
     Fork: boolean;
     Published: boolean;
-    Status: "unknown" | "maintainer" | "author" | "observer";
+    Status: "author" | "maintainer" | "unknown" | "observer";
     Tags: string[] | null;
     Aliases: (string | null | undefined)[] | null;
     License: string[] | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metascope",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "A CLI tool and TypeScript library to easily extract metadata from all kinds of software repositories.",
   "keywords": [
     "metadata",
@@ -50,10 +50,11 @@
     "@types/plist": "^3.0.5",
     "@types/yargs": "^17.0.35",
     "case-police": "^2.2.0",
-    "defu": "^6.1.4",
+    "defu": "^6.1.6",
     "fast-xml-parser": "^5.5.9",
     "find-workspaces": "^0.3.1",
     "git-url-parse": "^16.1.0",
+    "gray-matter-es": "^0.2.1",
     "jiti": "^2.6.1",
     "lognow": "^0.5.2",
     "octokit": "^5.0.5",
@@ -74,7 +75,7 @@
     "tinyglobby": "^0.2.15",
     "unified": "^11.0.5",
     "updates": "^17.13.1",
-    "web-tree-sitter": "^0.26.7",
+    "web-tree-sitter": "^0.26.8",
     "yaml": "^2.8.3",
     "yargs": "^18.0.0",
     "zod": "^4.3.6"
@@ -88,7 +89,7 @@
     "@types/semver": "^7.7.1",
     "bumpp": "^11.0.1",
     "jsonld": "^9.0.0",
-    "mdat-plugin-cli-help": "^1.0.7",
+    "mdat-plugin-cli-help": "^1.0.8",
     "msw": "2.12.14",
     "publint": "^0.3.18",
     "tree-sitter-python": "^0.25.0",