Skip to content
This repository has been archived by the owner on Apr 21, 2022. It is now read-only.

Commit

Permalink
Modify the skeleton to what I need it to be
Browse files Browse the repository at this point in the history
  • Loading branch information
RVxLab committed Jun 12, 2021
1 parent 8820262 commit ce747b9
Show file tree
Hide file tree
Showing 33 changed files with 245 additions and 423 deletions.
1 change: 0 additions & 1 deletion .github/FUNDING.yml

This file was deleted.

6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/vendor_slug/package_slug/discussions/new?category=q-a
url: https://github.com/rvxlab/filament-colorpicker/discussions/new?category=q-a
about: Ask the community for help
- name: Request a feature
url: https://github.com/vendor_slug/package_slug/discussions/new?category=ideas
url: https://github.com/rvxlab/filament-colorpicker/discussions/new?category=ideas
about: Share ideas for new features
- name: Report a bug
url: https://github.com/vendor_slug/package_slug/issues/new
url: https://github.com/rvxlab/filament-colorpicker/issues/new
about: Report a reproducable bug
3 changes: 0 additions & 3 deletions .github/SECURITY.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/php-cs-fixer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
- name: Run PHP CS Fixer
uses: docker://oskarstark/php-cs-fixer-ga
with:
args: --config=.php_cs.dist.php --allow-risky=yes
args: --config=.php-cs-fixer.php --allow-risky=yes

- name: Commit changes
uses: stefanzweifel/git-auto-commit-action@v4
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/psalm.yml → .github/workflows/phpstan.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Psalm
name: PHPStan

on:
push:
paths:
- '**.php'
- 'psalm.xml.dist'
- 'phpstan.neon'

jobs:
psalm:
Expand All @@ -29,5 +29,5 @@ jobs:
- name: Run composer install
run: composer install -n --prefer-dist

- name: Run psalm
run: ./vendor/bin/psalm --output-format=github
- name: Run PHPStan
run: php -d memory_limit=-1 vendor/bin/phpstan analyze
2 changes: 1 addition & 1 deletion .github/workflows/run-tests.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: run-tests
name: Run tests

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ composer.lock
coverage
docs
phpunit.xml
psalm.xml
testbench.yaml
vendor
node_modules
.php-cs-fixer.cache
docker-compose.override.yml
25 changes: 25 additions & 0 deletions .php-cs-fixer.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?php

$dirs = [
'src',
'tests',
];

return (new PhpCsFixer\Config())
->setRiskyAllowed(true)
->setRules([
'@PSR2' => true,
'@Symfony:risky' => true,
'@PHP71Migration:risky' => true,
'@PHP73Migration' => true,
'blank_line_after_opening_tag' => true,
'method_argument_space' => false,
])
->setFinder((new PhpCsFixer\Finder())
->in(
array_map(
static fn (string $dir) => __DIR__ . '/' . $dir,
$dirs,
)
),
);
40 changes: 0 additions & 40 deletions .php_cs.dist.php

This file was deleted.

2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

All notable changes to `:package_name` will be documented in this file.
All notable changes to `filament-colorpicker` will be documented in this file.

## 1.0.0 - 202X-XX-XX

Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) :vendor_name <[email protected]>
Copyright (c) rvxlab <[email protected]>

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
60 changes: 60 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
.PHONY: testbench

EXEC="docker-compose exec -u app workspace"

uid=1000
gid=1000

## Docker
up:
docker-compose up -d

start: up

down:
docker-compose down

stop: down

dcbuild:
docker-compose build

composer:
"$(EXEC)" composer $(cmd)

## Artisan
testbench:
"$(EXEC)" php vendor/bin/testbench $(cmd)

## Testing
phpcsfixer:
"$(EXEC)" vendor/bin/php-cs-fixer fix

phpstan:
"$(EXEC)" php -d memory_limit=-1 vendor/bin/phpstan analyze

test:
"$(EXEC)" vendor/bin/testbench package:test --parallel --no-coverage

test-coverage:
"$(EXEC)" vendor/bin/phpunit --coverage-html coverage

test-all: phpstan phpcsfixer test

## Npm

npm:
"$(EXEC)" npm $(cmd)

npm-dev:
"$(EXEC)" npm run dev

npm-watch:
"$(EXEC)" npm run watch

npm-prod:
"$(EXEC)" npm run prod

## Misc
sh:
"$(EXEC)" sh
76 changes: 20 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,49 @@
# :package_description
# A colorpicker package for Laravel Filament

[![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/workflow/status/vendor_slug/package_slug/run-tests?label=tests)](https://github.com/vendor_slug/package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/vendor_slug/package_slug/Check%20&%20fix%20styling?label=code%20style)](https://github.com/vendor_slug/package_slug/actions?query=workflow%3A"Check+%26+fix+styling"+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)
[![Latest Version on Packagist](https://img.shields.io/packagist/v/rvxlab/filament-colorpicker.svg?style=flat-square)](https://packagist.org/packages/rvxlab/filament-colorpicker)
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/rvxlab/filament-colorpicker/run-tests?label=tests)](https://github.com/rvxlab/filament-colorpicker/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/rvxlab/filament-colorpicker/Check%20&%20fix%20styling?label=code%20style)](https://github.com/rvxlab/filament-colorpicker/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/rvxlab/filament-colorpicker.svg?style=flat-square)](https://packagist.org/packages/rvxlab/filament-colorpicker)

---
This repo can be used as to scaffold a Laravel package. Follow these steps to get started:

1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton
2. Run "./configure-skeleton.sh" to run a script that will replace all placeholders throughout all the files
3. Remove this block of text.
4. Have fun creating your package.
5. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
---

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

## Support us

[<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)

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).
**TODO: Add a description**

## Installation

You can install the package via composer:

```bash
composer require vendor_slug/package_slug
composer require rvxlab/filament-colorpicker
```

You can publish and run the migrations with:
## Usage

```bash
php artisan vendor:publish --provider="VendorName\Skeleton\SkeletonServiceProvider" --tag="package_slug-migrations"
php artisan migrate
```
**TODO**

You can publish the config file with:
```bash
php artisan vendor:publish --provider="VendorName\Skeleton\SkeletonServiceProvider" --tag="package_slug-config"
```
## Changelog

This is the contents of the published config file:
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

```php
return [
];
```
## Contributing

## Usage
For development this repository contains a Docker Compose file to provide all the tools needed, as well as a Makefile to run useful commands.

```php
$skeleton = new VendorName\Skeleton();
echo $skeleton->echoPhrase('Hello, Spatie!');
```
To make use of this, ensure you have Docker and Docker Compose installed.

## Testing
To get started:

```bash
composer test
make dcbuild # Build the Docker image
make start # Run the container
make composer cmd=install
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing
Additionally you can copy and modify `docker-compose.override.yml.dist` to add any additional changes needed for the workspace container.

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

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

## License
Expand Down
35 changes: 16 additions & 19 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"name": "vendor_slug/package_slug",
"description": ":package_description",
"name": "rvxlab/filament-colorpicker",
"description": "A colorpicker package for Laravel Filament",
"keywords": [
":vendor_name",
"rvxlab",
"laravel",
"package_slug"
"filament-colorpicker"
],
"homepage": "https://github.com/vendor_slug/package_slug",
"homepage": "https://github.com/rvxlab/filament-colorpicker",
"license": "MIT",
"authors": [
{
"name": ":author_name",
"email": "[email protected]",
"name": "RVxLab",
"email": "[email protected]",
"role": "Developer"
}
],
Expand All @@ -22,38 +22,35 @@
},
"require-dev": {
"brianium/paratest": "^6.2",
"friendsofphp/php-cs-fixer": "^3.0",
"nunomaduro/collision": "^5.3",
"nunomaduro/larastan": "^0.7.6",
"orchestra/testbench": "^6.15",
"phpstan/extension-installer": "^1.1",
"phpstan/phpstan-phpunit": "^0.12.19",
"phpunit/phpunit": "^9.3",
"spatie/laravel-ray": "^1.9",
"vimeo/psalm": "^4.4"
"spatie/laravel-ray": "^1.9"
},
"autoload": {
"psr-4": {
"VendorName\\Skeleton\\": "src",
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories"
"RVxLab\\FilamentColorpicker\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"VendorName\\Skeleton\\Tests\\": "tests"
"RVxLab\\FilamentColorpicker\\Tests\\": "tests"
}
},
"scripts": {
"psalm": "vendor/bin/psalm",
"test": "./vendor/bin/testbench package:test --parallel --no-coverage",
"test-coverage": "vendor/bin/phpunit --coverage-html coverage"
},
"config": {
"sort-packages": true
},
"extra": {
"laravel": {
"providers": [
"VendorName\\Skeleton\\SkeletonServiceProvider"
"RVxLab\\FilamentColorpicker\\FilamentColorpickerServiceProvider"
],
"aliases": {
"Skeleton": "VendorName\\Skeleton\\SkeletonFacade"
"FilamentColorpicker": "RVxLab\\FilamentColorpicker\\FilamentColorpickerFacade"
}
}
},
Expand Down
5 changes: 0 additions & 5 deletions config/skeleton.php

This file was deleted.

Loading

0 comments on commit ce747b9

Please sign in to comment.