Download the PHP package hisoft/laravel-conventions without Composer

On this page you can find all versions of the php package hisoft/laravel-conventions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of hisoft/laravel-conventions

Informations about the package laravel-conventions

Laravel Conventions

Engineering conventions for Laravel projects, designed to enforce a professional architecture, faster refactors, and AI-assisted development that stays on-rails.

What This Enables

Refactor Impact (Example)

Before: mixed responsibilities in controllers, implicit rules, inconsistent naming.
After: Actions own business logic, Requests handle validation, Resources define API shape, and naming stays in English across the stack.

Installation

Usage

This package supports two types of Laravel projects:

API Projects

For backend/REST API projects:

Publishes:

Inertia Projects

For modern monolith projects with Vue/React:

Publishes:

Published Structure

AI Tools Integration

Cursor IDE

Install Cursor rules so the editor loads Hisoft conventions when editing matching files.

API project (conventions only):

Inertia project (conventions only):

Conventions + RPI workflow (recommended for complex work in Cursor):

RPI only (e.g. you already manage conventions elsewhere):

This creates:

How to use RPI in Cursor

  1. After install, rpi.mdc is always applied so the model knows the workflow exists.
  2. In Chat, run a slash command like /brainstorm, /research, /plan, /iterate, /implement, or /investigate (same idea as Claude Code). You can also attach a skill as context with @brainstorm, etc.
  3. Describe your goal or paste paths to artifacts under docs/rpi/.
  4. Artifacts are written under docs/rpi/{brainstorm,research,plan,investigate}/.

Full detail: resources/cursor/README.md.

Globs

hisoft:cursor options

Option Purpose
--api Install API hisoft.mdc
--inertia Install Inertia hisoft.mdc
--rpi Install RPI overview rule + .cursor/skills/ (native skills)
--force Overwrite without confirmation

With no options, the command interactively asks for project type and whether to install RPI. In non-interactive mode you must pass at least one of --api, --inertia, or --rpi.

The same RPI methodology is also authored for Claude Code under resources/claude/ (agents + skills); Cursor uses native skills plus rpi.mdc under resources/cursor/ (see resources/cursor/README.md).

GitHub Copilot

Install Copilot instructions to guide AI-assisted development:

For API projects:

For Inertia projects:

This creates .github/copilot-instructions.md which GitHub Copilot automatically reads to understand project conventions.

Copilot options

If no option is provided, the command prompts for project type.

Global Agent Rules

The publish tags also install AGENTS.md in the project root, providing global rules that work across all AI tools.

Other Tools

The conventions in .ai/ are compatible with any AI-assisted development tool. Reference the files in your tool's context as needed.

Updating to a Newer Package Version

When a new release of hisoft/laravel-conventions is published:

  1. Update Composer

  2. Republish convention files from the package

    --force overwrites every path in that tag, including .ai/upstream/* and .ai/local/overrides.md. Back up .ai/local/overrides.md first if you customized it, then restore or merge after publishing.
    Without --force, Laravel skips existing files (safe for local edits, but upstream will not refresh).

  3. Refresh Cursor rules and RPI assets (if you use Cursor)

  4. Refresh Copilot instructions (if you use Copilot)

Re-run only the steps that apply to your team’s tooling.

Priority Order

When conventions conflict:

  1. .ai/local/* (project-specific rules)
  2. .ai/upstream/* (package conventions)

Conventions Overview

Shared (both API and Inertia)

File Description
conventions.md Architectural principles and layer responsibilities
exceptions.md Domain exception handling patterns
testing.md Testing strategy with Pest
phpdocs.md PHPDoc conventions for code documentation
static-analysis.md PHPStan/Larastan level 5 conventions

API-specific

File Description
crud.md CRUD implementation guidelines
resources.md Laravel Resources and API response patterns

Inertia-specific

File Description
pages.md Page component structure and naming
forms.md Form handling with useForm
props.md Data sharing and HandleInertiaRequests
components.md Reusable component conventions

Development

Run tests:

Run static analysis:

License

MIT

All versions of laravel-conventions with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package hisoft/laravel-conventions contains the following files

Loading the files please wait ...