prettier-plugin-biome 0.0.0-stage → 2.5.1792263015

package/README.md

@@ -1,3 +1,69 @@
-# Temporary Holding Version
+# prettier-plugin-biome
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+## Usage
+
+```json
+{
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "options": {
+        "assist.actions.preset": "recommended",
+        "assist.actions.recommended": true,
+        "assist.actions.source.noDuplicateClasses": "off",
+        "assist.actions.source.organizeImports": "on",
+        "assist.actions.source.useSortedAttributes": "off",
+        "assist.actions.source.useSortedEnumMembers": "off",
+        "assist.actions.source.useSortedInterfaceMembers": "off",
+        "assist.actions.source.useSortedKeys": "off",
+        "assist.actions.source.useSortedPackageJson": "off",
+        "assist.actions.source.useSortedProperties": "off",
+        "assist.actions.source.useSortedSelectionSet": "off",
+        "assist.actions.source.useSortedTypeFields": "off",
+        "assist.enabled": true,
+        "formatter.attributePosition": "auto",
+        "formatter.bracketSameLine": false,
+        "formatter.bracketSpacing": true,
+        "formatter.delimiterSpacing": false,
+        "formatter.enabled": true,
+        "formatter.expand": "auto",
+        "formatter.indentStyle": "tab",
+        "formatter.indentWidth": 2,
+        "formatter.lineEnding": "lf",
+        "formatter.lineWidth": 80,
+        "formatter.trailingNewline": true,
+        "javascript.assist.enabled": true,
+        "javascript.formatter.arrowParentheses": "always",
+        "javascript.formatter.attributePosition": "auto",
+        "javascript.formatter.bracketSameLine": false,
+        "javascript.formatter.bracketSpacing": true,
+        "javascript.formatter.delimiterSpacing": false,
+        "javascript.formatter.enabled": true,
+        "javascript.formatter.expand": "auto",
+        "javascript.formatter.indentStyle": "tab",
+        "javascript.formatter.indentWidth": 2,
+        "javascript.formatter.jsxQuoteStyle": "double",
+        "javascript.formatter.lineEnding": "lf",
+        "javascript.formatter.lineWidth": 80,
+        "javascript.formatter.operatorLinebreak": "after",
+        "javascript.formatter.quoteProperties": "asNeeded",
+        "javascript.formatter.quoteStyle": "double",
+        "javascript.formatter.semicolons": "always",
+        "javascript.formatter.trailingCommas": "all",
+        "javascript.formatter.trailingNewline": true,
+        "javascript.linter.enabled": true,
+        "linter.enabled": true
+      }
+    }
+  ],
+  "plugins": ["prettier-plugin-biome"]
+}
+```
+
+```sh
+npm install -D prettier prettier-plugin-biome
+```
+
+```sh
+npx prettier -w /path/to/your.ts
+```

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import type { Plugin } from "prettier";
+interface BiomeAstNode {
+    text: string;
+    type: "BiomeRoot";
+}
+declare const plugin: Plugin<BiomeAstNode>;
+export default plugin;

package/dist/index.js

@@ -0,0 +1,201 @@
+import { createRequire } from "node:module";
+import path from "node:path";
+const AST_FORMAT = "biome-ast";
+const BOOLEAN = { category: "biome", description: "Biome option", type: "boolean" };
+const CHOICE = (values) => ({
+    category: "biome",
+    choices: values.map(value => ({ description: value, value })),
+    description: "Biome option",
+    type: "choice",
+});
+const INT = { category: "biome", type: "int" };
+const table = {
+    "assist.actions.preset": CHOICE(["recommended", "all", "none"]),
+    "assist.actions.recommended": BOOLEAN,
+    "assist.actions.source.noDuplicateClasses": CHOICE(["on", "off"]),
+    "assist.actions.source.organizeImports": CHOICE(["on", "off"]),
+    "assist.actions.source.preset": CHOICE(["recommended", "all", "none"]),
+    "assist.actions.source.recommended": BOOLEAN,
+    "assist.actions.source.useSortedAttributes": CHOICE(["on", "off"]),
+    "assist.actions.source.useSortedEnumMembers": CHOICE(["on", "off"]),
+    "assist.actions.source.useSortedInterfaceMembers": CHOICE(["on", "off"]),
+    "assist.actions.source.useSortedKeys": CHOICE(["on", "off"]),
+    "assist.actions.source.useSortedPackageJson": CHOICE(["on", "off"]),
+    "assist.actions.source.useSortedProperties": CHOICE(["on", "off"]),
+    "assist.actions.source.useSortedSelectionSet": CHOICE(["on", "off"]),
+    "assist.actions.source.useSortedTypeFields": CHOICE(["on", "off"]),
+    "assist.enabled": BOOLEAN,
+    "formatter.attributePosition": CHOICE(["auto", "multiline"]),
+    "formatter.bracketSameLine": BOOLEAN,
+    "formatter.bracketSpacing": BOOLEAN,
+    "formatter.delimiterSpacing": BOOLEAN,
+    "formatter.enabled": BOOLEAN,
+    "formatter.expand": CHOICE(["auto", "always", "never"]),
+    "formatter.indentStyle": CHOICE(["tab", "space"]),
+    "formatter.indentWidth": INT,
+    "formatter.lineEnding": CHOICE(["lf", "crlf", "cr", "auto"]),
+    "formatter.lineWidth": INT,
+    "formatter.trailingNewline": BOOLEAN,
+    "javascript.assist.enabled": BOOLEAN,
+    "javascript.formatter.arrowParentheses": CHOICE(["always", "asNeeded"]),
+    "javascript.formatter.attributePosition": CHOICE(["auto", "multiline"]),
+    "javascript.formatter.bracketSameLine": BOOLEAN,
+    "javascript.formatter.bracketSpacing": BOOLEAN,
+    "javascript.formatter.delimiterSpacing": BOOLEAN,
+    "javascript.formatter.enabled": BOOLEAN,
+    "javascript.formatter.expand": CHOICE(["auto", "always", "never"]),
+    "javascript.formatter.indentStyle": CHOICE(["tab", "space"]),
+    "javascript.formatter.indentWidth": INT,
+    "javascript.formatter.jsxQuoteStyle": CHOICE(["double", "single"]),
+    "javascript.formatter.lineEnding": CHOICE(["lf", "crlf", "cr", "auto"]),
+    "javascript.formatter.lineWidth": INT,
+    "javascript.formatter.operatorLinebreak": CHOICE(["after", "before"]),
+    "javascript.formatter.quoteProperties": CHOICE(["asNeeded", "preserve"]),
+    "javascript.formatter.quoteStyle": CHOICE(["double", "single"]),
+    "javascript.formatter.semicolons": CHOICE(["always", "asNeeded"]),
+    "javascript.formatter.trailingCommas": CHOICE(["all", "es5", "none"]),
+    "javascript.formatter.trailingNewline": BOOLEAN,
+    "javascript.linter.enabled": BOOLEAN,
+    "linter.enabled": BOOLEAN,
+};
+const require = createRequire(import.meta.url);
+const projects = new Map();
+let biomeModule;
+function loadBiome() {
+    biomeModule ??= require("@biomejs/wasm-nodejs");
+    return biomeModule;
+}
+function createConfiguration(options) {
+    const configuration = {};
+    for (const path of Object.keys(table)) {
+        const value = options[path];
+        if (value === undefined) {
+            continue;
+        }
+        const segments = path.split(".");
+        const leaf = segments.pop();
+        let node = configuration;
+        for (const segment of segments) {
+            node[segment] ??= {};
+            node = node[segment];
+        }
+        if (leaf !== undefined) {
+            node[leaf] = value;
+        }
+    }
+    return configuration;
+}
+function getProject(filePath, configuration) {
+    const projectDirectory = path.dirname(filePath);
+    const cacheKey = `${projectDirectory}\0${JSON.stringify(configuration)}`;
+    const opened = projects.get(cacheKey);
+    if (opened) {
+        return opened;
+    }
+    const workspace = new (loadBiome().Workspace)();
+    const { projectKey } = workspace.openProject({ openUninitialized: true, path: projectDirectory });
+    const { diagnostics } = workspace.updateSettings({ configuration, projectKey, workspaceDirectory: projectDirectory });
+    const errors = diagnostics.filter(diagnostic => diagnostic.severity === "error" || diagnostic.severity === "fatal");
+    if (errors.length) {
+        throw createDiagnosticsError(filePath, "", errors, "biome configuration error");
+    }
+    const project = { key: projectKey, workspace };
+    projects.set(cacheKey, project);
+    return project;
+}
+function createDiagnosticsError(filePath, source, diagnostics, prefix) {
+    const printer = new (loadBiome().DiagnosticPrinter)(filePath, source);
+    try {
+        for (const diagnostic of diagnostics) {
+            printer.print_simple(diagnostic);
+        }
+        return new Error(`${prefix}: ${filePath}\n${printer.finish()}`);
+    }
+    catch (error) {
+        printer.free();
+        throw error;
+    }
+}
+function format(text, options) {
+    const filePath = path.resolve(options.filepath ?? "input.tsx");
+    const configuration = createConfiguration(options);
+    const { key: projectKey, workspace } = getProject(filePath, configuration);
+    workspace.openFile({ content: { content: text, type: "fromClient", version: 0 }, path: filePath, projectKey });
+    try {
+        const syntax = workspace.pullDiagnostics({ categories: ["syntax"], path: filePath, projectKey });
+        if (syntax.errors) {
+            throw createDiagnosticsError(filePath, text, syntax.diagnostics, "parse error");
+        }
+        return workspace.fixFile({
+            fixFileMode: "safeFixes",
+            path: filePath,
+            projectKey,
+            ruleCategories: ["syntax", "lint", "action"],
+            shouldFormat: true,
+        }).code;
+    }
+    finally {
+        workspace.closeFile({ path: filePath, projectKey });
+    }
+}
+const biomeParser = {
+    astFormat: AST_FORMAT,
+    locEnd: node => node.text.length,
+    locStart: () => 0,
+    parse: (text, options) => ({
+        text: format(text, options),
+        type: "BiomeRoot",
+    }),
+};
+const languages = [
+    {
+        extensions: [".cjs", ".js", ".mjs"],
+        linguistLanguageId: 183,
+        name: "JavaScript",
+        parsers: ["biome"],
+        tmScope: "source.js",
+        vscodeLanguageId: "javascript",
+    },
+    {
+        extensions: [".jsx"],
+        linguistLanguageId: 183,
+        name: "JSX",
+        parsers: ["biome"],
+        tmScope: "source.js.jsx",
+        vscodeLanguageId: "javascriptreact",
+    },
+    {
+        extensions: [".cts", ".mts", ".ts"],
+        linguistLanguageId: 378,
+        name: "TypeScript",
+        parsers: ["biome"],
+        tmScope: "source.ts",
+        vscodeLanguageId: "typescript",
+    },
+    {
+        extensions: [".tsx"],
+        linguistLanguageId: 94901924,
+        name: "TSX",
+        parsers: ["biome"],
+        tmScope: "source.tsx",
+        vscodeLanguageId: "typescriptreact",
+    },
+];
+const parsers = {
+    "babel": biomeParser,
+    "babel-ts": biomeParser,
+    "biome": biomeParser,
+    "typescript": biomeParser,
+};
+const printers = {
+    [AST_FORMAT]: {
+        print: (path) => path.getValue().text,
+    },
+};
+const plugin = {
+    languages,
+    options: table,
+    parsers,
+    printers,
+};
+export default plugin;

package/package.json

@@ -1,6 +1,40 @@
 {
+  "dependencies": {
+    "@biomejs/wasm-nodejs": "2.5.15"
+  },
+  "description": "A `biome` toolchain for Prettier",
+  "devDependencies": {
+    "@tsconfig/bun": "latest",
+    "@types/bun": "latest",
+    "@types/node": "latest",
+    "prettier": "^3.0.0",
+    "typescript": "^5.0.0"
+  },
+  "exports": "./dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "biome",
+    "javascript",
+    "prettier",
+    "prettier-plugin",
+    "typescript"
+  ],
+  "license": "Unlicense",
   "name": "prettier-plugin-biome",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "peerDependencies": {
+    "prettier": "^3.0.0"
+  },
+  "repository": {
+    "directory": "source/prettier-plugin-biome",
+    "type": "git",
+    "url": "git+https://github.com/openhundun/prettier-kit.git"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc"
+  },
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "version": "2.5.1792263015"
+}