metascope 0.1.0 → 0.2.0

package/dist/lib/sources/xcode-info-plist.js

@@ -0,0 +1,199 @@
+import { getMatches } from "../file-matching.js";
+import { defineSource } from "../source.js";
+import { nonEmptyString, optionalUrl, stringArray } from "../utilities/schema-primitives.js";
+import { readFile } from "node:fs/promises";
+import { resolve } from "node:path";
+import is from "@sindresorhus/is";
+import { z } from "zod";
+import plist from "plist";
+//#region src/lib/sources/xcode-info-plist.ts
+/**
+* Source and parser for Apple `Info.plist` files.
+*
+* Handles three flavors of Info.plist:
+*   - Standard Apple app/framework bundles (CFBundle* keys)
+*   - Alfred workflow plists (name, createdby, bundleid, etc.)
+*   - TextMate bundle plists (name, contactName, contactEmailRot13, etc.)
+*
+* Uses the `plist` npm package to parse XML plist format.
+*/
+const infoPlistSchema = z.object({
+	applicationCategory: nonEmptyString,
+	author: nonEmptyString,
+	authorEmail: nonEmptyString,
+	copyrightHolder: nonEmptyString,
+	copyrightYear: nonEmptyString,
+	description: nonEmptyString,
+	identifier: nonEmptyString,
+	name: nonEmptyString,
+	operatingSystems: stringArray,
+	processorRequirements: stringArray,
+	url: optionalUrl,
+	version: nonEmptyString
+});
+/** Xcode build variable pattern: $(VAR) or ${VAR}. */
+const XCODE_VARIABLE_RE = /\$[({][^)}]+[)}]/;
+/**
+* Map DTPlatformName / CFBundleSupportedPlatforms values to human-readable OS names.
+*/
+const PLATFORM_NAME_MAP = {
+	appletvos: "tvOS",
+	appletvsimulator: "tvOS",
+	iphoneos: "iOS",
+	iphonesimulator: "iOS",
+	macosx: "macOS",
+	watchos: "watchOS",
+	watchsimulator: "watchOS",
+	xros: "visionOS"
+};
+/**
+* Parse an `Info.plist` content string into a structured object.
+* Returns undefined if the plist is malformed or not a dictionary.
+*/
+function parse(content) {
+	let data;
+	try {
+		const parsed = plist.parse(content);
+		if (!is.plainObject(parsed)) return;
+		data = parsed;
+	} catch {
+		return;
+	}
+	const name = getString(data, "CFBundleDisplayName") ?? getString(data, "CFBundleName") ?? getString(data, "name");
+	const description = getString(data, "description");
+	const version = getString(data, "CFBundleShortVersionString") ?? getString(data, "version") ?? getString(data, "CFBundleVersion");
+	const identifier = getString(data, "CFBundleIdentifier") ?? getString(data, "bundleid");
+	const { copyrightHolder, copyrightYear } = parseCopyright(data);
+	const authorName = getString(data, "createdby") ?? getString(data, "contactName");
+	const authorEmailRot13 = getString(data, "contactEmailRot13");
+	const authorEmail = authorEmailRot13 ? rot13(authorEmailRot13) : void 0;
+	const url = getString(data, "webaddress");
+	const applicationCategory = parseApplicationCategory(data);
+	return infoPlistSchema.parse({
+		applicationCategory,
+		author: authorName,
+		authorEmail,
+		copyrightHolder,
+		copyrightYear,
+		description,
+		identifier,
+		name,
+		operatingSystems: parseOperatingSystems(data),
+		processorRequirements: parseProcessorRequirements(data),
+		url,
+		version
+	});
+}
+/**
+* Get a string value from a plist dict, returning undefined for
+* empty strings, whitespace-only strings, and Xcode variable placeholders.
+*/
+function getString(data, key) {
+	const value = data[key];
+	if (typeof value !== "string") return void 0;
+	const trimmed = value.trim();
+	if (trimmed.length === 0) return void 0;
+	if (XCODE_VARIABLE_RE.test(trimmed)) return void 0;
+	return trimmed;
+}
+/**
+* ROT13-decode a string (used by TextMate bundles for obfuscated emails).
+*/
+function rot13(value) {
+	return value.replaceAll(/[a-z]/gi, (c) => {
+		const base = c <= "Z" ? 65 : 97;
+		return String.fromCodePoint((c.codePointAt(0) - base + 13) % 26 + base);
+	});
+}
+/**
+* Convert an Apple UTI application category to a human-readable string.
+* e.g. "public.app-category.developer-tools" → "Developer Tools"
+*/
+function humanizeCategory(uti) {
+	if (!uti.startsWith("public.app-category.")) return uti;
+	return uti.slice(20).split("-").map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(" ");
+}
+/**
+* Parse application category from LSApplicationCategoryType.
+*/
+function parseApplicationCategory(data) {
+	const category = getString(data, "LSApplicationCategoryType");
+	if (!category) return void 0;
+	return humanizeCategory(category);
+}
+/**
+* Parse copyright information from NSHumanReadableCopyright or CFBundleGetInfoString.
+*/
+function parseCopyright(data) {
+	const copyrightSource = getString(data, "NSHumanReadableCopyright") ?? getString(data, "CFBundleGetInfoString");
+	if (!copyrightSource) return {};
+	const copyrightYear = /(?:©|\(c\)|copyright)\s*(\d{4})/i.exec(copyrightSource)?.[1];
+	const holderMatch = /(?:©|\(c\)|copyright)\s*\d{4}\s*(.+)/i.exec(copyrightSource);
+	let copyrightHolder;
+	if (holderMatch) {
+		copyrightHolder = holderMatch[1].replace(/\.\s*all\s+rights\s+reserved\.?/i, "").replace(/[.,;]+$/, "").trim();
+		if (copyrightHolder.length === 0) copyrightHolder = void 0;
+	}
+	return {
+		copyrightHolder,
+		copyrightYear
+	};
+}
+/**
+* Infer operating systems from various plist keys.
+*/
+function parseOperatingSystems(data) {
+	const results = [];
+	const seen = /* @__PURE__ */ new Set();
+	function add(value) {
+		if (!seen.has(value)) {
+			seen.add(value);
+			results.push(value);
+		}
+	}
+	const minMacOS = getString(data, "LSMinimumSystemVersion");
+	if (minMacOS) add(`macOS >= ${minMacOS}`);
+	const minIOS = getString(data, "MinimumOSVersion");
+	if (minIOS) add(`iOS >= ${minIOS}`);
+	if (results.length > 0) return results;
+	const platformName = getString(data, "DTPlatformName");
+	if (platformName) {
+		const os = PLATFORM_NAME_MAP[platformName.toLowerCase()];
+		if (os) add(os);
+	}
+	const supportedPlatforms = data.CFBundleSupportedPlatforms;
+	if (Array.isArray(supportedPlatforms)) {
+		for (const p of supportedPlatforms) if (typeof p === "string") {
+			const os = PLATFORM_NAME_MAP[p.toLowerCase()];
+			if (os) add(os);
+		}
+	}
+	if (data.LSRequiresIPhoneOS === true && !seen.has("iOS")) add("iOS");
+	return results;
+}
+/**
+* Extract processor architecture requirements from UIRequiredDeviceCapabilities.
+*/
+function parseProcessorRequirements(data) {
+	const capabilities = data.UIRequiredDeviceCapabilities;
+	if (!Array.isArray(capabilities)) return [];
+	const results = [];
+	for (const c of capabilities) if (typeof c === "string" && /^(?:arm|x86|i386)/i.test(c)) results.push(c);
+	return results;
+}
+const xcodeInfoPlistSource = defineSource({
+	async discover(context) {
+		return getMatches(context.options, ["Info.plist"]);
+	},
+	key: "xcodeInfoPlist",
+	async parse(input, context) {
+		const data = parse(await readFile(resolve(context.options.path, input), "utf8"));
+		if (data !== void 0) return {
+			data,
+			source: input
+		};
+	},
+	phase: 1
+});
+//#endregion
+export { xcodeInfoPlistSource };

package/dist/lib/sources/xcode-project-pbxproj.d.ts

@@ -0,0 +1,21 @@
+import { OneOrMany, SourceRecord } from "../source.js";
+import { z } from "zod";
+
+//#region src/lib/sources/xcode-project-pbxproj.d.ts
+declare const pbxprojSchema: z.ZodObject<{
+  copyrightHolder: z.ZodPipe<z.ZodTransform<string | undefined, unknown>, z.ZodOptional<z.ZodString>>;
+  copyrightYear: z.ZodPipe<z.ZodTransform<string | undefined, unknown>, z.ZodOptional<z.ZodString>>;
+  dependencies: z.ZodArray<z.ZodObject<{
+    url: z.ZodString;
+  }, z.core.$strip>>;
+  identifier: z.ZodPipe<z.ZodTransform<string | undefined, unknown>, z.ZodOptional<z.ZodString>>;
+  name: z.ZodPipe<z.ZodTransform<string | undefined, unknown>, z.ZodOptional<z.ZodString>>;
+  operatingSystems: z.ZodPipe<z.ZodTransform<string[], unknown>, z.ZodArray<z.ZodString>>;
+  organizationName: z.ZodPipe<z.ZodTransform<string | undefined, unknown>, z.ZodOptional<z.ZodString>>;
+  programmingLanguage: z.ZodPipe<z.ZodTransform<string | undefined, unknown>, z.ZodOptional<z.ZodString>>;
+  version: z.ZodPipe<z.ZodTransform<string | undefined, unknown>, z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
+type Pbxproj = z.infer<typeof pbxprojSchema>;
+type XcodeProjectPbxprojData = OneOrMany<SourceRecord<Pbxproj>> | undefined;
+//#endregion
+export { XcodeProjectPbxprojData };

package/dist/lib/sources/xcode-project-pbxproj.js

@@ -0,0 +1,222 @@
+import { getMatches } from "../file-matching.js";
+import { defineSource } from "../source.js";
+import { nonEmptyString, stringArray } from "../utilities/schema-primitives.js";
+import { resolve } from "node:path";
+import is from "@sindresorhus/is";
+import { z } from "zod";
+import { PBXNativeTarget, XCRemoteSwiftPackageReference, XcodeProject } from "@bacons/xcode";
+//#region src/lib/sources/xcode-project-pbxproj.ts
+/**
+* Source and parser for Xcode `.pbxproj` project files.
+*
+* Uses the `@bacons/xcode` package to parse the binary/ASCII plist format
+* and navigate the Xcode project object graph.
+*
+* Extracts metadata from:
+*   - Project-level attributes (organizationName)
+*   - Build settings on the main app target (Release config preferred)
+*   - Swift Package Manager dependencies
+*/
+const pbxprojDependencySchema = z.object({ url: z.string() });
+const pbxprojSchema = z.object({
+	copyrightHolder: nonEmptyString,
+	copyrightYear: nonEmptyString,
+	dependencies: z.array(pbxprojDependencySchema),
+	identifier: nonEmptyString,
+	name: nonEmptyString,
+	operatingSystems: stringArray,
+	organizationName: nonEmptyString,
+	programmingLanguage: nonEmptyString,
+	version: nonEmptyString
+});
+/** Xcode build variable pattern: $(VAR) or ${VAR}. */
+const XCODE_VARIABLE_RE = /\$[({][^)}]+[)}]/;
+/**
+* Map SDKROOT values to human-readable OS names.
+*/
+const SDKROOT_MAP = {
+	appletvos: "tvOS",
+	iphoneos: "iOS",
+	macosx: "macOS",
+	watchos: "watchOS",
+	xros: "visionOS"
+};
+/**
+* Deployment target build setting keys and their OS label.
+*/
+const DEPLOYMENT_TARGETS = [
+	{
+		key: "IPHONEOS_DEPLOYMENT_TARGET",
+		os: "iOS"
+	},
+	{
+		key: "MACOSX_DEPLOYMENT_TARGET",
+		os: "macOS"
+	},
+	{
+		key: "TVOS_DEPLOYMENT_TARGET",
+		os: "tvOS"
+	},
+	{
+		key: "WATCHOS_DEPLOYMENT_TARGET",
+		os: "watchOS"
+	},
+	{
+		key: "XROS_DEPLOYMENT_TARGET",
+		os: "visionOS"
+	}
+];
+/**
+* Parse a `.pbxproj` file into a structured object.
+* Returns undefined if the file is malformed or cannot be parsed.
+*/
+function parse(filePath) {
+	let project;
+	try {
+		project = XcodeProject.open(filePath);
+	} catch {
+		return;
+	}
+	const root = project.rootObject;
+	const target = root.props.targets.find((t) => PBXNativeTarget.is(t));
+	let appTarget;
+	try {
+		appTarget = root.getMainAppTarget() ?? void 0;
+	} catch {}
+	appTarget ??= target;
+	let targetConfig;
+	let targetSettings;
+	if (appTarget) try {
+		const config = appTarget.getDefaultConfiguration();
+		targetConfig = config;
+		const bs = config.props.buildSettings;
+		targetSettings = is.plainObject(bs) ? bs : void 0;
+	} catch {}
+	let projectSettings;
+	try {
+		const pbs = (root.props.buildConfigurationList.props.buildConfigurations.find((c) => c.props.name === "Release") ?? root.props.buildConfigurationList.getDefaultConfiguration()).props.buildSettings;
+		projectSettings = is.plainObject(pbs) ? pbs : void 0;
+	} catch {}
+	const displayName = getSetting(targetSettings, projectSettings, "INFOPLIST_KEY_CFBundleDisplayName");
+	const productName = getResolvedSetting(targetConfig, targetSettings, projectSettings, "PRODUCT_NAME");
+	const targetName = appTarget ? cleanString(appTarget.props.name) : void 0;
+	const organizationName = cleanString(root.props.attributes.ORGANIZATIONNAME);
+	const { copyrightHolder, copyrightYear } = parseCopyrightString(getSetting(targetSettings, projectSettings, "INFOPLIST_KEY_NSHumanReadableCopyright"));
+	const swiftVersion = getSetting(targetSettings, projectSettings, "SWIFT_VERSION");
+	let programmingLanguage;
+	if (swiftVersion) programmingLanguage = "Swift";
+	else if (getSetting(targetSettings, projectSettings, "GCC_C_LANGUAGE_STANDARD")) programmingLanguage = "Objective-C";
+	return pbxprojSchema.parse({
+		copyrightHolder,
+		copyrightYear,
+		dependencies: parseDependencies(root),
+		identifier: getResolvedSetting(targetConfig, targetSettings, projectSettings, "PRODUCT_BUNDLE_IDENTIFIER"),
+		name: displayName ?? productName ?? targetName,
+		operatingSystems: parseOperatingSystems(targetSettings, projectSettings),
+		organizationName,
+		programmingLanguage,
+		version: getSetting(targetSettings, projectSettings, "MARKETING_VERSION")
+	});
+}
+/**
+* Get a string build setting, filtering out empty strings and unresolved
+* Xcode variable placeholders. Handles both string and numeric values.
+*/
+function cleanString(value) {
+	if (typeof value === "number") return String(value);
+	if (typeof value !== "string") return void 0;
+	const trimmed = value.trim();
+	if (trimmed.length === 0) return void 0;
+	if (XCODE_VARIABLE_RE.test(trimmed)) return void 0;
+	return trimmed;
+}
+/**
+* Get a build setting from a target, cascading to project-level if not found.
+*/
+function getSetting(targetSettings, projectSettings, key) {
+	const targetValue = cleanString(targetSettings?.[key]);
+	if (targetValue !== void 0) return targetValue;
+	return cleanString(projectSettings?.[key]);
+}
+/**
+* Try to resolve a build setting using `@bacons/xcode`'s variable resolution,
+* then fall back to raw value.
+*/
+function getResolvedSetting(config, targetSettings, projectSettings, key) {
+	if (config) try {
+		const cleaned = cleanString(config.resolveBuildSetting(key));
+		if (cleaned !== void 0) return cleaned;
+	} catch {}
+	return getSetting(targetSettings, projectSettings, key);
+}
+/**
+* Parse copyright information from a copyright string.
+*/
+function parseCopyrightString(copyrightSource) {
+	if (!copyrightSource) return {};
+	const copyrightYear = /(?:©|\(c\)|copyright)\s*(\d{4})/i.exec(copyrightSource)?.[1];
+	const holderMatch = /(?:©|\(c\)|copyright)\s*\d{4}\s*(.+)/i.exec(copyrightSource);
+	let copyrightHolder;
+	if (holderMatch) {
+		copyrightHolder = holderMatch[1].replace(/\.\s*all\s+rights\s+reserved\.?/i, "").replace(/[.,;]+$/, "").trim();
+		if (copyrightHolder.length === 0) copyrightHolder = void 0;
+	}
+	return {
+		copyrightHolder,
+		copyrightYear
+	};
+}
+/**
+* Infer operating systems from deployment target build settings.
+*/
+function parseOperatingSystems(targetSettings, projectSettings) {
+	const results = [];
+	const seen = /* @__PURE__ */ new Set();
+	for (const { key, os } of DEPLOYMENT_TARGETS) {
+		const version = getSetting(targetSettings, projectSettings, key);
+		if (version) {
+			const value = `${os} >= ${version}`;
+			if (!seen.has(value)) {
+				seen.add(value);
+				results.push(value);
+			}
+		}
+	}
+	if (results.length === 0) {
+		const sdkroot = getSetting(targetSettings, projectSettings, "SDKROOT");
+		if (sdkroot && sdkroot !== "auto") {
+			const os = SDKROOT_MAP[sdkroot];
+			if (os) results.push(os);
+		}
+	}
+	return results;
+}
+/**
+* Extract Swift Package Manager dependencies.
+*/
+function parseDependencies(root) {
+	const packageReferences = root.props.packageReferences ?? [];
+	const results = [];
+	for (const packageReference of packageReferences) {
+		if (!XCRemoteSwiftPackageReference.is(packageReference)) continue;
+		const url = cleanString(packageReference.props.repositoryURL);
+		if (url) results.push({ url });
+	}
+	return results;
+}
+const xcodeProjectPbxprojSource = defineSource({
+	async discover(context) {
+		return getMatches(context.options, ["*.xcodeproj/project.pbxproj"], ["**/*.xcodeproj/project.pbxproj"]);
+	},
+	key: "xcodeProjectPbxproj",
+	async parse(input, context) {
+		const data = parse(resolve(context.options.path, input));
+		if (data !== void 0) return {
+			data,
+			source: input
+		};
+	},
+	phase: 1
+});
+//#endregion
+export { xcodeProjectPbxprojSource };

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

@@ -0,0 +1,47 @@
+import { Template } from "../metadata-types.js";
+import { CodemetaDependencyLd, CodemetaPersonOrOrgLd } from "../utilities/codemeta-helpers.js";
+//#region src/lib/templates/codemeta.d.ts
+type TemplateDataCodemeta = ReturnType<typeof codemeta>;
+declare const codemeta: Template<{
+  '@context': string;
+  '@type': string;
+  applicationCategory: string | undefined;
+  applicationSubCategory: string | undefined;
+  author: CodemetaPersonOrOrgLd[] | undefined;
+  buildInstructions: string | undefined;
+  codeRepository: string | undefined;
+  continuousIntegration: string | undefined;
+  contributor: CodemetaPersonOrOrgLd[] | undefined;
+  copyrightHolder: CodemetaPersonOrOrgLd[] | undefined;
+  copyrightYear: number | undefined;
+  dateCreated: string | undefined;
+  dateModified: string | undefined;
+  datePublished: string | undefined;
+  description: string | undefined;
+  developmentStatus: string | undefined;
+  downloadUrl: string | undefined;
+  funder: CodemetaPersonOrOrgLd[] | undefined;
+  funding: string | undefined;
+  identifier: string | undefined;
+  installUrl: string | undefined;
+  isAccessibleForFree: boolean | undefined;
+  issueTracker: string | undefined;
+  keywords: string[] | undefined;
+  license: string | undefined;
+  maintainer: CodemetaPersonOrOrgLd[] | undefined;
+  name: string | undefined;
+  operatingSystem: string[] | undefined;
+  programmingLanguage: string[] | undefined;
+  readme: string | undefined;
+  relatedLink: string | string[] | undefined;
+  releaseNotes: string | undefined;
+  runtimePlatform: string[] | undefined;
+  softwareHelp: string | undefined;
+  softwareRequirements: CodemetaDependencyLd[] | undefined;
+  softwareSuggestions: CodemetaDependencyLd[] | undefined;
+  targetProduct: Record<string, string> | undefined;
+  url: string | undefined;
+  version: string | undefined;
+}>;
+//#endregion
+export { TemplateDataCodemeta };