@flakiness/junit-xml 1.0.0-alpha.0 → 1.0.0

package/README.md

@@ -1,14 +1,14 @@
 # @flakiness/junit-xml
 
-Convert JUnit XML test reports into a Flakiness report and upload it to [flakiness.io](https://flakiness.io). Parses Surefire and TestNG output, nested `<testsuites>`, retries, `<system-out>` / `<system-err>`, and file attachments.
+Convert JUnit XML test reports into a Flakiness report and upload it to [flakiness.io](https://flakiness.io).
 
 The recommended way to run it is with `npx` (no install step):
 
 ```bash
-npx @flakiness/junit-xml ./build/reports/junit --flakiness-project myorg/myproject
+npx @flakiness/junit-xml --flakiness-project myorg/myproject ./build/reports/junit 
 ```
 
-This combines every XML file under the given path into a single Flakiness report and uploads it to flakiness.io.
+This combines every XML file under the given path into a single Flakiness report and auto-uploads it to flakiness.io. See [authentication](#authentication) on how to configure auto-upload.
 
 If your environment has no Node.js, a [standalone binary](#standalone-binary-no-nodejs) is also available.
 
@@ -18,13 +18,13 @@ If your environment has no Node.js, a [standalone binary](#standalone-binary-no-
 - [Example: ingesting `bun test` results](#example-ingesting-bun-test-results)
 - [Example: ingesting Rust `cargo-nextest` results](#example-ingesting-rust-cargo-nextest-results)
 - [Standalone binary (no Node.js)](#standalone-binary-no-nodejs)
-- [Uploading](#uploading)
+- [Authentication](#authentication)
 - [License](#license)
 
 ## Usage
 
 ```
-flakiness-junit-xml <junit-path> [options]
+flakiness-junit-xml [options] <junit-path>
 
   <junit-path>                   JUnit XML file, or a directory of XML files (scanned recursively)
   --env-name <name>              Environment name (defaults to --category, or `junit`)
@@ -48,7 +48,7 @@ Requires Node.js `^20.17.0 || >=22.9.0`.
 
 ```bash
 bun test --reporter=junit --reporter-outfile=./junit.xml
-npx @flakiness/junit-xml ./junit.xml --category bun --flakiness-project myorg/myproject
+npx @flakiness/junit-xml --category bun --flakiness-project myorg/myproject ./junit.xml
 ```
 
 ## Example: ingesting Rust `cargo-nextest` results
@@ -64,12 +64,13 @@ Then run the tests and point at the XML nextest writes under `target/nextest/`:
 
 ```bash
 cargo nextest run --profile ci
-npx @flakiness/junit-xml ./target/nextest/ci/junit.xml --category rust --flakiness-project myorg/myproject
+npx @flakiness/junit-xml --category rust --flakiness-project myorg/myproject ./target/nextest/ci/junit.xml
 ```
 
 ## Standalone binary (no Node.js)
 
-A secondary distribution: a single self-contained executable that bundles its own runtime, so it works on machines without Node.js. The CLI, flags, and behavior are identical to the `npx` version — only the way you launch it differs.
+This tool is also shipped as a single self-contained executable that bundles
+its own runtime, so it works on machines without Node.js.
 
 **macOS / Linux:**
 
@@ -86,18 +87,16 @@ irm https://github.com/flakiness/junit-xml/releases/latest/download/install.ps1
 This installs a `flakiness-junit-xml` command on your `PATH`. Then use it exactly as above:
 
 ```bash
-flakiness-junit-xml ./build/reports/junit --flakiness-project myorg/myproject
+flakiness-junit-xml --flakiness-project myorg/myproject ./build/reports/junit 
 ```
 
-The installer detects your OS/architecture (x64 and arm64; Linux glibc and Alpine/musl) and always pulls the latest release. To pin a directory, set `INSTALL_DIR` (default `/usr/local/bin`):
+> [!NOTE]
+> You can set `INSTALL_DIR` to configure custom location for installation.
+> ```bash
+> curl -fsSL https://github.com/flakiness/junit-xml/releases/latest/download/install.sh | INSTALL_DIR="$HOME/.local/bin" sh
+> ```
 
-```bash
-curl -fsSL https://github.com/flakiness/junit-xml/releases/latest/download/install.sh | INSTALL_DIR="$HOME/.local/bin" sh
-```
-
-Prefer `npx` when Node.js is available — it's the primary, always-current path. Reach for the standalone binary only when Node.js isn't an option.
-
-## Uploading
+## Authentication
 
 The report is uploaded to flakiness.io automatically. Authentication, in priority order:
 

package/lib/cli.js

@@ -12,7 +12,7 @@ const STDERR_LOGGER = {
 function envBool(name) {
   return ["1", "true"].includes(process.env[name]?.toLowerCase() ?? "");
 }
-const program = new Command("flakiness-junit-xml").description("Convert JUnit XML report(s) to a Flakiness report and upload it to flakiness.io").argument("<junit-path>", "Path to a JUnit XML file or a directory containing XML files").option("--env-name <name>", "Environment name for the report (defaults to --category, or `junit` if neither is set)").option("--commit-id <id>", "Git commit ID (auto-detected from the current working directory if not provided)").addOption(new Option("--title <title>", "Human-readable report title").env("FLAKINESS_TITLE")).option("--output-dir <dir>", "Output directory for the report", "flakiness-report").option("-c, --category <category>", "Report category identifier (e.g. `bun`, `rust`). Defaults to `junit`.").addOption(new Option("--flakiness-project <project>", "Flakiness project identifier in `org/project` format").env("FLAKINESS_PROJECT")).addOption(new Option("-p, --project <org/project>").hideHelp()).addOption(new Option("--token <token>", "Flakiness.io access token for upload").env("FLAKINESS_ACCESS_TOKEN")).option("--endpoint <url>", "Flakiness.io API endpoint override").addOption(new Option("--disable-upload", "Convert only; do not upload to flakiness.io").env("FLAKINESS_DISABLE_UPLOAD")).action(async (junitPath, options) => {
+const program = new Command("flakiness-junit-xml").description("Convert JUnit XML report(s) to a Flakiness report and upload it to flakiness.io").argument("<junit-path>", "Path to a JUnit XML file or a directory containing XML files").option("-c, --category <category>", "Report category identifier (e.g. `bun`, `rust`). Defaults to `junit`.").option("--env-name <name>", "Environment name for the report (defaults to --category, or `junit` if neither is set)").option("--commit-id <id>", "Git commit ID (auto-detected from the current working directory if not provided)").addOption(new Option("--title <title>", "Human-readable report title").env("FLAKINESS_TITLE")).option("--output-dir <dir>", "Output directory for the report", "flakiness-report").addOption(new Option("--flakiness-project <project>", "Flakiness project identifier in `org/project` format").env("FLAKINESS_PROJECT")).addOption(new Option("-p, --project <org/project>").hideHelp()).addOption(new Option("--token <token>", "Flakiness.io access token for upload").env("FLAKINESS_ACCESS_TOKEN")).option("--endpoint <url>", "Flakiness.io API endpoint override").addOption(new Option("--disable-upload", "Convert only; do not upload to flakiness.io").env("FLAKINESS_DISABLE_UPLOAD")).action(async (junitPath, options) => {
   await runConvert(junitPath, {
     envName: options.envName ?? options.category ?? "junit",
     outputDir: options.outputDir,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/junit-xml",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -10,11 +10,6 @@
   "bin": {
     "flakiness-junit-xml": "lib/cli.js"
   },
-  "scripts": {
-    "build": "kubik build.mts",
-    "watch": "kubik build.mts -w",
-    "test": "playwright test"
-  },
   "keywords": [
     "junit",
     "junit-xml",
@@ -45,5 +40,10 @@
     "kubik": "^0.24.0",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3"
+  },
+  "scripts": {
+    "build": "kubik build.mts",
+    "watch": "kubik build.mts -w",
+    "test": "playwright test"
   }
-}
+}