@stryke/fs 0.23.3 → 0.24.0

package/dist/install.cjs

@@ -3,20 +3,22 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.packageExists = exports.install = void 0;
+exports.install = install;
+exports.packageExists = void 0;
 var _installPkg = require("@antfu/install-pkg");
 var _resolve = require("@stryke/path/resolve");
 require("tinyexec");
-const install = async (t, a) => (0, _installPkg.installPackage)(t, a),
-  packageExists = async (t, a) => {
-    const r = await (0, _resolve.resolve)(a?.cwd || process.cwd());
-    try {
-      await (0, _resolve.resolve)(t, {
-        paths: [r]
-      });
-    } catch {
-      await install(t, a);
-    }
-  };
-exports.packageExists = packageExists;
-exports.install = install;
+async function install(t, a) {
+  return (0, _installPkg.installPackage)(t, a);
+}
+const packageExists = async (t, a) => {
+  const s = await (0, _resolve.resolve)(a?.cwd || process.cwd());
+  try {
+    await (0, _resolve.resolve)(t, {
+      paths: [s]
+    });
+  } catch {
+    await install(t, a);
+  }
+};
+exports.packageExists = packageExists;

package/dist/install.d.ts

@@ -1,13 +1,20 @@
 import type { InstallPackageOptions } from "@antfu/install-pkg";
+import { installPackage } from "@antfu/install-pkg";
 import "tinyexec";
 /**
- * Install a package
+ * Install a specific package
  *
  * @param name - The name of the package to install
  * @param options - The options to use when installing the package
- * @returns The result of the command or an exception
  */
-export declare const install: (names: string | string[], options?: InstallPackageOptions) => Promise<import("tinyexec").Output>;
+export declare function install(name: string, options?: InstallPackageOptions): Promise<ReturnType<typeof installPackage>>;
+/**
+ * Install a list of packages
+ *
+ * @param names - The list of package names to install
+ * @param options - The options to use when installing the package
+ */
+export declare function install(names: string[], options?: InstallPackageOptions): Promise<ReturnType<typeof installPackage>>;
 /**
  * Check if a package exists and install it if it does not
  *

package/dist/install.mjs

@@ -1 +1 @@
-import{installPackage as n}from"@antfu/install-pkg";import{resolve as s}from"@stryke/path/resolve";import"tinyexec";export const install=async(t,a)=>n(t,a),packageExists=async(t,a)=>{const r=await s(a?.cwd||process.cwd());try{await s(t,{paths:[r]})}catch{await install(t,a)}};
+import{installPackage as e}from"@antfu/install-pkg";import{resolve as n}from"@stryke/path/resolve";import"tinyexec";export async function install(t,a){return e(t,a)}export const packageExists=async(t,a)=>{const s=await n(a?.cwd||process.cwd());try{await n(t,{paths:[s]})}catch{await install(t,a)}};

package/dist/package-fns.cjs

@@ -12,12 +12,14 @@ var _path = require("@stryke/path");
 var _getParentPath = require("@stryke/path/get-parent-path");
 var _getWorkspaceRoot = require("@stryke/path/get-workspace-root");
 var _resolve = require("@stryke/path/resolve");
+var _isString = require("@stryke/type-checks/is-string");
 var _nodeFs = require("node:fs");
 var _json = require("./json.cjs");
-function getPackageManager(a = (0, _getWorkspaceRoot.getWorkspaceRoot)()) {
-  const n = (0, _getParentPath.getParentPath)(["package-lock.json", "yarn.lock", "pnpm-lock.yaml", "bun.lock"], a);
-  if (!n) return "pnpm";
-  switch ((0, _path.findFileName)(n)) {
+var _semverFns = require("./semver-fns.cjs");
+function getPackageManager(n = (0, _getWorkspaceRoot.getWorkspaceRoot)()) {
+  const e = (0, _getParentPath.getParentPath)(["package-lock.json", "yarn.lock", "pnpm-lock.yaml", "bun.lock"], n);
+  if (!e) return "pnpm";
+  switch ((0, _path.findFileName)(e)) {
     case "yarn.lock":
       return "yarn";
     case "pnpm-lock.yaml":
@@ -28,44 +30,46 @@ function getPackageManager(a = (0, _getWorkspaceRoot.getWorkspaceRoot)()) {
       return "npm";
   }
 }
-async function f(a) {
-  let n;
+async function y(n) {
+  let e;
   for (;;) {
-    if (!a) return;
-    const e = (0, _path.findFilePath)(a);
-    if (e === a) return;
-    if (a = e, n = (0, _path.joinPaths)(a, "package.json"), await (0, _path.exists)(n)) break;
+    if (!n) return;
+    const a = (0, _path.findFilePath)(n);
+    if (a === n) return;
+    if (n = a, e = (0, _path.joinPaths)(n, "package.json"), await (0, _path.exists)(e)) break;
   }
-  return n;
+  return e;
 }
-async function u(a, n = {}) {
-  const e = await (0, _resolve.resolvePackage)(a, n);
-  if (e) return f(e);
+async function v(n, e = {}) {
+  const a = await (0, _resolve.resolvePackage)(n, e);
+  if (a) return y(a);
 }
-async function getPackageInfo(a, n = {}) {
-  const e = await u(a, n);
-  if (!e) return;
-  const t = await (0, _json.readJsonFile)(e);
+async function getPackageInfo(n, e = {}) {
+  const a = await v(n, e);
+  if (!a) return;
+  const s = await (0, _json.readJsonFile)(a);
   return {
-    name: a,
-    version: t.version,
-    rootPath: (0, _path.findFilePath)(e),
-    packageJsonPath: e,
-    packageJson: t
+    name: n,
+    version: s.version,
+    rootPath: (0, _path.findFilePath)(a),
+    packageJsonPath: a,
+    packageJson: s
   };
 }
-async function loadPackageJson(a = (0, _getWorkspaceRoot.getWorkspaceRoot)()) {
-  const n = (0, _getParentPath.getParentPath)("package.json", a, {
+async function loadPackageJson(n = (0, _getWorkspaceRoot.getWorkspaceRoot)()) {
+  const e = (0, _getParentPath.getParentPath)("package.json", n, {
     skipCwd: !1
   });
-  return !n || !(0, _nodeFs.existsSync)(n) ? null : (0, _json.readJsonFile)(n);
+  return !e || !(0, _nodeFs.existsSync)(e) ? null : (0, _json.readJsonFile)(e);
 }
-async function isPackageListed(a, n) {
-  let e = a;
-  e.includes("@") && (e = !e.startsWith("@") || e.lastIndexOf("@") > 0 ? e.slice(0, e.lastIndexOf("@")) : e);
-  const t = (await loadPackageJson(n)) ?? {};
-  return e in (t.dependencies ?? {}) || e in (t.devDependencies ?? {});
+async function isPackageListed(n, e) {
+  const a = n.replace(/@.*$/, ""),
+    s = (0, _isString.isString)(e) ? e : e?.cwd;
+  let o = (0, _isString.isString)(e) ? void 0 : e?.version;
+  (!o || !(0, _semverFns.isValidRange)(o)) && (o = n.includes("@") && (0, _semverFns.isValidRange)(n.replace(/^.*@/, "")) ? n.replace(/^.*@/, "") : void 0);
+  const t = await loadPackageJson(s);
+  return t ? !!((t.dependencies && a in t.dependencies && (!o || (0, _semverFns.satisfiesVersion)(t.dependencies[a], o))) ?? (t.devDependencies && a in t.devDependencies && t.devDependencies[a])) : !1;
 }
-function isPackageExists(a, n = {}) {
-  return !!(0, _resolve.resolvePackage)(a, n);
+function isPackageExists(n, e = {}) {
+  return !!(0, _resolve.resolvePackage)(n, e);
 }

package/dist/package-fns.d.ts

@@ -1,6 +1,7 @@
 import type { PackageResolvingOptions } from "@stryke/path/resolve";
 import type { PackageJson } from "@stryke/types/package-json";
 import type { PackageManager } from "@stryke/types/package-manager";
+import type { Range } from "semver";
 /**
  * Get the package manager used in the project
  * @param dir - The path to the project
@@ -28,6 +29,16 @@ export declare function getPackageInfo(name: string, options?: PackageResolvingO
  * @returns The package info
  */
 export declare function loadPackageJson(cwd?: any): Promise<PackageJson | null>;
+export interface PackageExistsOptions {
+    /**
+     * The current working directory
+     */
+    cwd?: string;
+    /**
+     * The version range of the package to check
+     */
+    version?: string | Range;
+}
 /**
  * Check if a package is listed in the package.json file
  *
@@ -36,6 +47,14 @@ export declare function loadPackageJson(cwd?: any): Promise<PackageJson | null>;
  * @returns An indicator specifying if the package is listed
  */
 export declare function isPackageListed(name: string, cwd?: string): Promise<boolean>;
+/**
+ * Check if a package is listed in the package.json file
+ *
+ * @param name - The name of the package
+ * @param options - The options to use when checking if the package is listed
+ * @returns An indicator specifying if the package is listed
+ */
+export declare function isPackageListed(name: string, options?: PackageExistsOptions): Promise<boolean>;
 /**
  * Check if a package exists
  *

package/dist/package-fns.mjs

@@ -1 +1 @@
-import{exists as p,findFileName as g,findFilePath as o,joinPaths as k}from"@stryke/path";import{getParentPath as r}from"@stryke/path/get-parent-path";import{getWorkspaceRoot as s}from"@stryke/path/get-workspace-root";import{resolvePackage as i}from"@stryke/path/resolve";import{existsSync as l}from"node:fs";import{readJsonFile as c}from"./json";export function getPackageManager(a=s()){const n=r(["package-lock.json","yarn.lock","pnpm-lock.yaml","bun.lock"],a);if(!n)return"pnpm";switch(g(n)){case"yarn.lock":return"yarn";case"pnpm-lock.yaml":return"pnpm";case"bun.lock":return"bun";default:return"npm"}}async function f(a){let n;for(;;){if(!a)return;const e=o(a);if(e===a)return;if(a=e,n=k(a,"package.json"),await p(n))break}return n}async function u(a,n={}){const e=await i(a,n);if(e)return f(e)}export async function getPackageInfo(a,n={}){const e=await u(a,n);if(!e)return;const t=await c(e);return{name:a,version:t.version,rootPath:o(e),packageJsonPath:e,packageJson:t}}export async function loadPackageJson(a=s()){const n=r("package.json",a,{skipCwd:!1});return!n||!l(n)?null:c(n)}export async function isPackageListed(a,n){let e=a;e.includes("@")&&(e=!e.startsWith("@")||e.lastIndexOf("@")>0?e.slice(0,e.lastIndexOf("@")):e);const t=await loadPackageJson(n)??{};return e in(t.dependencies??{})||e in(t.devDependencies??{})}export function isPackageExists(a,n={}){return!!i(a,n)}
+import{exists as f,findFileName as m,findFilePath as r,joinPaths as u}from"@stryke/path";import{getParentPath as i}from"@stryke/path/get-parent-path";import{getWorkspaceRoot as c}from"@stryke/path/get-workspace-root";import{resolvePackage as p}from"@stryke/path/resolve";import{isString as g}from"@stryke/type-checks/is-string";import{existsSync as P}from"node:fs";import{readJsonFile as k}from"./json";import{isValidRange as l,satisfiesVersion as d}from"./semver-fns";export function getPackageManager(n=c()){const e=i(["package-lock.json","yarn.lock","pnpm-lock.yaml","bun.lock"],n);if(!e)return"pnpm";switch(m(e)){case"yarn.lock":return"yarn";case"pnpm-lock.yaml":return"pnpm";case"bun.lock":return"bun";default:return"npm"}}async function y(n){let e;for(;;){if(!n)return;const a=r(n);if(a===n)return;if(n=a,e=u(n,"package.json"),await f(e))break}return e}async function v(n,e={}){const a=await p(n,e);if(a)return y(a)}export async function getPackageInfo(n,e={}){const a=await v(n,e);if(!a)return;const s=await k(a);return{name:n,version:s.version,rootPath:r(a),packageJsonPath:a,packageJson:s}}export async function loadPackageJson(n=c()){const e=i("package.json",n,{skipCwd:!1});return!e||!P(e)?null:k(e)}export async function isPackageListed(n,e){const a=n.replace(/@.*$/,""),s=g(e)?e:e?.cwd;let o=g(e)?void 0:e?.version;(!o||!l(o))&&(o=n.includes("@")&&l(n.replace(/^.*@/,""))?n.replace(/^.*@/,""):void 0);const t=await loadPackageJson(s);return t?!!((t.dependencies&&a in t.dependencies&&(!o||d(t.dependencies[a],o)))??(t.devDependencies&&a in t.devDependencies&&t.devDependencies[a])):!1}export function isPackageExists(n,e={}){return!!p(n,e)}

package/dist/semver-fns.cjs

@@ -3,20 +3,38 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.parseVersion = exports.isRelativeVersionKeyword = exports.deriveNewSemverVersion = void 0;
+exports.satisfiesVersion = exports.parseVersion = exports.isValidVersion = exports.isValidSemver = exports.isValidRange = exports.isSemver = exports.isRelativeVersionKeyword = exports.isRange = exports.deriveNewSemverVersion = exports.coerceVersion = void 0;
+var _isObject = require("@stryke/type-checks/is-object");
+var _isString = require("@stryke/type-checks/is-string");
 var _semver = require("semver");
-const parseVersion = e => (0, _semver.parse)(e),
+const parseVersion = (e, r = !0) => (0, _semver.parse)(e, r),
+  coerceVersion = (e, r) => (0, _semver.coerce)(e, r),
+  isSemver = e => (0, _isObject.isObject)(e) && "version" in e,
+  isRange = e => (0, _isObject.isObject)(e) && "range" in e,
+  isValidSemver = (e, r = !0) => ((0, _isString.isString)(e) || isSemver(e)) && (0, _semver.valid)(e, r) !== null,
+  isValidRange = (e, r = !0) => ((0, _isString.isString)(e) || isRange(e)) && (0, _semver.validRange)(e, r) !== null,
+  isValidVersion = (e, r = !0) => isValidSemver(e, r) || isValidRange(e, r),
+  satisfiesVersion = (e, r, n = !0) => !e || !r || !isValidSemver(e, n) || !isValidRange(r, n) ? !1 : (0, _semver.satisfies)(e, r, {
+    loose: n
+  }),
   isRelativeVersionKeyword = e => _semver.RELEASE_TYPES.includes(e),
   deriveNewSemverVersion = (e, r, n) => {
     if (!(0, _semver.valid)(e)) throw new Error(`Invalid semver version "${e}" provided.`);
-    let o = r;
+    let t = r;
     if (isRelativeVersionKeyword(r)) {
-      const i = (0, _semver.inc)(e, r, n);
-      if (!i) throw new Error(`Unable to derive new version from current version "${e}" and version specifier "${r}"`);
-      o = i;
+      const o = (0, _semver.inc)(e, r, n);
+      if (!o) throw new Error(`Unable to derive new version from current version "${e}" and version specifier "${r}"`);
+      t = o;
     } else if (!(0, _semver.valid)(r)) throw new Error(`Invalid semver version specifier "${r}" provided. Please provide either a valid semver version or a valid semver version keyword.`);
-    return o;
+    return t;
   };
 exports.deriveNewSemverVersion = deriveNewSemverVersion;
 exports.isRelativeVersionKeyword = isRelativeVersionKeyword;
+exports.satisfiesVersion = satisfiesVersion;
+exports.isValidVersion = isValidVersion;
+exports.isValidRange = isValidRange;
+exports.isValidSemver = isValidSemver;
+exports.isRange = isRange;
+exports.isSemver = isSemver;
+exports.coerceVersion = coerceVersion;
 exports.parseVersion = parseVersion;

package/dist/semver-fns.d.ts

@@ -1,4 +1,86 @@
-import type { ReleaseType } from "semver";
-export declare const parseVersion: (semver: string) => import("semver").SemVer | null;
+import type { CoerceOptions, Range, ReleaseType, SemVer } from "semver";
+/**
+ * Parse a semver string into a SemVer object
+ *
+ * @param semver - The semver string to parse
+ * @param loose - Whether to use loose parsing
+ * @returns The parsed SemVer object
+ */
+export declare const parseVersion: (semver: string, loose?: boolean) => SemVer | null;
+/**
+ * Coerce a version string into a valid SemVer string
+ *
+ * @param version - The version string or number or {@link SemVer} to coerce
+ * @param options - Options to use when coercing the version
+ * @returns The coerced SemVer string or null if invalid
+ */
+export declare const coerceVersion: (version: string | number | SemVer | null | undefined, options?: CoerceOptions) => SemVer | null;
+/**
+ * Type check for {@link SemVer}
+ *
+ * @param val - The value to check
+ * @returns Whether the value is a valid {@link SemVer}
+ */
+export declare const isSemver: (val: any) => val is SemVer;
+/**
+ * Type check for {@link Range}
+ *
+ * @param val - The value to check
+ * @returns Whether the value is a valid {@link Range}
+ */
+export declare const isRange: (val: any) => val is Range;
+/**
+ * Check if a {@link SemVer} string is valid
+ *
+ * @remarks
+ * If you're looking for type checking, please use the {@link isSemver} function.
+ *
+ * @param semver - The semver string to check
+ * @param loose - Whether to use loose parsing
+ * @returns Whether the semver string is valid
+ */
+export declare const isValidSemver: (semver: any, loose?: boolean) => boolean;
+/**
+ * Check if a {@link Range} string is valid
+ *
+ * @remarks
+ * If you're looking for type checking, please use the {@link isRange} function.
+ *
+ * @param range - The range string to check
+ * @param loose - Whether to use loose parsing
+ * @returns Whether the range string is valid
+ */
+export declare const isValidRange: (range: any, loose?: boolean) => boolean;
+/**
+ * Check if a {@link SemVer} or {@link Range} string is valid
+ *
+ * @param version - The semver string to check
+ * @param loose - Whether to use loose parsing
+ * @returns Whether the semver string is valid
+ */
+export declare const isValidVersion: (version: string | SemVer | Range | null | undefined, loose?: boolean) => boolean;
+/**
+ * Check if a semver string satisfies a range
+ *
+ * @param version - The semver string to check
+ * @param range - The range to check against
+ * @param loose - Whether to use loose parsing
+ * @returns Whether the semver string satisfies the range
+ */
+export declare const satisfiesVersion: (version: string | SemVer | null | undefined, range: string | Range | null | undefined, loose?: boolean) => boolean;
+/**
+ * Check if a string is a valid relative version keyword
+ *
+ * @param val - The string to check
+ * @returns Whether the string is a valid relative version keyword
+ */
 export declare const isRelativeVersionKeyword: (val: string) => val is ReleaseType;
+/**
+ * Derive a new semver version from the current version and a version specifier
+ *
+ * @param currentSemverVersion - The current semver version
+ * @param semverSpecifier - The semver specifier to use
+ * @param preid - The pre-release identifier to use
+ * @returns The derived new semver version
+ */
 export declare const deriveNewSemverVersion: (currentSemverVersion: string, semverSpecifier: string, preid?: string) => string;

package/dist/semver-fns.mjs

@@ -1 +1 @@
-import{RELEASE_TYPES as t,inc as a,parse as d,valid as s}from"semver";export const parseVersion=e=>d(e),isRelativeVersionKeyword=e=>t.includes(e),deriveNewSemverVersion=(e,r,n)=>{if(!s(e))throw new Error(`Invalid semver version "${e}" provided.`);let o=r;if(isRelativeVersionKeyword(r)){const i=a(e,r,n);if(!i)throw new Error(`Unable to derive new version from current version "${e}" and version specifier "${r}"`);o=i}else if(!s(r))throw new Error(`Invalid semver version specifier "${r}" provided. Please provide either a valid semver version or a valid semver version keyword.`);return o};
+import{isObject as s}from"@stryke/type-checks/is-object";import{isString as a}from"@stryke/type-checks/is-string";import{RELEASE_TYPES as l,coerce as d,inc as u,parse as p,satisfies as v,valid as i,validRange as c}from"semver";export const parseVersion=(e,r=!0)=>p(e,r),coerceVersion=(e,r)=>d(e,r),isSemver=e=>s(e)&&"version"in e,isRange=e=>s(e)&&"range"in e,isValidSemver=(e,r=!0)=>(a(e)||isSemver(e))&&i(e,r)!==null,isValidRange=(e,r=!0)=>(a(e)||isRange(e))&&c(e,r)!==null,isValidVersion=(e,r=!0)=>isValidSemver(e,r)||isValidRange(e,r),satisfiesVersion=(e,r,n=!0)=>!e||!r||!isValidSemver(e,n)||!isValidRange(r,n)?!1:v(e,r,{loose:n}),isRelativeVersionKeyword=e=>l.includes(e),deriveNewSemverVersion=(e,r,n)=>{if(!i(e))throw new Error(`Invalid semver version "${e}" provided.`);let t=r;if(isRelativeVersionKeyword(r)){const o=u(e,r,n);if(!o)throw new Error(`Unable to derive new version from current version "${e}" and version specifier "${r}"`);t=o}else if(!i(r))throw new Error(`Invalid semver version specifier "${r}" provided. Please provide either a valid semver version or a valid semver version keyword.`);return t};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/fs",
-  "version": "0.23.3",
+  "version": "0.24.0",
   "type": "module",
   "description": "A package containing various file system utilities that expand the functionality of NodeJs's built-in `fs` module.",
   "repository": {
@@ -15,7 +15,7 @@
     "@antfu/install-pkg": "^1.0.0",
     "@ltd/j-toml": "^1.38.0",
     "@stryke/convert": "^0.3.1",
-    "@stryke/path": "^0.12.3",
+    "@stryke/path": "0.12.5",
     "@zkochan/js-yaml": "^0.0.7",
     "chalk": "^5.4.1",
     "defu": "^6.1.4",
@@ -24,8 +24,8 @@
     "nanotar": "^0.2.0",
     "semver": "7.7.1",
     "@stryke/json": "^0.9.3",
-    "@stryke/type-checks": "^0.3.7",
-    "@stryke/types": "^0.8.8"
+    "@stryke/type-checks": "^0.3.9",
+    "@stryke/types": "^0.8.9"
   },
   "devDependencies": {
     "@types/node": "^22.14.0",
@@ -337,5 +337,5 @@
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
-  "gitHead": "bd1c18c69a24e82c1b126b1e5de36008bbac52d9"
+  "gitHead": "f8abb224a6b6540e442cc664bbb2cf1273b2be2b"
 }