@platformize/core

The resolution engine behind Platformize. It manages platform graphs, inheritance chains, preset definitions, and candidate suffix generation without depending on any specific bundler or build tool.

Installation

npm install @platformize/core

Features

• Platform Inheritance Graphs: Support platforms extending shared ancestor platforms.
• Presets: Built-in tauri preset for macos, windows, linux, desktop, native.
• Dynamic Rules: Conditionally override resolution based on file paths or import patterns.
• Candidate Generator: Computes candidate paths preserving extensions and detecting explicit platform suffixes.

Usage

import {
  createResolvedConfig,
  getCandidateSpecifiers,
  getAllKnownPlatforms,
} from "@platformize/core";

const config = createResolvedConfig({
  preset: "tauri",
  platform: "macos",
});

console.log(config.suffixes);
// Output: [".macos", ".desktop", ".native", ""]

const known = getAllKnownPlatforms(config);
const candidates = getCandidateSpecifiers("./components/Button.tsx", config.suffixes, known);

console.log(candidates);
/*
[
  { candidate: "./components/Button.macos.tsx", suffix: ".macos" },
  { candidate: "./components/Button.desktop.tsx", suffix: ".desktop" },
  { candidate: "./components/Button.native.tsx", suffix: ".native" },
  { candidate: "./components/Button.tsx", suffix: "" }
]
*/

Custom Platform Definition (Without Presets)

You are not required to use a preset. You can build entirely custom platform inheritance graphs by passing the platforms object directly. Platformize resolves paths using a Breadth-First Search across your extends configurations.

import { createResolvedConfig } from "@platformize/core";

const config = createResolvedConfig({
  platform: "ios",
  platforms: {
    ios: { extends: ["mobile", "native"] },
    android: { extends: ["mobile", "native"] },
    mobile: { extends: ["native"] },
    native: { extends: [] },
  },
});

console.log(config.suffixes);
// Output: [".ios", ".mobile", ".native", ""]

Aliases & Workspace Packages

By default, Platformize processes local relative imports (./, ../) and absolute paths (/). It also includes common alias prefixes (@/ and ~/) automatically.

If you use a custom path alias or need platform resolution across internal workspace packages, specify them in the prefixes array:

platformize({
  preset: "tauri",
  prefixes: [".", "/", "@", "~", "@org/ui/"],
});