summon-open 1.0.0

package/lib/resolve.js

@@ -0,0 +1,198 @@
+// A conservative "looks like a bare domain" matcher, e.g. `github.com`,
+// `example.co.uk`, `localhost:3000`, `192.168.0.1:8080/path`.
+const DOMAIN_PATTERN = /^(?:localhost|(?:[a-z\d\-]+\.)+[a-z]{2,}|\d{1,3}(?:\.\d{1,3}){3})(?::\d+)?(?:[\/?#].*)?$/vi;
+
+// When a dotted name ends in one of these, treat it as a (possibly missing)
+// file rather than a domain — so `summon report.pdf` never becomes a URL.
+const FILE_EXTENSIONS = new Set([
+	'txt',
+	'md',
+	'pdf',
+	'png',
+	'jpg',
+	'jpeg',
+	'gif',
+	'webp',
+	'svg',
+	'ico',
+	'bmp',
+	'tiff',
+	'mp3',
+	'mp4',
+	'mkv',
+	'mov',
+	'avi',
+	'wav',
+	'flac',
+	'ogg',
+	'aac',
+	'm4a',
+	'webm',
+	'zip',
+	'gz',
+	'tar',
+	'7z',
+	'rar',
+	'xz',
+	'zst',
+	'doc',
+	'docx',
+	'xls',
+	'xlsx',
+	'ppt',
+	'pptx',
+	'odt',
+	'csv',
+	'json',
+	'xml',
+	'yml',
+	'yaml',
+	'toml',
+	'ini',
+	'html',
+	'htm',
+	'css',
+	'js',
+	'ts',
+	'jsx',
+	'tsx',
+	'exe',
+	'dmg',
+	'iso',
+	'bin',
+	'app',
+	'deb',
+	'rpm',
+	'msi',
+]);
+
+/**
+Whether a string starts with an explicit URL scheme (http, https, mailto, file, …).
+
+A single-letter prefix (Windows drive letter `C:`) and a colon followed by a
+digit (a `host:port`) are intentionally not treated as schemes.
+
+@param {string} value
+@returns {boolean}
+*/
+export function hasScheme(value) {
+	return /^[a-z][a-z\d+.\-]+:(?!\d)/vi.test(value);
+}
+
+/**
+Whether a string is a well-formed absolute URL.
+
+@param {string} value
+@returns {boolean}
+*/
+export function isUrl(value) {
+	if (!hasScheme(value)) {
+		return false;
+	}
+
+	try {
+		new URL(value); // eslint-disable-line no-new
+		return true;
+	} catch {
+		return false;
+	}
+}
+
+/**
+Whether a bare string looks like a domain we should turn into an `https://` URL.
+
+@param {string} value
+@returns {boolean}
+*/
+export function looksLikeDomain(value) {
+	if (hasScheme(value) || !DOMAIN_PATTERN.test(value)) {
+		return false;
+	}
+
+	const [host] = value.split(/[\/?#]/v);
+	const [hostname] = host.split(':');
+	const tld = hostname.split('.').pop().toLowerCase();
+	return !FILE_EXTENSIONS.has(tld);
+}
+
+/**
+Normalize a target for opening. Bare domains get an `https://` prefix; existing
+URLs and file paths are returned unchanged.
+
+@param {string} target
+@returns {string}
+*/
+export function normalizeTarget(target) {
+	return looksLikeDomain(target) ? `https://${target}` : target;
+}
+
+/**
+Build a search URL from a query and an engine template containing `%s`.
+
+@param {string} query
+@param {string} engineTemplate
+@returns {string}
+*/
+export function buildSearchUrl(query, engineTemplate) {
+	const encoded = encodeURIComponent(query);
+
+	return engineTemplate.includes('%s')
+		? engineTemplate.replaceAll('%s', encoded)
+		: engineTemplate + encoded;
+}
+
+/**
+Expand a bookmark alias into its stored target.
+
+Handles explicit `@name` syntax and bare names that match a bookmark. Anything
+else (file paths, URLs) is returned unchanged.
+
+@param {string} input
+@param {Record<string, string>} [bookmarks]
+@returns {string}
+*/
+export function expandBookmark(input, bookmarks = {}) {
+	if (input.startsWith('@')) {
+		const name = input.slice(1);
+		if (bookmarks[name]) {
+			return bookmarks[name];
+		}
+
+		throw new SummonError(`Unknown bookmark: ${input}`, 3);
+	}
+
+	if (bookmarks[input] && !hasScheme(input) && !input.includes('/') && !input.includes('\\')) {
+		return bookmarks[input];
+	}
+
+	return input;
+}
+
+/**
+Fully resolve a raw input into a final target (bookmark expansion + normalization).
+
+Note: this does not touch the filesystem. The CLI additionally prefers an
+existing file over domain normalization.
+
+@param {string} input
+@param {Record<string, string>} [bookmarks]
+@returns {string}
+*/
+export function resolveTarget(input, bookmarks = {}) {
+	return normalizeTarget(expandBookmark(input, bookmarks));
+}
+
+/**
+Error type carrying an intended process exit code.
+*/
+export class SummonError extends Error {
+	/**
+	@param {string} message
+	@param {number} [exitCode]
+	*/
+	constructor(message, exitCode = 1) {
+		super(message);
+		this.name = 'SummonError';
+		this.exitCode = exitCode;
+	}
+}

package/lib/reveal.js

@@ -0,0 +1,52 @@
+import process from 'node:process';
+import path from 'node:path';
+import {spawn} from 'node:child_process';
+import {existsSync} from 'node:fs';
+import open from 'open';
+import {SummonError} from './resolve.js';
+
+function run(command, arguments_) {
+	return new Promise((resolve, reject) => {
+		const subprocess = spawn(command, arguments_, {stdio: 'ignore', detached: false});
+		subprocess.on('error', reject);
+		subprocess.on('close', code => {
+			if (code === 0 || code === null) {
+				resolve();
+			} else {
+				reject(new Error(`${command} exited with code ${code}`));
+			}
+		});
+	});
+}
+
+/**
+Reveal a file or folder in the OS file manager, selecting/highlighting it.
+
+- macOS: `open -R <path>`
+- Windows: `explorer /select,<path>`
+- Linux/other: open the containing directory (reliable, no highlight)
+
+@param {string} target
+@returns {Promise<void>}
+*/
+export async function revealInFileManager(target) {
+	const resolved = path.resolve(target);
+
+	if (!existsSync(resolved)) {
+		throw new SummonError(`Cannot reveal, path not found: ${target}`, 2);
+	}
+
+	if (process.platform === 'darwin') {
+		await run('open', ['-R', resolved]);
+		return;
+	}
+
+	if (process.platform === 'win32') {
+		// `explorer` returns exit code 1 even on success, so we don't treat that as failure.
+		await run('explorer', [`/select,${resolved}`]).catch(() => undefined);
+		return;
+	}
+
+	// Best effort on Linux and everything else: open the containing folder.
+	await open(path.dirname(resolved));
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Aditya Pandey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,77 @@
+{
+	"name": "summon-open",
+	"version": "1.0.0",
+	"description": "Open URLs, files, folders, and apps from one cross-platform command — with bookmarks, search, clipboard, reveal, dry-run, and stdin support.",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/Aditya060806/summon.git"
+	},
+	"homepage": "https://github.com/Aditya060806/summon#readme",
+	"bugs": "https://github.com/Aditya060806/summon/issues",
+	"author": {
+		"name": "Aditya Pandey"
+	},
+	"type": "module",
+	"bin": {
+		"summon": "cli.js"
+	},
+	"engines": {
+		"node": ">=20"
+	},
+	"scripts": {
+		"test": "xo && ava"
+	},
+	"files": [
+		"cli.js",
+		"lib",
+		"completions"
+	],
+	"keywords": [
+		"summon",
+		"cross-platform",
+		"bookmark",
+		"bookmarks",
+		"clipboard",
+		"reveal",
+		"search",
+		"dry-run",
+		"cli-app",
+		"cli",
+		"app",
+		"open",
+		"opener",
+		"opens",
+		"launch",
+		"start",
+		"xdg-open",
+		"xdg",
+		"default",
+		"cmd",
+		"browser",
+		"editor",
+		"executable",
+		"exe",
+		"url",
+		"urls",
+		"arguments",
+		"spawn",
+		"exec",
+		"child",
+		"process",
+		"website",
+		"file"
+	],
+	"dependencies": {
+		"clipboardy": "^4.0.0",
+		"file-type": "^21.3.4",
+		"meow": "^14.1.0",
+		"open": "^11.0.0",
+		"tempy": "^3.2.0"
+	},
+	"devDependencies": {
+		"ava": "^7.0.0",
+		"execa": "^9.6.1",
+		"xo": "^2.0.2"
+	}
+}