@tombi-toml/lib 0.0.0-dev → 1.5.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 tombi-toml
+
+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/binding.d.ts

@@ -0,0 +1,64 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+
+/** The content of a `tombi.toml` config file at a given path. */
+export interface ConfigFile {
+  content: string
+  path: string
+}
+
+/** A diagnostic reported by Tombi. */
+export interface Diagnostic {
+  level: "error" | "warning"
+  code: string
+  message: string
+  range: Range
+  sourceFile: string | null
+}
+
+/** Format a TOML document. */
+export declare function format(source: string, sourcePath: string, options?: Options | undefined | null): Promise<FormatResult>
+
+/** The result of formatting a TOML document. */
+export interface FormatResult {
+  /** The formatted source, or `undefined` if formatting failed. */
+  formatted?: string
+  diagnostics: Array<Diagnostic>
+}
+
+/** Format a TOML document synchronously, blocking the calling thread. */
+export declare function formatSync(source: string, sourcePath: string, options?: Options | undefined | null): FormatResult
+
+/** Lint a TOML document. */
+export declare function lint(source: string, sourcePath: string, options?: Options | undefined | null): Promise<LintResult>
+
+/** The result of linting a TOML document. */
+export interface LintResult {
+  diagnostics: Array<Diagnostic>
+}
+
+/** Lint a TOML document synchronously, blocking the calling thread. */
+export declare function lintSync(source: string, sourcePath: string, options?: Options | undefined | null): LintResult
+
+/** Options shared by the formatter and linter. */
+export interface Options {
+  /**
+   * An in-memory `tombi.toml` configuration.
+   * When a string is provided, it is treated as the content of a virtual
+   * `tombi.toml`. When omitted, `tombi.toml` is searched from the current
+   * working directory.
+   */
+  config?: string | ConfigFile
+}
+
+/** A zero-based position in a TOML document. */
+export interface Position {
+  line: number
+  column: number
+}
+
+/** A range in a TOML document. */
+export interface Range {
+  start: Position
+  end: Position
+}

package/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./binding";
+
+/**
+ * The error `format`/`lint` reject with (and `formatSync`/`lintSync` throw) when
+ * the configuration, a schema, or an I/O operation fails. Malformed `options`
+ * reject (or throw) with a `TypeError` instead.
+ */
+export interface TombiError extends Error {
+  readonly name: "TombiError";
+}

package/index.js

@@ -0,0 +1,73 @@
+const { existsSync } = require("node:fs");
+const { join } = require("node:path");
+const { platform, arch, env } = process;
+// Published as both `@tombi-toml/lib` and `tombi-lib` (the release
+// workflow only rewrites `name`), so read it rather than hard-coding one.
+const { name: packageName } = require("./package.json");
+
+function isMusl() {
+  // `glibcVersionRuntime` is only reported by glibc-based Node.js builds.
+  const report = process.report?.getReport();
+  const header = typeof report === "string" ? JSON.parse(report).header : report?.header;
+  return !header?.glibcVersionRuntime;
+}
+
+const PLATFORMS = {
+  win32: {
+    x64: "@tombi-toml/lib-win32-x64",
+    arm64: "@tombi-toml/lib-win32-arm64",
+  },
+  darwin: {
+    x64: "@tombi-toml/lib-darwin-x64",
+    arm64: "@tombi-toml/lib-darwin-arm64",
+  },
+  linux: {
+    x64: "@tombi-toml/lib-linux-x64",
+    arm64: "@tombi-toml/lib-linux-arm64",
+  },
+  "linux-musl": {
+    x64: "@tombi-toml/lib-linux-x64-musl",
+    arm64: "@tombi-toml/lib-linux-arm64-musl",
+  },
+};
+
+function loadBinding() {
+  if (env.TOMBI_LIB_BINARY) {
+    return require(env.TOMBI_LIB_BINARY);
+  }
+
+  // A local `pnpm build` output, for development within this repository.
+  const localBinary = join(__dirname, "tombi-lib.node");
+  if (existsSync(localBinary)) {
+    return require(localBinary);
+  }
+
+  const bindingPackageName =
+    platform === "linux" && isMusl()
+      ? PLATFORMS["linux-musl"][arch]
+      : PLATFORMS[platform]?.[arch];
+
+  if (!bindingPackageName) {
+    throw new Error(
+      `${packageName} doesn't ship with a prebuilt binary for ${platform}-${arch} yet.`,
+    );
+  }
+
+  try {
+    return require(`${bindingPackageName}/tombi-lib.node`);
+  } catch (error) {
+    throw new Error(
+      `The Tombi native binding "${bindingPackageName}" could not be loaded. ` +
+        "The platform-specific optional package may not be installed. " +
+        `Please reinstall ${packageName} with optional dependencies enabled.`,
+      { cause: error },
+    );
+  }
+}
+
+const binding = loadBinding();
+
+module.exports.format = binding.format;
+module.exports.lint = binding.lint;
+module.exports.formatSync = binding.formatSync;
+module.exports.lintSync = binding.lintSync;

package/package.json

@@ -1,12 +1,57 @@
 {
   "name": "@tombi-toml/lib",
-  "version": "0.0.0-dev",
+  "version": "1.5.10",
+  "description": "Tombi formatter and linter library for Node.js",
+  "keywords": [
+    "toml",
+    "formatter",
+    "linter"
+  ],
+  "author": "tombi-toml",
   "license": "MIT",
+  "private": false,
+  "homepage": "https://tombi-toml.github.io/tombi/",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/tombi-toml/tombi.git",
     "directory": "typescript/@tombi-toml/lib"
   },
-  "homepage": "https://tombi-toml.github.io/tombi/",
-  "description": "Tombi formatter and linter library for Node.js (placeholder)"
-}
+  "bugs": {
+    "url": "https://github.com/tombi-toml/tombi/issues"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "binding.d.ts",
+    "LICENSE"
+  ],
+  "napi": {
+    "binaryName": "tombi-lib"
+  },
+  "scripts": {
+    "build": "napi build --manifest-path ../../../rust/tombi-lib-node/Cargo.toml --release --output-dir . --dts binding.d.ts",
+    "test": "node --test tests/*.test.mjs"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "3.10.5"
+  },
+  "optionalDependencies": {
+    "@tombi-toml/lib-win32-x64": "1.5.10",
+    "@tombi-toml/lib-win32-arm64": "1.5.10",
+    "@tombi-toml/lib-darwin-x64": "1.5.10",
+    "@tombi-toml/lib-darwin-arm64": "1.5.10",
+    "@tombi-toml/lib-linux-x64": "1.5.10",
+    "@tombi-toml/lib-linux-arm64": "1.5.10",
+    "@tombi-toml/lib-linux-x64-musl": "1.5.10",
+    "@tombi-toml/lib-linux-arm64-musl": "1.5.10"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# @tombi-toml/lib
-
-Placeholder. Real releases are published from https://github.com/tombi-toml/tombi.