agentleFS
MrPunyapalMrPunyapal/laravel-auditor/.claude/skills/package-scaffold/SKILL.md

package-scaffold

Skill78 starsChanged 3 months agoMITView on GitHub

Use this skill when adding Laravel package capabilities or wiring them through the service provider: commands, migrations, routes, config merges, views, translations, assets, middleware, publish tags, workbench files, or console-only behavior.

The file

We split this skill into the rules it gives an agent

10 rules. About 0 are common, 4 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Add package features in the right place and wire them through the service provider using explicit Laravel APIs, keeping package names, …

    line 13
  2. Distinctive:

    Create the capability files under Laravel-native package paths and use the configured package names, namespaces, publish tags, URLs, and …

    line 19
  3. Very specific:

    Use package-testing for coverage, update README or contributing documentation when user-facing behavior changes, use package-compatibility …

    line 21
  4. Distinctive:

    Add only the files needed for the requested capability and validate with the narrowest relevant command before broader checks.

    line 22
  5. Very specific:

    Keep provider wiring in register() or boot() unless extracting a method makes a real repeated concern clearer.

    line 26
  6. Very specific:

    Put container bindings and mergeConfigFrom calls in register() when the host app must be able to override configuration.

    line 27
  7. Very specific:

    Put resource loading in boot-time methods with Laravel-native APIs such as loadRoutesFrom, loadViewsFrom, and loadTranslationsFrom.

    line 28
  8. Distinctive:

    Add tests for the observable provider behavior: merged config, loaded routes, publish tags, or command registration.

    line 31
  9. Very specific:

    Add an Artisan command: create the command class under src/Console/Commands, register it in the commands array inside the …

    line 54
  10. Very specific:

    Add a publishable migration: place the migration in database/migrations, wire it through a console-guarded publishesMigrations call with a …

    line 55

≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Package Scaffold

Primary Goal

Add package features in the right place and wire them through the service provider using explicit Laravel APIs, keeping package names, namespaces, config keys, and publish tags consistent.

Workflow

  1. Inspect the existing package structure, sibling examples, README setup notes, and the current service provider before creating files.
  2. Identify whether the request touches commands, migrations, routes, config, views, translations, assets, middleware, tests, README/contributing docs, compatibility, or release flow.
  3. Create the capability files under Laravel-native package paths and use the configured package names, namespaces, publish tags, URLs, and badges consistently.
  4. Wire the capability through the service provider using the patterns in Provider wiring below.
  5. Use package-testing for coverage, update README or contributing documentation when user-facing behavior changes, use package-compatibility for matrix-sensitive changes, and use package-release for release tasks.
  6. Add only the files needed for the requested capability and validate with the narrowest relevant command before broader checks.

Provider Wiring

  1. Keep provider wiring in register() or boot() unless extracting a method makes a real repeated concern clearer.
  2. Put container bindings and mergeConfigFrom calls in register() when the host app must be able to override configuration.
  3. Put resource loading in boot-time methods with Laravel-native APIs such as loadRoutesFrom, loadViewsFrom, and loadTranslationsFrom.
  4. Guard console-only publishing and command registration with runningInConsole() before calling publishes, publishesMigrations, or commands.
  5. Name publish tags with the laravel-auditor-* convention so consumers can target individual resource groups.
  6. Add tests for the observable provider behavior: merged config, loaded routes, publish tags, or command registration.

Provider wiring anti-patterns:

  • Loading host app state too early during provider registration.
  • Calling env() outside config files; use config values after mergeConfigFrom instead.
  • Registering web-only concerns unconditionally when the package can run in console contexts.
  • Replacing explicit provider methods with spatie/laravel-package-tools by default.

References

  • src/*ServiceProvider.php
  • config/*.php
  • routes/*.php
  • resources/views/
  • lang/
  • database/migrations/
  • public/
  • src/Console/Commands/
  • tests/Feature/ and tests/Unit/

Examples

  • Add an Artisan command: create the command class under src/Console/Commands, register it in the commands array inside the runningInConsole() guard, add a feature test for observable console output, and document the command if it is user-facing.
  • Add a publishable migration: place the migration in database/migrations, wire it through a console-guarded publishesMigrations call with a laravel-auditor-migrations tag, and test publish behavior with Testbench.
  • Wire a new publish tag by adding a publishes map inside the existing console-guarded publishing method and naming the tag with laravel-auditor-*.

Anti-Patterns

  • Adding unused files because a package might need them later.
  • Mixing package names, namespaces, config keys, or publish tags.
  • Changing dependencies without approval.
  • Replacing explicit Laravel package code with a helper abstraction when one feature-specific change would do.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.