Skip to content

feat(symfony-security-auditor): add JSON schema - #2007

Merged
symfony-recipes-bot merged 1 commit into
symfony:mainfrom
vinceAmstoutz:feat/auditor-schema-modeline
Jul 7, 2026
Merged

feat(symfony-security-auditor): add JSON schema#2007
symfony-recipes-bot merged 1 commit into
symfony:mainfrom
vinceAmstoutz:feat/auditor-schema-modeline

Conversation

@vinceAmstoutz

@vinceAmstoutz vinceAmstoutz commented Jul 3, 2026

Copy link
Copy Markdown
Contributor
Q A
License MIT
Packagist https://packagist.org/packages/vinceamstoutz/symfony-security-auditor

Adds a JSON Schema modeline to the symfony_security_auditor recipe config so
editors provide completion, validation and inline docs for the bundle config.

# $schema: https://raw.githubusercontent.com/vinceamstoutz/symfony-security-auditor/main/resources/schema.json
  • Works in PhpStorm/IntelliJ (native # $schema: support) and the Red Hat
    yaml-language-server
    (VS Code, Neovim), which also understands the # $schema: form.
  • The URL floats on the package's main branch on purpose: Symfony Flex has no
    package-version placeholder for recipe file contents, so a pinned tag would need
    editing on every release. A floating ref keeps the recipe maintenance-free and always
    resolves to the current schema.
  • One-line, comment-only change — no behavioural impact on the generated config.

Schema lives at resources/schema.json in the bundle repo.

@symfony-recipes-bot
symfony-recipes-bot enabled auto-merge (squash) July 3, 2026 15:16
@symfony-recipes-bot

Copy link
Copy Markdown
Collaborator

Thanks for the PR 😍

How to test these changes in your application

  1. Define the SYMFONY_ENDPOINT environment variable:

    # On Unix-like (BSD, Linux and macOS)
    export SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes-contrib/flex/pull-2007/index.json
    # On Windows
    SET SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes-contrib/flex/pull-2007/index.json
  2. Install the package(s) related to this recipe:

    composer req symfony/flex
    composer req 'vinceamstoutz/symfony-security-auditor:^1.0'
  3. Don't forget to unset the SYMFONY_ENDPOINT environment variable when done:

    # On Unix-like (BSD, Linux and macOS)
    unset SYMFONY_ENDPOINT
    # On Windows
    SET SYMFONY_ENDPOINT=

Diff between recipe versions

In order to help with the review stage, I'm in charge of computing the diff between the various versions of patched recipes.
I'm going keep this comment up to date with any updates of the attached patch.

auto-merge was automatically disabled July 3, 2026 15:22

Head branch was pushed to by a user without write access

@vinceAmstoutz
vinceAmstoutz force-pushed the feat/auditor-schema-modeline branch from 48ef943 to 231a03f Compare July 3, 2026 15:22
@symfony-recipes-bot
symfony-recipes-bot enabled auto-merge (squash) July 3, 2026 15:22
@vinceAmstoutz

Copy link
Copy Markdown
Contributor Author

@diimpp FYI the remaining red ci checks are as expected: the bundle supports PHP ≥ 8.3 and Symfony ≥
7.4 only, so Symfony 6 / PHP 8.1–8.2 skeleton installs can't resolve.

@vinceAmstoutz vinceAmstoutz changed the title feat(symfony-security-auditor): add JSON schema modeline for editor completion feat(symfony-security-auditor): add JSON schema Jul 3, 2026
@symfony-recipes-bot
symfony-recipes-bot merged commit c3209d6 into symfony:main Jul 7, 2026
1 of 2 checks passed
@vinceAmstoutz
vinceAmstoutz deleted the feat/auditor-schema-modeline branch July 7, 2026 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants