Skip to content

Commit

Permalink
Init: Setup and adding toLog trait (#1)
Browse files Browse the repository at this point in the history
* Init

* wip

* Adding toLog

* Tidy up tests

* Fix styling
  • Loading branch information
spekulatius committed Mar 27, 2023
1 parent c704dc8 commit 7e3a5a1
Show file tree
Hide file tree
Showing 27 changed files with 250 additions and 435 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -1,11 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/:vendor_name/:package_name/discussions/new?category=q-a
url: https://github.com/spekulatius/laravel-powertools/discussions/new?category=q-a
about: Ask the community for help
- name: Request a feature
url: https://github.com/:vendor_name/:package_name/discussions/new?category=ideas
url: https://github.com/spekulatius/laravel-powertools/discussions/new?category=ideas
about: Share ideas for new features
- name: Report a security issue
url: https://github.com/:vendor_name/:package_name/security/policy
url: https://github.com/spekulatius/laravel-powertools/security/policy
about: Learn how to notify us for sensitive bugs
12 changes: 0 additions & 12 deletions .github/dependabot.yml

This file was deleted.

32 changes: 0 additions & 32 deletions .github/workflows/dependabot-auto-merge.yml

This file was deleted.

2 changes: 1 addition & 1 deletion CHANGELOG.md
@@ -1,3 +1,3 @@
# Changelog

All notable changes to `:package_name` will be documented in this file.
All notable changes to `laravel-powertools` will be documented in this file.
2 changes: 1 addition & 1 deletion LICENSE.md
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) :vendor_name <author@domain.com>
Copyright (c) Peter Thaleikis <spekulatius>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
45 changes: 18 additions & 27 deletions README.md
@@ -1,48 +1,38 @@
# :package_description
# A personal collection of Laravel Helpers, my powertools.

[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
<!--delete-->
---
This repo can be used to scaffold a Laravel package. Follow these steps to get started:
[![Latest Version on Packagist](https://img.shields.io/packagist/v/spekulatius/laravel-powertools.svg?style=flat-square)](https://packagist.org/packages/spekulatius/laravel-powertools)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/spekulatius/laravel-powertools/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/spekulatius/laravel-powertools/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/spekulatius/laravel-powertools/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/spekulatius/laravel-powertools/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/spekulatius/laravel-powertools.svg?style=flat-square)](https://packagist.org/packages/spekulatius/laravel-powertools)

1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
3. Have fun creating your package.
4. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
---
<!--/delete-->
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
This is a personal collection of stuff I used across Laravel projects. Handy helpers, tools, utils, etc.

## Support us
## Features

[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/:package_name.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/:package_name)
### ToLog

We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
A simple trait for models to summarize the model-data as logging context. Imagine it like a slimmed down `->toArray()`. It's intended to be used similar to `\Log::error('....', $entry->toLog());`

## Installation

You can install the package via composer:

```bash
composer require :vendor_slug/:package_slug
composer require spekulatius/laravel-powertools
```

<!--
You can publish and run the migrations with:
```bash
php artisan vendor:publish --tag=":package_slug-migrations"
php artisan vendor:publish --tag="laravel-powertools-migrations"
php artisan migrate
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag=":package_slug-config"
php artisan vendor:publish --tag="laravel-powertools-config"
```
This is the contents of the published config file:
Expand All @@ -55,15 +45,16 @@ return [
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag=":package_slug-views"
php artisan vendor:publish --tag="laravel-powertools-views"
```
## Usage
```php
$variable = new VendorName\Skeleton();
echo $variable->echoPhrase('Hello, VendorName!');
$laravelPowertools = new Spekulatius\LaravelPowertools();
echo $laravelPowertools->echoPhrase('Hello, Spekulatius!');
```
-->

## Testing

Expand All @@ -85,7 +76,7 @@ Please review [our security policy](../../security/policy) on how to report secu

## Credits

- [:author_name](https://github.com/:author_username)
- [Peter Thaleikis](https://github.com/spekulatius)
- [All Contributors](../../contributors)

## License
Expand Down
27 changes: 13 additions & 14 deletions composer.json
@@ -1,17 +1,17 @@
{
"name": ":vendor_slug/:package_slug",
"description": ":package_description",
"name": "spekulatius/laravel-powertools",
"description": "A personal collection of Laravel Helpers, my powertools.",
"keywords": [
":vendor_name",
"spekulatius",
"laravel",
":package_slug"
"laravel-powertools",
"laravel-utilities"
],
"homepage": "https://github.com/:vendor_slug/:package_slug",
"homepage": "https://github.com/spekulatius/laravel-powertools",
"license": "MIT",
"authors": [
{
"name": ":author_name",
"email": "author@domain.com",
"name": "Peter Thaleikis",
"role": "Developer"
}
],
Expand All @@ -30,18 +30,17 @@
"pestphp/pest-plugin-laravel": "^2.0",
"phpstan/extension-installer": "^1.1",
"phpstan/phpstan-deprecation-rules": "^1.0",
"phpstan/phpstan-phpunit": "^1.0",
"spatie/laravel-ray": "^1.26"
"phpstan/phpstan-phpunit": "^1.0"
},
"autoload": {
"psr-4": {
"VendorName\\Skeleton\\": "src/",
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
"Spekulatius\\LaravelPowertools\\": "src/",
"Spekulatius\\LaravelPowertools\\Database\\Factories\\": "database/factories/"
}
},
"autoload-dev": {
"psr-4": {
"VendorName\\Skeleton\\Tests\\": "tests/"
"Spekulatius\\LaravelPowertools\\Tests\\": "tests/"
}
},
"scripts": {
Expand All @@ -61,10 +60,10 @@
"extra": {
"laravel": {
"providers": [
"VendorName\\Skeleton\\SkeletonServiceProvider"
"Spekulatius\\LaravelPowertools\\LaravelPowertoolsServiceProvider"
],
"aliases": {
"Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
"LaravelPowertools": "Spekulatius\\LaravelPowertools\\Facades\\LaravelPowertools"
}
}
},
Expand Down
6 changes: 6 additions & 0 deletions config/powertools.php
@@ -0,0 +1,6 @@
<?php

// config for Spekulatius/LaravelPowertools
return [

];
6 changes: 0 additions & 6 deletions config/skeleton.php

This file was deleted.

0 comments on commit 7e3a5a1

Please sign in to comment.