Weave Code
Code Bundle Laravel Package
survos/code-bundle
A Symfony bundle from Survos for working with source code in your apps: display, organize, and generate code snippets with Twig helpers, syntax highlighting, and flexible configuration for developer-facing pages.
generate code for Symfony applications
Frequently asked questions about Code Bundle
- What is survos/code-bundle used for?
- survos/code-bundle is a Symfony bundle for working with source code inside your applications. It helps you display, organize, and generate code snippets using Twig helpers, syntax highlighting, and configurable developer-facing pages. It is aimed at Symfony apps rather than Laravel projects.
- How do I install survos/code-bundle with Composer?
- Run composer require survos/code-bundle in your Symfony project. If Symfony Flex does not register the bundle automatically, add it to config/bundles.php. Then follow the README for any required configuration or asset setup.
- Does survos/code-bundle work with Laravel?
- No, survos/code-bundle is a Symfony bundle, so it is not a drop-in Laravel package. Laravel developers can review it for ideas or adapt concepts, but native integration depends on Symfony's bundle system and Twig. For Laravel projects, evaluate Laravel-specific packages instead.
- How do I configure survos/code-bundle?
- The bundle provides flexible configuration for developer-facing code pages and Twig helpers. Exact options depend on the version, so check the README and the bundle's config reference. Keep environment-specific settings in Symfony config files rather than hard-coding them.
- How do I display code snippets with Twig helpers?
- Use the bundle's Twig helpers in your templates to render code snippets and organize them on developer-facing pages. The helpers are intended to work with the bundle's configuration and syntax highlighting. See the README for the exact helper names and usage examples.
- Does survos/code-bundle include syntax highlighting?
- Yes, the package is described as providing syntax highlighting alongside Twig helpers for displaying and organizing code. The exact highlighting setup and supported languages should be confirmed in the README. You may need to include the relevant front-end assets depending on your configuration.
- Which Symfony versions are supported by survos/code-bundle?
- The composer.json and README are the source of truth for supported Symfony and PHP versions. Check the package constraints before installing or upgrading, especially if you are on an older Symfony release. If constraints are missing or unclear, test in a staging app first.
- How do I test code generation in a Symfony app using survos/code-bundle?
- Boot a Symfony test kernel with the bundle enabled and render a Twig template that calls the code helpers. Assert that the generated markup contains the expected snippet and highlighting output. Review the repository's own tests for patterns you can reuse.
- Is survos/code-bundle suitable for production?
- It is developer-facing tooling for displaying, organizing, and generating code, so treat it as an admin or development dependency. Before exposing generated snippets publicly, review access control, caching, and any asset requirements. Production suitability depends on your specific configuration and security needs.
- What are alternatives to survos/code-bundle?
- Alternatives depend on whether you need snippet display, syntax highlighting, or code generation. For Symfony code generation, compare with Symfony MakerBundle; for highlighting, look at Twig syntax-highlighting extensions or front-end highlighters. Laravel teams should evaluate Laravel-specific packages instead.
Weaver
How can I help you explore Laravel packages today?