metascope 0.6.3 → 0.7.1

package/dist/lib/sources/openframeworks-addon-config-mk.js

@@ -7,12 +7,19 @@ import { resolve } from "node:path";
 import { z } from "zod";
 //#region src/lib/sources/openframeworks-addon-config-mk.ts
 const openframeworksAddonConfigSchema = z.object({
+	/** `ADDON_AUTHOR` from `meta:` section. */
 	author: nonEmptyString,
+	/** `ADDON_DEPENDENCIES` from `common:` section (space-separated addon names). */
 	dependencies: stringArray,
+	/** `ADDON_DESCRIPTION` from `meta:` section. */
 	description: nonEmptyString,
+	/** `ADDON_NAME` from `meta:` section. */
 	name: nonEmptyString,
+	/** Platform section names that contain at least one variable assignment. */
 	platformSections: stringArray,
+	/** `ADDON_TAGS` from `meta:` section (quote-aware tokenized). */
 	tags: stringArray,
+	/** `ADDON_URL` from `meta:` section. */
 	url: optionalUrl
 });
 /**

package/dist/lib/sources/openframeworks-install-xml.js

@@ -19,19 +19,29 @@ import { XMLParser } from "fast-xml-parser";
 * content is actually an openFrameworks addon by checking for the `<install>`
 * root element and the presence of "addons" in the file content.
 *
-* Uses `fast-xml-parser` with attribute parsing enabled to read `<lib os="...">`
-* attributes for operating system inference.
+* Uses `fast-xml-parser` with attribute parsing enabled to read `<lib
+* os="...">` attributes for operating system inference.
 */
 const openframeworksInstallXmlSchema = z.object({
+	/** Addon author name. */
 	author: nonEmptyString,
+	/** Source code repository URL. */
 	codeUrl: optionalUrl,
+	/** Description of the addon. */
 	description: nonEmptyString,
+	/** Download URL. */
 	downloadUrl: optionalUrl,
+	/** Addon display name. */
 	name: nonEmptyString,
+	/** Supported operating systems from `<lib os="...">` attributes. */
 	operatingSystems: stringArray,
+	/** Software dependencies from `<requires>` elements. */
 	requirements: stringArray,
+	/** Website URL. */
 	siteUrl: optionalUrl,
+	/** Generic URL (used when no code_url / site_url provided). */
 	url: optionalUrl,
+	/** Version string. */
 	version: nonEmptyString
 });
 /**
@@ -43,9 +53,9 @@ const LIB_OS_MAP = {
 	win32: "Windows"
 };
 /**
-* Parse a legacy openFrameworks `install.xml` content string into a structured object.
-* Returns undefined if the XML is malformed, missing the `<install>` root element,
-* or does not appear to be an openFrameworks addon.
+* Parse a legacy openFrameworks `install.xml` content string into a structured
+* object. Returns undefined if the XML is malformed, missing the `<install>`
+* root element, or does not appear to be an openFrameworks addon.
 */
 function parse(content) {
 	if (!content.toLowerCase().includes("addons")) return;
@@ -58,12 +68,12 @@ function parse(content) {
 	let data;
 	try {
 		const parsed = parser.parse(fixedContent);
-		if (!is.plainObject(parsed)) return void 0;
+		if (!is.plainObject(parsed)) return;
 		data = parsed;
 	} catch {
 		return;
 	}
-	if (!is.plainObject(data.install)) return void 0;
+	if (!is.plainObject(data.install)) return;
 	const { install } = data;
 	return openframeworksInstallXmlSchema.parse({
 		author: getString(install.author),
@@ -79,17 +89,17 @@ function parse(content) {
 	});
 }
 /**
-* Get a trimmed non-empty string from a parsed XML value.
-* Returns undefined for empty strings, non-strings, or whitespace-only values.
+* Get a trimmed non-empty string from a parsed XML value. Returns undefined for
+* empty strings, non-strings, or whitespace-only values.
 */
 function getString(value) {
-	if (typeof value !== "string") return void 0;
+	if (typeof value !== "string") return;
 	const trimmed = value.trim();
 	return trimmed.length > 0 ? trimmed : void 0;
 }
 /**
-* Extract software requirements from `<requires>`.
-* Handles three variants:
+* Extract software requirements from `<requires>`. Handles three variants:
+*
 * 1. Empty — skip
 * 2. Free text — emit as-is
 * 3. Structured `<addon>` children — emit each separately
@@ -112,8 +122,8 @@ function parseRequirements(install) {
 	return [];
 }
 /**
-* Extract operating system information from `<lib os="...">` attributes
-* found within `<add><link>` sections.
+* Extract operating system information from `<lib os="...">` attributes found
+* within `<add><link>` sections.
 */
 function parseOperatingSystems(install) {
 	if (!is.plainObject(install.add)) return [];

package/dist/lib/sources/processing-library-properties.js

@@ -35,23 +35,38 @@ const CANONICAL_CATEGORIES = [
 const CATEGORY_MAP = new Map(CANONICAL_CATEGORIES.map((cat) => [cat.replaceAll(/[^a-z]/gi, "").toLowerCase(), cat]));
 CATEGORY_MAP.set("3d", "3D");
 const processingLibraryPropertiesSchema = z.object({
+	/** Parsed author entries with optional URLs. */
 	authors: z.array(processingLibraryPropertiesAuthorEntrySchema),
+	/** Normalized categories. */
 	categories: z.array(z.enum(CANONICAL_CATEGORIES)),
+	/** Direct download URL for the .zip distribution. */
 	download: optionalUrl,
+	/** Numeric identifier assigned by Processing contribution manager. */
 	id: nonEmptyString,
+	/** Maximum Processing revision, or 0 for no upper constraint. */
 	maxRevision: z.number(),
+	/** Minimum Processing revision, or 0 for no lower constraint. */
 	minRevision: z.number(),
+	/** Library name. */
 	name: nonEmptyString,
+	/** Extended description paragraph. */
 	paragraph: nonEmptyString,
+	/** Human-readable version string. */
 	prettyVersion: nonEmptyString,
+	/** Raw key-value pairs. */
 	raw: z.record(z.string(), z.string()),
+	/** One-sentence description. */
 	sentence: nonEmptyString,
+	/** Contribution type (library, tool, mode, examples). */
 	type: nonEmptyString,
+	/** Project URL. */
 	url: optionalUrl,
+	/** Integer release counter. */
 	version: z.number()
 });
 /**
-* Parse a Processing `library.properties` content string into a structured object.
+* Parse a Processing `library.properties` content string into a structured
+* object.
 */
 function parse(content) {
 	const raw = parseProperties(content);
@@ -86,28 +101,28 @@ function get(raw, key) {
 }
 /** Return a trimmed string, or undefined if empty/whitespace-only. */
 function nonEmpty(value) {
-	if (value === void 0) return void 0;
+	if (value === void 0) return;
 	const trimmed = value.trim();
 	return trimmed.length > 0 ? trimmed : void 0;
 }
 /**
-* Strip trailing inline comments from a value.
-* Matches the pattern ` # comment text` (space-hash-space).
+* Strip trailing inline comments from a value. Matches the pattern ` # comment
+* text` (space-hash-space).
 */
 function stripInlineComment(value) {
 	const index = value.indexOf(" # ");
 	return index === -1 ? value : value.slice(0, index).trim();
 }
 /**
-* Unescape backslash-escaped colons in URLs.
-* Some Processing fixtures use `https\://` instead of `https://`.
+* Unescape backslash-escaped colons in URLs. Some Processing fixtures use
+* `https\://` instead of `https://`.
 */
 function unescapeUrl(value) {
 	return value.replaceAll(String.raw`\:`, ":");
 }
 /**
-* Parse a Processing authors/authorList value into AuthorEntry[].
-* Preserves original order of appearance.
+* Parse a Processing authors/authorList value into AuthorEntry[]. Preserves
+* original order of appearance.
 */
 function parseAuthors(value) {
 	const trimmed = value.trim();
@@ -149,8 +164,8 @@ function parseAuthors(value) {
 	return results;
 }
 /**
-* Split plain text on ` and `, `,`, `&` to extract author names.
-* Filters out bare "others" entries.
+* Split plain text on `and`, `,`, `&` to extract author names. Filters out bare
+* "others" entries.
 */
 function addPlainAuthors(text, results) {
 	const parts = text.split(AUTHOR_SEPARATOR_REGEX).map((s) => s.trim()).filter((s) => s.length > 0 && s.toLowerCase() !== "others");

package/dist/lib/sources/processing-sketch-properties.js

@@ -13,34 +13,78 @@ const processingSketchPropertiesAuthorEntrySchema = z.object({
 	url: z.string().optional()
 });
 const processingSketchPropertiesSchema = z.object({
+	/**
+	* Parsed author entries with optional URLs. _Unofficial: borrowed from
+	* library.properties_
+	*/
 	authors: z.array(processingSketchPropertiesAuthorEntrySchema),
+	/** Contributed component type. */
 	component: nonEmptyString,
+	/** Direct download URL. _Unofficial: borrowed from library.properties_ */
 	download: optionalUrl,
+	/** Primary .pde filename for the sketch. */
 	main: nonEmptyString,
+	/** Android app label. From `manifest.label`. */
 	manifestLabel: nonEmptyString,
+	/**
+	* Android screen orientation, e.g. "unspecified". From
+	* `manifest.orientation`.
+	*/
 	manifestOrientation: nonEmptyString,
+	/** Android package name. From `manifest.package`. */
 	manifestPackage: nonEmptyString,
+	/** Android permission list. From `manifest.permissions`. */
 	manifestPermissions: z.array(z.string()),
+	/** Android minimum SDK level. From `manifest.sdk.min`. */
 	manifestSdkMin: z.number().optional(),
+	/** Android target SDK level. From `manifest.sdk.target`. */
 	manifestSdkTarget: z.number().optional(),
+	/** Android version code integer. From `manifest.version.code`. */
 	manifestVersionCode: z.number().optional(),
+	/** Android version name string. From `manifest.version.name`. */
 	manifestVersionName: nonEmptyString,
+	/**
+	* Maximum Processing revision, or 0 for no upper constraint. _Unofficial:
+	* borrowed from library.properties_
+	*/
 	maxRevision: z.number(),
+	/**
+	* Minimum Processing revision, or 0 for no lower constraint. _Unofficial:
+	* borrowed from library.properties_
+	*/
 	minRevision: z.number(),
+	/** Mode display name, e.g. "Java", "REPL Mode". */
 	mode: nonEmptyString,
+	/** Mode identifier, e.g. "processing.mode.java.JavaMode". From `mode.id`. */
 	modeId: nonEmptyString,
+	/** Sketch name. _Unofficial: borrowed from library.properties_ */
 	name: nonEmptyString,
+	/**
+	* Extended description paragraph. _Unofficial: borrowed from
+	* library.properties_
+	*/
 	paragraph: nonEmptyString,
+	/**
+	* Human-readable version string. _Unofficial: borrowed from
+	* library.properties_
+	*/
 	prettyVersion: nonEmptyString,
+	/** Raw key-value pairs. */
 	raw: z.record(z.string(), z.string()),
+	/** One-sentence description. _Unofficial: borrowed from library.properties_ */
 	sentence: nonEmptyString,
+	/** Templates string. */
 	templates: nonEmptyString,
+	/** Project URL. _Unofficial: borrowed from library.properties_ */
 	url: optionalUrl,
+	/** Integer release counter. _Unofficial: borrowed from library.properties_ */
 	version: z.number(),
+	/** Zip file name for contributed content. */
 	zipfilename: nonEmptyString
 });
 /**
-* Parse a Processing `sketch.properties` content string into a structured object.
+* Parse a Processing `sketch.properties` content string into a structured
+* object.
 */
 function parse(content) {
 	const raw = parseProperties(content);
@@ -89,13 +133,13 @@ function parse(content) {
 }
 /** Return a trimmed string, or undefined if empty/whitespace-only. */
 function nonEmpty(value) {
-	if (value === void 0) return void 0;
+	if (value === void 0) return;
 	const trimmed = value.trim();
 	return trimmed.length > 0 ? trimmed : void 0;
 }
 /**
-* Strip trailing inline comments from a value.
-* Matches the pattern ` # comment text` (space-hash-space).
+* Strip trailing inline comments from a value. Matches the pattern ` # comment
+* text` (space-hash-space).
 */
 function stripInlineComment(value) {
 	const index = value.indexOf(" # ");
@@ -150,7 +194,7 @@ function parseAuthors(value) {
 	return results;
 }
 /**
-* Split plain text on ` and `, `,`, `&` to extract author names.
+* Split plain text on `and`, `,`, `&` to extract author names.
 */
 function addPlainAuthors(text, results) {
 	const parts = text.split(AUTHOR_SEPARATOR_REGEX).map((s) => s.trim()).filter((s) => s.length > 0 && s.toLowerCase() !== "others");
@@ -160,8 +204,8 @@ function addPlainAuthors(text, results) {
 	});
 }
 /**
-* Validate that a sketch.properties file is a Processing sketch.
-* Checks for at least one known Processing sketch key.
+* Validate that a sketch.properties file is a Processing sketch. Checks for at
+* least one known Processing sketch key.
 */
 function isProcessingSketchProperties(content) {
 	const raw = parseProperties(content);

package/dist/lib/sources/publiccode-yaml.js

@@ -10,8 +10,8 @@ import { parse } from "yaml";
 * Source and parser for `publiccode.yml` / `publiccode.yaml` files.
 *
 * Publiccode.yml is a metadata standard for public software repositories,
-* primarily used in Europe (Italy, Netherlands, etc.).
-* See: https://yml.publiccode.tools/
+* primarily used in Europe (Italy, Netherlands, etc.). See:
+* https://yml.publiccode.tools/
 *
 * Extracts project metadata including name, version, license, contacts,
 * multi-language descriptions, dependencies, and categorization.
@@ -48,34 +48,63 @@ const publiccodeDescriptionSchema = z.object({
 	shortDescription: z.string().optional()
 });
 const publiccodeSchema = z.object({
+	/** Application suite this software belongs to. */
 	applicationSuite: nonEmptyString,
+	/** Available localization languages (BCP 47). */
 	availableLanguages: stringArray,
+	/** Software categories (e.g. "it-security", "cloud-management"). */
 	categories: stringArray,
+	/** Maintenance contacts. */
 	contacts: z.array(publiccodeContactEntrySchema),
+	/** Maintenance contractors. */
 	contractors: z.array(publiccodeContractorEntrySchema),
+	/** Software dependencies (open, proprietary, hardware). */
 	dependencies: z.array(publiccodeDependencyEntrySchema),
+	/** Preferred description (English if available, else first language). */
 	description: publiccodeDescriptionSchema.optional(),
+	/** All localized descriptions keyed by language code. */
 	descriptions: z.record(z.string(), publiccodeDescriptionSchema),
+	/** Development status (concept, development, beta, stable, obsolete). */
 	developmentStatus: nonEmptyString,
+	/** Supported input MIME types. */
 	inputTypes: stringArray,
+	/** URL of upstream software this is based on. */
 	isBasedOn: optionalUrl,
+	/** Landing page URL. */
 	landingUrl: optionalUrl,
+	/** SPDX license expression. */
 	license: nonEmptyString,
+	/** Whether the software supports localization. */
 	localisationReady: z.boolean().optional(),
+	/** Path or URL to logo image. */
 	logo: optionalUrl,
+	/** Main copyright holder. */
 	mainCopyrightOwner: nonEmptyString,
+	/** Maintenance type (internal, community, contract, none). */
 	maintenanceType: nonEmptyString,
+	/** Path or URL to monochrome logo image. */
 	monochromeLogo: optionalUrl,
+	/** Software name. */
 	name: nonEmptyString,
+	/** Supported output MIME types. */
 	outputTypes: stringArray,
+	/** Supported platforms (e.g. "web", "linux", "mac"). */
 	platforms: stringArray,
+	/** The publiccode.yml schema version. */
 	publiccodeYmlVersion: nonEmptyString,
+	/** Release date (YYYY-MM-DD). */
 	releaseDate: nonEmptyString,
+	/** Repository owner name. */
 	repoOwner: nonEmptyString,
+	/** Roadmap URL. */
 	roadmap: optionalUrl,
+	/** Software type (e.g. "standalone/web", "standalone/other"). */
 	softwareType: nonEmptyString,
+	/** Software version string. */
 	softwareVersion: nonEmptyString,
+	/** Repository URL. */
 	url: optionalUrl,
+	/** Organizations using this software. */
 	usedBy: stringArray
 });
 /** Coerce YAML values that may be parsed as non-strings back to strings. */
@@ -115,8 +144,11 @@ function parseDescription(data) {
 }
 /**
 * Parse a publiccode.yml / publiccode.yaml file content.
+*
 * @param content - Raw YAML file content.
-* @returns Parsed publiccode metadata, or `undefined` if the content is invalid.
+*
+* @returns Parsed publiccode metadata, or `undefined` if the content is
+*   invalid.
 */
 function parse$1(content) {
 	let data;
@@ -125,8 +157,8 @@ function parse$1(content) {
 	} catch {
 		return;
 	}
-	if (!isPlainObject(data)) return void 0;
-	if (!isNonEmptyString(data.name) && !isNonEmptyString(data.url)) return void 0;
+	if (!isPlainObject(data)) return;
+	if (!isNonEmptyString(data.name) && !isNonEmptyString(data.url)) return;
 	const descriptions = {};
 	let description;
 	if (isPlainObject(data.description)) {

package/dist/lib/sources/python-pkg-info.js

@@ -51,8 +51,8 @@ const HEADER_MAP = {
 * Parse a PKG-INFO or METADATA file and return structured metadata.
 *
 * Handles RFC 822-style headers with multi-value fields (Classifier,
-* Requires-Dist, Project-URL, Platform), continuation lines, and
-* the body section as long_description.
+* Requires-Dist, Project-URL, Platform), continuation lines, and the body
+* section as long_description.
 */
 function parse(source) {
 	const headers = parseRfc822Headers(source);

package/dist/lib/sources/python-setup-cfg.js

@@ -43,8 +43,8 @@ const STRING_ATTRS = new Set([
 /**
 * Parse a setup.cfg file and return structured metadata.
 *
-* Extracts fields from the `[metadata]` and `[options]` sections,
-* including multi-line values like classifiers and install_requires.
+* Extracts fields from the `[metadata]` and `[options]` sections, including
+* multi-line values like classifiers and install_requires.
 */
 function parse(source) {
 	const sections = parseConfigparser(source);

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

@@ -8,7 +8,9 @@ import remarkParse from "remark-parse";
 import { unified } from "unified";
 //#region src/lib/sources/readme-file.ts
 const readmeSchema = z.object({
+	/** YAML frontmatter key-value pairs, if present. */
 	frontmatter: z.record(z.string(), z.unknown()).optional(),
+	/** Project name extracted from the first H1 heading. */
 	name: z.string()
 });
 /**
@@ -21,7 +23,10 @@ function extractText(nodes) {
 		return "";
 	}).join("").trim();
 }
-/** Reusable markdown parser — processor config is stateless, only the AST is per-call. */
+/**
+* Reusable markdown parser — processor config is stateless, only the AST is
+* per-call.
+*/
 const markdownParser = unified().use(remarkParse);
 /**
 * Extract the text content of the first H1 heading from markdown.
@@ -35,13 +40,15 @@ function extractFirstH1(markdown) {
 }
 /**
 * Parse a README file's content.
+*
 * @param content - Raw file content (markdown).
+*
 * @returns Parsed metadata, or `undefined` if no H1 heading is found.
 */
 function parse(content) {
 	const { content: markdown, data } = matter(content);
 	const name = extractFirstH1(markdown);
-	if (!name) return void 0;
+	if (!name) return;
 	return readmeSchema.parse({
 		frontmatter: Object.keys(data).length > 0 ? data : void 0,
 		name

package/dist/lib/sources/ruby-gemspec.js

@@ -21,6 +21,7 @@ const gemSpecSchema = z.object({
 	email: z.union([z.string(), z.array(z.string())]).optional(),
 	executables: stringArray,
 	extensions: stringArray,
+	/** Any attributes not explicitly modeled above */
 	extra: z.record(z.string(), z.unknown()),
 	extra_rdoc_files: stringArray,
 	files: stringArray,

package/dist/lib/sources/rust-cargo-toml.js

@@ -8,12 +8,13 @@ import { z } from "zod";
 import { parse } from "smol-toml";
 //#region src/lib/sources/rust-cargo-toml.ts
 /**
-* Source for Rust `Cargo.toml` manifest files.
-* These are TOML files used by the Cargo package manager. Metadata lives
-* primarily in the `[package]` table, with dependencies in `[dependencies]`,
-* `[dev-dependencies]`, and `[build-dependencies]`.
+* Source for Rust `Cargo.toml` manifest files. These are TOML files used by the
+* Cargo package manager. Metadata lives primarily in the `[package]` table,
+* with dependencies in `[dependencies]`, `[dev-dependencies]`, and
+* `[build-dependencies]`.
 *
 * Uses `smol-toml` for TOML parsing.
+*
 * @see https://doc.rust-lang.org/cargo/reference/manifest.html
 */
 const cargoTomlAuthorEntrySchema = z.object({
@@ -25,34 +26,52 @@ const cargoTomlDependencyEntrySchema = z.object({
 	version: z.string().optional()
 });
 const cargoTomlSchema = z.object({
+	/** Parsed author entries from `package.authors`. */
 	authors: z.array(cargoTomlAuthorEntrySchema),
+	/** Build dependency names and versions from `[build-dependencies]`. */
 	buildDependencies: z.array(cargoTomlDependencyEntrySchema),
+	/** Category strings from `package.categories`. */
 	categories: stringArray,
+	/** Dependencies from `[dependencies]`. */
 	dependencies: z.array(cargoTomlDependencyEntrySchema),
+	/** Description from `package.description`. */
 	description: nonEmptyString,
+	/** Dev dependency names and versions from `[dev-dependencies]`. */
 	devDependencies: z.array(cargoTomlDependencyEntrySchema),
+	/** Documentation URL from `package.documentation`. */
 	documentation: optionalUrl,
+	/** Rust edition from `package.edition`. */
 	edition: nonEmptyString,
+	/** Homepage URL from `package.homepage`. */
 	homepage: optionalUrl,
+	/** Keywords from `package.keywords`. */
 	keywords: stringArray,
+	/** License identifier from `package.license`. */
 	license: nonEmptyString,
+	/** License file path from `package.license-file`. */
 	licenseFile: nonEmptyString,
+	/** Package name from `package.name`. */
 	name: nonEmptyString,
+	/** Readme file path from `package.readme`. */
 	readme: nonEmptyString,
+	/** Repository URL from `package.repository`. */
 	repository: optionalUrl,
+	/** Minimum Rust version from `package.rust-version`. */
 	rustVersion: nonEmptyString,
+	/** Version string from `package.version`. */
 	version: nonEmptyString,
+	/** Workspace members from `[workspace]`. */
 	workspaceMembers: stringArray
 });
 /**
-* Parse a `Cargo.toml` content string into a structured object.
-* Returns undefined if the TOML is malformed.
+* Parse a `Cargo.toml` content string into a structured object. Returns
+* undefined if the TOML is malformed.
 */
 function parse$1(content) {
 	let data;
 	try {
 		const parsed = parse(content);
-		if (!is.plainObject(parsed)) return void 0;
+		if (!is.plainObject(parsed)) return;
 		data = parsed;
 	} catch {
 		return;
@@ -82,7 +101,7 @@ function parse$1(content) {
 }
 /** Return a trimmed string, or undefined if not a non-empty string. */
 function nonEmpty(value) {
-	if (typeof value !== "string") return void 0;
+	if (typeof value !== "string") return;
 	const trimmed = value.trim();
 	return trimmed.length > 0 ? trimmed : void 0;
 }
@@ -122,8 +141,8 @@ function parseAuthors(value) {
 	return results;
 }
 /**
-* Parse a dependencies table into name/version entries.
-* Handles both `dep = "version"` and `dep = { version = "..." }` forms.
+* Parse a dependencies table into name/version entries. Handles both `dep =
+* "version"` and `dep = { version = "..." }` forms.
 */
 function parseDependencies(table) {
 	const results = [];