jarify 0.1.0__tar.gz

jarify-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: blacksmith-2vcpu-ubuntu-2404
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install mise
+        uses: jdx/mise-action@v2
+
+      - name: Install dependencies
+        run: uv sync --frozen --all-groups
+
+      - name: Lint
+        run: mise run lint
+
+      - name: Test
+        run: mise run test

jarify-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,59 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+  packages: write
+  id-token: write  # required for OIDC trusted publishing to PyPI
+
+jobs:
+  publish:
+    runs-on: blacksmith-2vcpu-ubuntu-2404
+
+    steps:
+      - name: Fetch secrets from Doppler
+        uses: dopplerhq/secrets-fetch-action@v2.0.0
+        id: doppler
+        with:
+          doppler-token: ${{ secrets.DOPPLER_TOKEN }}
+          doppler-project: shared
+          doppler-config: prod
+          inject-env-vars: false
+
+      - name: Generate token
+        id: app-token
+        uses: actions/create-github-app-token@v2
+        with:
+          app-id: ${{ steps.doppler.outputs.WORKFLOW_CLIENT_ID }}
+          private-key: ${{ steps.doppler.outputs.WORKFLOW_CLIENT_PRIVATE_KEY }}
+
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+
+      - name: Install mise
+        uses: jdx/mise-action@v2
+
+      - name: Install dependencies
+        run: uv sync --frozen
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish
+        env:
+          UV_PUBLISH_TRUSTED_PUBLISHING: true
+
+      - name: Create GitHub Release
+        run: |
+          gh release create "${{ github.ref_name }}" \
+            --title "${{ github.ref_name }}" \
+            --generate-notes \
+            dist/*
+        env:
+          GH_TOKEN: ${{ steps.app-token.outputs.token }}

jarify-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+*.pyc
+.venv/
+*.egg-info/
+dist/
+.pytest_cache/
+.ruff_cache/
+tmp/

jarify-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

jarify-0.1.0/AGENTS.md

@@ -0,0 +1,46 @@
+# AGENTS.md
+
+Guidance for AI agents working in this repository.
+
+## What this project is
+
+Jarify is a SQL formatter and linter for DuckDB, built on [sqlglot](https://github.com/tobymao/sqlglot). It parses SQL with the DuckDB dialect and rewrites it through an opinionated, non-configurable style.
+
+## Dev setup
+
+Requires [mise](https://mise.jdx.dev) and [uv](https://docs.astral.sh/uv/).
+
+```bash
+uv sync --all-groups
+```
+
+## Common tasks
+
+| Task | Command |
+|------|---------|
+| Run tests | `mise run test` |
+| Run linter | `mise run lint` |
+| Run both | `mise run check` |
+| Format source | `mise run fmt` |
+
+Always run `mise run check` before committing and ensure all tests pass.
+
+## Adding or changing a rule
+
+1. **Formatting rules** live in `src/jarify/generator.py` (override a generator method) or `src/jarify/rules/` (subclass `FormatterRule` and implement `apply()`).
+2. **Lint-only rules** live in `src/jarify/rules/` (implement `check()`, leave `apply()` as a no-op).
+3. Register new rules in `src/jarify/rules/__init__.py` and add a config knob to `src/jarify/config.py`.
+4. Add a fixture pair in `tests/fixtures/<category>/` and unit tests in `tests/`.
+5. **Document every new or changed rule in [`docs/sql-style-guide.md`](docs/sql-style-guide.md)** with a bad/good SQL example.
+
+## Adding fixture tests
+
+```bash
+# 1. Create the input file
+echo "SELECT a, b FROM t" > tests/fixtures/<category>/<name>.input.sql
+
+# 2. Generate the expected output
+uv run pytest tests/test_fixtures.py --update-fixtures
+
+# 3. Review the generated .expected.sql, then commit both files
+```

jarify-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 John Allen
+
+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.

jarify-0.1.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: jarify
+Version: 0.1.0
+Summary: Bespoke SQL linter and formatter for DuckDB, powered by sqlglot
+Project-URL: Homepage, https://github.com/amfaro/jarify
+Project-URL: Repository, https://github.com/amfaro/jarify
+Project-URL: Issues, https://github.com/amfaro/jarify/issues
+License-Expression: MIT
+License-File: LICENSE
+Keywords: duckdb,formatter,linter,sql,sqlglot
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.12
+Requires-Dist: click>=8.3.2
+Requires-Dist: rich>=14.3.3
+Requires-Dist: sqlglot>=30.4.2
+Description-Content-Type: text/markdown
+
+# jarify
+
+Bespoke SQL linter and formatter for [DuckDB](https://duckdb.org), built on [sqlglot](https://github.com/tobymao/sqlglot).
+
+Existing SQL formatters can't be configured to enforce a specific team style, and none of them are DuckDB-aware. Jarify parses SQL with the DuckDB dialect and rewrites it through an opinionated, non-configurable formatter — no style debates, consistent output everywhere.
+
+## Installation
+
+```bash
+uv tool install jarify
+```
+
+Or run one-off without installing:
+
+```bash
+uvx jarify fmt path/to/query.sql
+```
+
+### Upgrade
+
+```bash
+uv tool upgrade jarify
+```
+
+### Pin to a specific version
+
+```bash
+uv tool install 'jarify==0.1.0'
+```
+
+## Commands
+
+### `jarify fmt` — format SQL files
+
+```
+jarify fmt [OPTIONS] [FILES]...
+```
+
+Reads each file, formats it, and writes the result back in place.
+
+| Option | Description |
+|--------|-------------|
+| `-` | Read from stdin |
+| `--check` | Exit non-zero if any file would change (useful in CI) |
+| `--diff` | Print a unified diff instead of rewriting files |
+| `--stdin-filename NAME` | Label to use in diff output when reading from stdin |
+
+**Exit codes:** `0` = all files already formatted, `1` = files were reformatted, `2` = error.
+
+```bash
+# Format a single file
+jarify fmt query.sql
+
+# Check all .sql files without modifying them (CI mode)
+jarify fmt --check **/*.sql
+
+# Preview changes as a diff
+jarify fmt --diff query.sql
+
+# Pipe from stdin
+cat query.sql | jarify fmt -
+```
+
+### `jarify lint` — lint SQL files
+
+```
+jarify lint [OPTIONS] [FILES]...
+```
+
+Reports style and semantic violations. Does not modify files.
+
+```bash
+jarify lint query.sql
+```
+
+### `jarify init` — create a config file
+
+```bash
+jarify init
+```
+
+Writes a `jarify.toml` in the current directory. Config is internal to the tool — this is primarily useful for future per-project rule overrides.
+
+### `jarify show-config` — inspect active config
+
+```bash
+jarify show-config
+```
+
+Prints the effective configuration (syntax-highlighted TOML).
+
+## Style and lint rules
+
+Jarify enforces a single, opinionated style. There are no knobs to turn. See the **[SQL Style Guide](docs/sql-style-guide.md)** for the complete rule reference with bad/good examples for every formatting and lint rule.
+
+## Development
+
+Requires [mise](https://mise.jdx.dev) and [uv](https://docs.astral.sh/uv/).
+
+```bash
+git clone https://github.com/amfaro/jarify.git
+cd jarify
+uv sync --all-groups
+
+mise run test    # run tests
+mise run lint    # ruff check
+mise run check   # lint + test
+```
+
+### Adding a new fixture test
+
+1. Create `tests/fixtures/<category>/<name>.input.sql` with the raw SQL
+2. Run `uv run pytest tests/test_fixtures.py --update-fixtures` to generate the expected output
+3. Review `tests/fixtures/<category>/<name>.expected.sql` and commit both files
+
+### Releases
+
+Push a `v*` tag to trigger the publish workflow. GitHub Actions builds the wheel and sdist, publishes to PyPI via OIDC trusted publishing, attaches artifacts to a GitHub Release, and generates release notes automatically.
+
+```bash
+git tag v0.1.0
+git push origin v0.1.0
+```

jarify-0.1.0/README.md

@@ -0,0 +1,123 @@
+# jarify
+
+Bespoke SQL linter and formatter for [DuckDB](https://duckdb.org), built on [sqlglot](https://github.com/tobymao/sqlglot).
+
+Existing SQL formatters can't be configured to enforce a specific team style, and none of them are DuckDB-aware. Jarify parses SQL with the DuckDB dialect and rewrites it through an opinionated, non-configurable formatter — no style debates, consistent output everywhere.
+
+## Installation
+
+```bash
+uv tool install jarify
+```
+
+Or run one-off without installing:
+
+```bash
+uvx jarify fmt path/to/query.sql
+```
+
+### Upgrade
+
+```bash
+uv tool upgrade jarify
+```
+
+### Pin to a specific version
+
+```bash
+uv tool install 'jarify==0.1.0'
+```
+
+## Commands
+
+### `jarify fmt` — format SQL files
+
+```
+jarify fmt [OPTIONS] [FILES]...
+```
+
+Reads each file, formats it, and writes the result back in place.
+
+| Option | Description |
+|--------|-------------|
+| `-` | Read from stdin |
+| `--check` | Exit non-zero if any file would change (useful in CI) |
+| `--diff` | Print a unified diff instead of rewriting files |
+| `--stdin-filename NAME` | Label to use in diff output when reading from stdin |
+
+**Exit codes:** `0` = all files already formatted, `1` = files were reformatted, `2` = error.
+
+```bash
+# Format a single file
+jarify fmt query.sql
+
+# Check all .sql files without modifying them (CI mode)
+jarify fmt --check **/*.sql
+
+# Preview changes as a diff
+jarify fmt --diff query.sql
+
+# Pipe from stdin
+cat query.sql | jarify fmt -
+```
+
+### `jarify lint` — lint SQL files
+
+```
+jarify lint [OPTIONS] [FILES]...
+```
+
+Reports style and semantic violations. Does not modify files.
+
+```bash
+jarify lint query.sql
+```
+
+### `jarify init` — create a config file
+
+```bash
+jarify init
+```
+
+Writes a `jarify.toml` in the current directory. Config is internal to the tool — this is primarily useful for future per-project rule overrides.
+
+### `jarify show-config` — inspect active config
+
+```bash
+jarify show-config
+```
+
+Prints the effective configuration (syntax-highlighted TOML).
+
+## Style and lint rules
+
+Jarify enforces a single, opinionated style. There are no knobs to turn. See the **[SQL Style Guide](docs/sql-style-guide.md)** for the complete rule reference with bad/good examples for every formatting and lint rule.
+
+## Development
+
+Requires [mise](https://mise.jdx.dev) and [uv](https://docs.astral.sh/uv/).
+
+```bash
+git clone https://github.com/amfaro/jarify.git
+cd jarify
+uv sync --all-groups
+
+mise run test    # run tests
+mise run lint    # ruff check
+mise run check   # lint + test
+```
+
+### Adding a new fixture test
+
+1. Create `tests/fixtures/<category>/<name>.input.sql` with the raw SQL
+2. Run `uv run pytest tests/test_fixtures.py --update-fixtures` to generate the expected output
+3. Review `tests/fixtures/<category>/<name>.expected.sql` and commit both files
+
+### Releases
+
+Push a `v*` tag to trigger the publish workflow. GitHub Actions builds the wheel and sdist, publishes to PyPI via OIDC trusted publishing, attaches artifacts to a GitHub Release, and generates release notes automatically.
+
+```bash
+git tag v0.1.0
+git push origin v0.1.0
+```