rainbow-fmt 0.1.0__tar.gz

rainbow_fmt-0.1.0/.gitignore

@@ -0,0 +1,25 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+
+# Virtual environments
+.venv/
+venv/
+
+# Tool caches and reports
+.cache/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+
+# Editors / OS
+.idea/
+.vscode/
+.DS_Store

rainbow_fmt-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,124 @@
+# GitLab CI for rainbow-fmt (TASKS.md T3).
+#
+# Stages:
+#   lint    - ruff (lint + format check) and mypy --strict
+#   test    - pytest with coverage on every supported Python version;
+#             benchmark against benchmarks/baseline.json (docs/benchmark.md)
+#   build   - sdist + wheel, with a sanity check of the wheel contents
+#   publish - on tags vX.Y.Z only: upload to PyPI by trusted publishing
+#             (docs/releasing.md)
+
+workflow:
+  rules:
+    # Merge request pipelines, but no duplicate branch pipeline while an MR
+    # is open for that branch.
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS
+      when: never
+    - if: $CI_COMMIT_BRANCH
+    - if: $CI_COMMIT_TAG
+
+stages:
+  - lint
+  - test
+  - build
+  - publish
+
+variables:
+  PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+  PIP_DISABLE_PIP_VERSION_CHECK: "1"
+  PYTHON_VERSION: "3.12"
+
+default:
+  image: python:${PYTHON_VERSION}-slim
+  interruptible: true
+  cache:
+    key: "pip-$CI_JOB_NAME_SLUG"
+    paths:
+      - .cache/pip
+  before_script:
+    - python --version
+    - python -m pip install -e '.[dev]'
+
+ruff:
+  stage: lint
+  script:
+    # The Code Quality report is written even when there are findings, so
+    # they show up in the merge request; the second run fails the job.
+    - ruff check --output-format=gitlab --output-file=gl-code-quality-report.json . || true
+    - ruff check .
+    - ruff format --check .
+  artifacts:
+    when: always
+    reports:
+      codequality: gl-code-quality-report.json
+
+mypy:
+  stage: lint
+  script:
+    - mypy
+
+test:
+  stage: test
+  needs: []
+  parallel:
+    matrix:
+      - PYTHON_VERSION: ["3.12", "3.13"]
+  script:
+    # Coverage options come from pyproject.toml; add the XML report for GitLab.
+    - pytest --cov-report=xml:coverage.xml --junitxml=report.xml
+  coverage: '/^TOTAL\s.*\s(\d+(?:\.\d+)?)%$/'
+  artifacts:
+    when: always
+    expire_in: 30 days
+    reports:
+      junit: report.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+
+benchmark:
+  stage: test
+  needs: []
+  script:
+    - python -m rainbow_fmt.benchmark --baseline benchmarks/baseline.json --output benchmark.json
+  artifacts:
+    when: always
+    expire_in: 30 days
+    paths:
+      - benchmark.json
+
+build:
+  stage: build
+  needs: []
+  before_script:
+    - python -m pip install build
+  script:
+    - python -m build
+    - python -m zipfile -l dist/*.whl | tee wheel-contents.txt
+    - grep -q "rainbow_fmt/py.typed" wheel-contents.txt
+    - grep -q "licenses/LICENSE" wheel-contents.txt
+    - grep -q "rainbow_fmt/presets/balanced.toml" wheel-contents.txt
+  artifacts:
+    expire_in: 7 days
+    paths:
+      - dist/
+
+publish:
+  # No "needs": the job waits for every earlier stage (lint, tests,
+  # benchmark, build) to pass, and gets dist/ from the build job.
+  stage: publish
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v[0-9]+[.][0-9]+[.][0-9]+/
+  environment: pypi
+  id_tokens:
+    PYPI_ID_TOKEN:
+      aud: pypi
+  before_script:
+    - python -m pip install twine
+  script:
+    # The tag must name the version being published (vX.Y.Z -> X.Y.Z wheel).
+    - test -f "dist/rainbow_fmt-${CI_COMMIT_TAG#v}-py3-none-any.whl"
+    - python -m twine check dist/*
+    - api_token=$(python ci/mint_pypi_token.py)
+    - python -m twine upload --non-interactive -u __token__ -p "$api_token" dist/*

rainbow_fmt-0.1.0/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+All notable changes to rainbow-fmt. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versions follow
+[Semantic Versioning](https://semver.org/) (before 1.0, minor versions may
+change the configuration format or output).
+
+## 0.1.0 — 2026-09-27
+
+First release: the core pipeline and the JSON/JSONC language pack.
+
+### Added
+
+- `rainbow-fmt format | check | diff PATH...` and `rainbow-fmt options FILE`
+  ([`docs/cli.md`](docs/cli.md)); `-` with `--stdin-filepath` for editors.
+- JSON and JSONC formatting: line width, indentation (spaces or tabs), line
+  endings, `object_wrap`, `align_values`, comments kept and attached to
+  their members, byte order mark kept.
+- Configuration in `rainbow.toml`, `.rainbow.toml`, `pyproject.toml`
+  `[tool.rainbow]`, `rainbow.yaml`/`.yml` or `package.json`, found upwards
+  from each file, with `extends`, `[[override]]` sections for globs,
+  `--set KEY=VALUE`, presets (`rainbow:balanced`, `rainbow:minimal`) and
+  `.editorconfig`; errors name the file, line and column
+  ([`docs/configuration.md`](docs/configuration.md)).
+- User rule overrides (`[[rule]]` expression templates, ADR 0005).
+- Verification of every formatted file (same syntax tree and comments,
+  stable output); `--no-verify` or `[files] verify = false` skips it.
+- Unknown file types are skipped with a warning (`-u`,
+  `[files] ignore_unknown`).
+- Deeply nested input (more than 10,000 levels of JSON) formats.
+- `python -m rainbow_fmt.benchmark` ([`docs/benchmark.md`](docs/benchmark.md)).
+
+### Known limitations
+
+- JSON only; trailing commas are not supported (JSON has none; JSONC
+  support for them is planned).
+- Blank lines between members are not kept yet.

rainbow_fmt-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bjørn Pettersen
+
+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.

rainbow_fmt-0.1.0/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.5
+Name: rainbow-fmt
+Version: 0.1.0
+Summary: A highly configurable, pluggable code formatter: every formatting decision is an option.
+Project-URL: Repository, https://gitlab.com/thebjorn/rainbow-fmt
+Project-URL: Documentation, https://gitlab.com/thebjorn/rainbow-fmt/-/tree/main/docs
+Project-URL: Changelog, https://gitlab.com/thebjorn/rainbow-fmt/-/blob/main/CHANGELOG.md
+Author: Bjørn Pettersen
+License-Expression: MIT
+License-File: LICENSE
+Keywords: code-style,formatter,pretty-printer,tree-sitter
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: ruamel-yaml>=0.18
+Requires-Dist: tomlkit>=0.13
+Requires-Dist: tree-sitter-json>=0.24
+Requires-Dist: tree-sitter<0.26,>=0.25
+Provides-Extra: dev
+Requires-Dist: mypy>=1.13; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0; extra == 'dev'
+Requires-Dist: pytest>=8.3; extra == 'dev'
+Requires-Dist: ruff>=0.8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<p align="center"><img src="https://gitlab.com/thebjorn/rainbow-fmt/-/raw/main/docs/assets/logo.svg" alt="rainbow-fmt logo" width="128"></p>
+
+# rainbow-fmt
+
+> Every shade of style. A code formatter that formats code *your* way.
+
+`rainbow-fmt` is a highly configurable, pluggable code formatter for HTML,
+CSS, SCSS, JavaScript, TypeScript, Svelte, Python, and any other language or
+DSL someone cares to describe.
+
+It is deliberately the *anti*-Prettier / anti-Black. Those tools end style
+debates by removing choice. `rainbow-fmt` ends them by letting a team write
+its decisions down once — and then enforcing them consistently, for every
+language in the repository.
+
+## Status
+
+Alpha (0.1.0). JSON and JSONC can be formatted from the command line; other
+languages are planned ([`docs/roadmap.md`](docs/roadmap.md)). See
+[`STATUS.md`](STATUS.md) and [`CHANGELOG.md`](CHANGELOG.md).
+
+## Quick start
+
+```sh
+pip install rainbow-fmt            # Python 3.12 or newer
+
+rainbow-fmt format src/            # rewrite files in place
+rainbow-fmt check .                # exit 1 if any file would change
+rainbow-fmt diff config.json       # show the changes
+rainbow-fmt options config.json    # the options for a file, and where each comes from
+```
+
+Every formatted file is verified before it is written: the syntax tree and
+the comments must be unchanged, and formatting the result again must change
+nothing ([`docs/cli.md`](docs/cli.md#verification)).
+
+Write your decisions down in `rainbow.toml` (or `pyproject.toml`
+`[tool.rainbow]`, YAML, or `package.json`), in the project root:
+
+```toml
+preset = "rainbow:balanced"        # start from a preset (optional)
+
+[core]
+max_width = 100
+indent_size = 2
+
+[language.json]
+object_wrap = "always"             # "preserve" | "fit" | "always"
+align_values = true
+
+[[override]]
+files = ["legacy/**"]
+core.indent_size = 4
+```
+
+`.editorconfig` is read too. All options and the resolution order are in
+[`docs/configuration.md`](docs/configuration.md).
+
+## Documentation
+
+| Document | Contents |
+| --- | --- |
+| [`docs/overview.md`](docs/overview.md) | Vision, principles, non-goals, comparison with existing tools |
+| [`docs/architecture.md`](docs/architecture.md) | The major pieces and how they fit together |
+| [`docs/cli.md`](docs/cli.md) | The `format`, `check`, `diff` and `options` commands |
+| [`docs/configuration.md`](docs/configuration.md) | Configuration model: options, cascading, presets, `preserve` |
+| [`docs/extending.md`](docs/extending.md) | How new languages and DSLs are added |
+| [`docs/doc-ir.md`](docs/doc-ir.md) | Reference for the Doc IR builders and the printer |
+| [`docs/benchmark.md`](docs/benchmark.md) | `python -m rainbow_fmt.benchmark` and the CI baseline |
+| [`docs/releasing.md`](docs/releasing.md) | Publishing a release to PyPI |
+| [`docs/roadmap.md`](docs/roadmap.md) | High-level, phased plan and open decisions |
+| [`docs/adr/`](docs/adr/README.md) | Architecture Decision Records |
+
+## Development
+
+Requires Python 3.12 or newer.
+
+```sh
+python -m venv .venv
+source .venv/bin/activate          # Windows: .venv\Scripts\activate
+pip install -e '.[dev]'
+
+pytest                             # tests + coverage report
+ruff check . && ruff format --check .
+mypy                               # strict; configured in pyproject.toml
+```
+
+The same checks, plus a package build and a benchmark
+(`python -m rainbow_fmt.benchmark`, [`docs/benchmark.md`](docs/benchmark.md)),
+run in GitLab CI on every push and merge request (`.gitlab-ci.yml`).
+Pushing a tag `vX.Y.Z` that matches `__version__` publishes the package to
+PyPI ([`docs/releasing.md`](docs/releasing.md)).
+
+New features are developed tests-first: the tests describing the intended
+API are written and reviewed before the implementation. Architectural
+decisions are recorded in [`docs/adr/`](docs/adr/README.md).
+
+## License
+
+MIT — see [`LICENSE`](LICENSE).
+
+## Project tracking
+
+[`TODO.md`](TODO.md) (high-level tasks),
+[`TASKS.md`](TASKS.md) (detailed next tasks), [`STATUS.md`](STATUS.md)
+(current state).

rainbow_fmt-0.1.0/README.md

@@ -0,0 +1,106 @@
+<p align="center"><img src="https://gitlab.com/thebjorn/rainbow-fmt/-/raw/main/docs/assets/logo.svg" alt="rainbow-fmt logo" width="128"></p>
+
+# rainbow-fmt
+
+> Every shade of style. A code formatter that formats code *your* way.
+
+`rainbow-fmt` is a highly configurable, pluggable code formatter for HTML,
+CSS, SCSS, JavaScript, TypeScript, Svelte, Python, and any other language or
+DSL someone cares to describe.
+
+It is deliberately the *anti*-Prettier / anti-Black. Those tools end style
+debates by removing choice. `rainbow-fmt` ends them by letting a team write
+its decisions down once — and then enforcing them consistently, for every
+language in the repository.
+
+## Status
+
+Alpha (0.1.0). JSON and JSONC can be formatted from the command line; other
+languages are planned ([`docs/roadmap.md`](docs/roadmap.md)). See
+[`STATUS.md`](STATUS.md) and [`CHANGELOG.md`](CHANGELOG.md).
+
+## Quick start
+
+```sh
+pip install rainbow-fmt            # Python 3.12 or newer
+
+rainbow-fmt format src/            # rewrite files in place
+rainbow-fmt check .                # exit 1 if any file would change
+rainbow-fmt diff config.json       # show the changes
+rainbow-fmt options config.json    # the options for a file, and where each comes from
+```
+
+Every formatted file is verified before it is written: the syntax tree and
+the comments must be unchanged, and formatting the result again must change
+nothing ([`docs/cli.md`](docs/cli.md#verification)).
+
+Write your decisions down in `rainbow.toml` (or `pyproject.toml`
+`[tool.rainbow]`, YAML, or `package.json`), in the project root:
+
+```toml
+preset = "rainbow:balanced"        # start from a preset (optional)
+
+[core]
+max_width = 100
+indent_size = 2
+
+[language.json]
+object_wrap = "always"             # "preserve" | "fit" | "always"
+align_values = true
+
+[[override]]
+files = ["legacy/**"]
+core.indent_size = 4
+```
+
+`.editorconfig` is read too. All options and the resolution order are in
+[`docs/configuration.md`](docs/configuration.md).
+
+## Documentation
+
+| Document | Contents |
+| --- | --- |
+| [`docs/overview.md`](docs/overview.md) | Vision, principles, non-goals, comparison with existing tools |
+| [`docs/architecture.md`](docs/architecture.md) | The major pieces and how they fit together |
+| [`docs/cli.md`](docs/cli.md) | The `format`, `check`, `diff` and `options` commands |
+| [`docs/configuration.md`](docs/configuration.md) | Configuration model: options, cascading, presets, `preserve` |
+| [`docs/extending.md`](docs/extending.md) | How new languages and DSLs are added |
+| [`docs/doc-ir.md`](docs/doc-ir.md) | Reference for the Doc IR builders and the printer |
+| [`docs/benchmark.md`](docs/benchmark.md) | `python -m rainbow_fmt.benchmark` and the CI baseline |
+| [`docs/releasing.md`](docs/releasing.md) | Publishing a release to PyPI |
+| [`docs/roadmap.md`](docs/roadmap.md) | High-level, phased plan and open decisions |
+| [`docs/adr/`](docs/adr/README.md) | Architecture Decision Records |
+
+## Development
+
+Requires Python 3.12 or newer.
+
+```sh
+python -m venv .venv
+source .venv/bin/activate          # Windows: .venv\Scripts\activate
+pip install -e '.[dev]'
+
+pytest                             # tests + coverage report
+ruff check . && ruff format --check .
+mypy                               # strict; configured in pyproject.toml
+```
+
+The same checks, plus a package build and a benchmark
+(`python -m rainbow_fmt.benchmark`, [`docs/benchmark.md`](docs/benchmark.md)),
+run in GitLab CI on every push and merge request (`.gitlab-ci.yml`).
+Pushing a tag `vX.Y.Z` that matches `__version__` publishes the package to
+PyPI ([`docs/releasing.md`](docs/releasing.md)).
+
+New features are developed tests-first: the tests describing the intended
+API are written and reviewed before the implementation. Architectural
+decisions are recorded in [`docs/adr/`](docs/adr/README.md).
+
+## License
+
+MIT — see [`LICENSE`](LICENSE).
+
+## Project tracking
+
+[`TODO.md`](TODO.md) (high-level tasks),
+[`TASKS.md`](TASKS.md) (detailed next tasks), [`STATUS.md`](STATUS.md)
+(current state).

rainbow_fmt-0.1.0/STATUS.md

@@ -0,0 +1,46 @@
+# STATUS
+
+_Last updated: 2026-09-27_
+
+| Metric | Value |
+| --- | --- |
+| Phase | 1 — Core pipeline: done; release 0.1.0 prepared, publishing pending |
+| Code | CLI `format`/`check`/`diff`/`options` (JSON, JSONC) with verification (equivalence, comments, stability), comment attachment, option schema and resolution (presets, `.editorconfig`, overrides, `--set`, provenance), configuration loading (TOML, YAML, pyproject, package.json) with discovery, `extends` and positions, tree-sitter adapter, Doc IR and printer, rule types and override templates, golden-fixture harness |
+| Test coverage | 100% line and branch (2,236 statements); 607 passed |
+| TODO items | 20 / 39 complete |
+| Open decisions | 1 (D6 default preset — Phase 5) |
+| High-priority issues | 0 |
+| Security issues | 0 |
+| Known issues | 0 |
+| Performance | `python -m rainbow_fmt.benchmark`: 139 KiB JSON format 0.27 s, verify 0.98 s (CI job with baseline) |
+| Dependency pins | `tree-sitter<0.26` (0.26.0 heap corruption; regression test in place) |
+| License | MIT (ADR 0004) |
+| Supported Python | 3.12, 3.13 (tested in CI) |
+| CI | GitLab pipeline: ruff, mypy, pytest (3.12, 3.13), build |
+
+## Summary
+
+Repository created with design documentation: overview, architecture,
+configuration model, extension model, and phased roadmap. Decisions
+recorded as ADRs: 0001 config formats (TOML primary, YAML and
+`package.json` supported), 0002 Python 3.12+ core, 0003 tree-sitter parser
+backend, 0004 MIT license, 0005 rule format (Python builder functions in
+packs, restricted expression templates for user `[[rule]]` overrides).
+The package is scaffolded (T2) with GitLab CI (T3). The Doc IR and printer
+(T4), the tree-sitter adapter (T7) and the rule-format spike (T5) are done:
+JSON/JSONC formats end to end against 15 golden fixtures, and a user can
+override a single rule from configuration. Configuration files (T6) load
+from TOML, YAML, `pyproject.toml` and `package.json` into one model with
+file/line/column positions, with discovery and `extends`. The CLI (T8)
+formats, checks and diffs JSON files and directories (`docs/cli.md`).
+Options (T9) are declared in a schema and resolved per file through the
+project configuration, `[[override]]` sections and `--set`, with provenance
+(`rainbow-fmt options FILE`). Presets (`rainbow:balanced`,
+`rainbow:minimal`) and `.editorconfig` complete the resolution order (T10).
+Every formatted file is verified before it is written: same tree, same
+comments, stable output (T11). Deeply nested input (more than 10,000
+levels of JSON) formats; rules run in a worker thread with a large stack
+(T12). Comment attachment is in the core (T13). A benchmark runs in CI,
+and release 0.1.0 is prepared for PyPI by trusted publishing; it is
+published when the PyPI publisher is set up and the `v0.1.0` tag is
+created (T14). Next: the CSS pack (TASKS.md T15), tests first.