@ferrflow/darwin-arm64 2.13.1 → 2.15.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2024-present FerrFlow Contributors
+
+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/README.md

@@ -0,0 +1,381 @@
+# FerrFlow
+
+[![CI](https://github.com/FerrFlow-Org/FerrFlow/actions/workflows/ci.yml/badge.svg)](https://github.com/FerrFlow-Org/FerrFlow/actions/workflows/ci.yml)
+[![Release](https://github.com/FerrFlow-Org/FerrFlow/actions/workflows/release.yml/badge.svg)](https://github.com/FerrFlow-Org/FerrFlow/actions/workflows/release.yml)
+[![Latest release](https://img.shields.io/github/v/release/FerrFlow-Org/FerrFlow)](https://github.com/FerrFlow-Org/FerrFlow/releases/latest)
+[![Coverage](https://codecov.io/gh/FerrFlow-Org/FerrFlow/graph/badge.svg)](https://codecov.io/gh/FerrFlow-Org/FerrFlow)
+[![License](https://img.shields.io/github/license/FerrFlow-Org/FerrFlow)](LICENSE)
+[![Socket Badge](https://badge.socket.dev/npm/package/ferrflow/latest)](https://badge.socket.dev/npm/package/ferrflow/latest)
+[![Known Vulnerabilities](https://snyk.io/test/npm/ferrflow/badge.svg)](https://snyk.io/test/npm/ferrflow)
+
+Universal semantic versioning for monorepos and classic repos.
+
+FerrFlow reads your commit history, determines the right version bump, updates your version files, generates a changelog, and creates a tagged release — for any language, any repo layout.
+
+## Why FerrFlow?
+
+Most versioning tools are tied to a specific ecosystem (semantic-release for JS, cargo-release for Rust) or require a Node.js runtime. FerrFlow is a single compiled binary with no runtime dependencies.
+
+| Tool | Monorepo | Multi-language | Runtime |
+|------|----------|---------------|---------|
+| semantic-release | plugins | JS only | Node.js |
+| changesets | manual | JS only | Node.js |
+| knope | limited | partial | none |
+| FerrFlow | native | yes | none |
+
+## Supported version files
+
+| Format | File | Ecosystem |
+|--------|------|-----------|
+| TOML | `Cargo.toml` | Rust |
+| TOML | `pyproject.toml` | Python |
+| JSON | `package.json` | Node.js |
+| XML | `pom.xml` | Java / Maven |
+
+## Installation
+
+**Cargo**
+
+```bash
+cargo install ferrflow
+```
+
+**npm**
+
+```bash
+npm install -D ferrflow
+```
+
+**Docker**
+
+```bash
+docker run ghcr.io/ferrflow/ferrflow:latest check
+```
+
+**Pre-built binaries**
+
+Download from [Releases](https://github.com/FerrFlow-Org/FerrFlow/releases).
+
+## Usage
+
+```bash
+# Preview what would be bumped
+ferrflow check
+
+# Run a release
+ferrflow release
+
+# Dry run
+ferrflow release --dry-run
+
+# Pre-release
+ferrflow release --channel beta
+
+# Scaffold a config file
+ferrflow init
+
+# Scaffold a config file in a specific format
+ferrflow init --format json5
+
+# Use a specific config file
+ferrflow check --config path/to/ferrflow.toml
+
+# Or set via environment variable
+FERRFLOW_CONFIG=path/to/ferrflow.toml ferrflow check
+
+# Print current version
+ferrflow version              # single repo
+ferrflow version api          # monorepo, specific package
+
+# Print last release tag
+ferrflow tag
+ferrflow tag api
+
+# JSON output (for scripting)
+ferrflow version --json
+ferrflow tag --json
+
+# Shell completions
+ferrflow completions bash >> ~/.bash_completion
+ferrflow completions zsh  > ~/.zfunc/_ferrflow
+ferrflow completions fish > ~/.config/fish/completions/ferrflow.fish
+```
+
+Pre-generated completion scripts are also available as `ferrflow-completions.tar.gz` in each [GitHub release](https://github.com/FerrFlow-Org/FerrFlow/releases).
+
+## Configuration
+
+FerrFlow looks for a config file at the root of your repository, in this order:
+
+1. `ferrflow.json`
+2. `ferrflow.json5`
+3. `ferrflow.toml`
+4. `.ferrflow` (dotfile, JSON format)
+
+If multiple config files exist, FerrFlow exits with an error listing the conflicting files. Use `--config <path>` (or `FERRFLOW_CONFIG` env var) to specify which one to use. If no config file is found, FerrFlow auto-detects common version files in the current directory.
+
+Run `ferrflow init` to scaffold a config file interactively. Use `--format` to skip the format prompt:
+
+```bash
+ferrflow init                  # asks which format (default: json)
+ferrflow init --format json5
+ferrflow init --format toml
+ferrflow init --format dotfile # generates .ferrflow
+```
+
+### JSON Schema
+
+Add `$schema` to get autocompletion and validation in VS Code, WebStorm, and any JSON-aware editor:
+
+```json
+{
+  "$schema": "https://ferrflow.com/schema/ferrflow.json"
+}
+```
+
+### JSON (default)
+
+```json
+{
+  "$schema": "https://ferrflow.com/schema/ferrflow.json",
+  "workspace": {
+    "remote": "origin",
+    "branch": "main"
+  },
+  "package": [
+    {
+      "name": "my-app",
+      "path": ".",
+      "changelog": "CHANGELOG.md",
+      "versioned_files": [
+        { "path": "package.json", "format": "json" }
+      ]
+    }
+  ]
+}
+```
+
+### JSON5
+
+```json5
+{
+  workspace: {
+    remote: "origin",
+    branch: "main",
+  },
+  package: [
+    {
+      name: "my-app",
+      path: ".",
+      changelog: "CHANGELOG.md",
+      versioned_files: [
+        { path: "package.json", format: "json" },
+      ],
+    },
+  ],
+}
+```
+
+### TOML
+
+```toml
+[workspace]
+remote = "origin"
+branch = "main"
+
+[[package]]
+name = "my-app"
+path = "."
+changelog = "CHANGELOG.md"
+
+[[package.versioned_files]]
+path = "Cargo.toml"
+format = "toml"
+```
+
+### Monorepo
+
+<details>
+<summary>JSON</summary>
+
+```json
+{
+  "package": [
+    {
+      "name": "api",
+      "path": "services/api",
+      "changelog": "services/api/CHANGELOG.md",
+      "shared_paths": ["services/shared/"],
+      "versioned_files": [
+        { "path": "services/api/Cargo.toml", "format": "toml" }
+      ]
+    },
+    {
+      "name": "frontend",
+      "path": "frontend",
+      "changelog": "frontend/CHANGELOG.md",
+      "versioned_files": [
+        { "path": "frontend/package.json", "format": "json" }
+      ]
+    }
+  ]
+}
+```
+
+</details>
+
+<details>
+<summary>TOML</summary>
+
+```toml
+[[package]]
+name = "api"
+path = "services/api"
+changelog = "services/api/CHANGELOG.md"
+shared_paths = ["services/shared/"]
+
+[[package.versioned_files]]
+path = "services/api/Cargo.toml"
+format = "toml"
+
+[[package]]
+name = "frontend"
+path = "frontend"
+changelog = "frontend/CHANGELOG.md"
+
+[[package.versioned_files]]
+path = "frontend/package.json"
+format = "json"
+```
+
+</details>
+
+## Versioning Strategies
+
+Each package can use its own versioning strategy. Set a default at the workspace level and override per package:
+
+```toml
+[workspace]
+versioning = "semver"  # default for all packages
+
+[[package]]
+name = "api"
+path = "packages/api"
+# inherits semver from workspace
+
+[[package]]
+name = "site"
+path = "packages/site"
+versioning = "calver"  # override: date-based
+```
+
+| Strategy | Format | Example | Description |
+|----------|--------|---------|-------------|
+| `semver` | `MAJOR.MINOR.PATCH` | `1.4.2` | Default, driven by conventional commits |
+| `calver` | `YYYY.M.D` | `2025.3.28` | Date-based, ignores commit types |
+| `calver-short` | `YY.M.D` | `25.3.28` | Compact date-based |
+| `calver-seq` | `YYYY.M.SEQ` | `2025.3.3` | Date + daily sequence counter |
+| `sequential` | `N` | `42` | Simple incrementing build number |
+| `zerover` | `0.MINOR.PATCH` | `0.15.2` | Permanently unstable, never hits 1.0 |
+
+## Tag Template
+
+By default, FerrFlow tags single-repo releases as `v1.2.3` and monorepo releases as `api@v1.2.3`. Customize with `tag_template` at the workspace or package level using `{name}` and `{version}` placeholders.
+
+```toml
+[workspace]
+tag_template = "v{version}"  # all packages: v1.2.3
+
+[[package]]
+name = "api"
+path = "packages/api"
+tag_template = "{name}/v{version}"  # override: api/v1.2.3
+```
+
+| Layout | Default template | Example tag |
+|--------|-----------------|-------------|
+| Single repo | `v{version}` | `v1.2.3` |
+| Monorepo | `{name}@v{version}` | `api@v1.2.3` |
+| Custom | `release-{version}` | `release-1.2.3` |
+
+## Pre-release Channels
+
+Publish pre-release versions (alpha, beta, rc, dev) using the `--channel` flag or branch-based configuration. Pre-release versions follow the format `MAJOR.MINOR.PATCH-CHANNEL.IDENTIFIER`.
+
+### CLI flag
+
+```bash
+ferrflow release --channel beta       # 2.0.0-beta.1
+ferrflow check --channel rc           # preview pre-release version
+```
+
+### Branch-based configuration
+
+Map branches to channels automatically:
+
+```json
+{
+  "workspace": {
+    "branches": [
+      { "name": "main", "channel": false },
+      { "name": "develop", "channel": "dev", "prereleaseIdentifier": "timestamp" },
+      { "name": "release/*", "channel": "rc" }
+    ]
+  }
+}
+```
+
+Branch names support glob patterns. The first match wins.
+
+### Identifier strategies
+
+| Strategy | Example | Description |
+|----------|---------|-------------|
+| `increment` | `-beta.3` | Auto-incrementing counter (default) |
+| `timestamp` | `-dev.20250402T1430` | UTC timestamp |
+| `short-hash` | `-dev.a1b2c3d` | Git short hash |
+| `timestamp-hash` | `-dev.20250402T1430-a1b2c3d` | Timestamp + hash |
+
+### Behavior
+
+- Floating tags (e.g. `v1`, `v1.2`) are never moved by pre-release versions
+- GitHub Releases are marked as pre-release
+- Stable releases include all commits since the last stable tag (skipping pre-release tags)
+- Hook environment includes `FERRFLOW_CHANNEL` and `FERRFLOW_IS_PRERELEASE`
+
+## Conventional Commits
+
+FerrFlow follows the [Conventional Commits](https://www.conventionalcommits.org/) spec.
+
+| Prefix | Bump |
+|--------|------|
+| `fix:`, `perf:`, `refactor:` | patch |
+| `feat:` | minor |
+| `feat!:`, `BREAKING CHANGE` | major |
+| `chore:`, `docs:`, `ci:` | none |
+
+## CI usage
+
+**GitLab CI**
+
+```yaml
+release:
+  image: ghcr.io/ferrflow/ferrflow:latest
+  script:
+    - ferrflow release
+  rules:
+    - if: '$CI_COMMIT_BRANCH == "main"'
+```
+
+**GitHub Actions**
+
+```yaml
+- name: Release
+  run: ferrflow release
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+## License
+
+MIT

package/package.json

@@ -3,7 +3,7 @@
     "arm64"
   ],
   "description": "FerrFlow macOS arm64 binary",
-  "license": "MPL-2.0",
+  "license": "MIT",
   "name": "@ferrflow/darwin-arm64",
   "os": [
     "darwin"
@@ -12,5 +12,5 @@
     "type": "git",
     "url": "git+https://github.com/FerrFlow-Org/FerrFlow.git"
   },
-  "version": "2.13.1"
+  "version": "2.15.5"
 }