run configuration developing package
This commit is contained in:
parent
8b9f0cd47a
commit
429c956e37
|
|
@ -1 +1 @@
|
||||||
github: :vendor_name
|
github: msr
|
||||||
|
|
|
||||||
|
|
@ -1,11 +1,11 @@
|
||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: Ask a question
|
- name: Ask a question
|
||||||
url: https://github.com/:vendor_slug/:package_name/discussions/new?category=q-a
|
url: https://github.com/mahdimsr/laravel-bitunix-api/discussions/new?category=q-a
|
||||||
about: Ask the community for help
|
about: Ask the community for help
|
||||||
- name: Request a feature
|
- name: Request a feature
|
||||||
url: https://github.com/:vendor_slug/:package_name/discussions/new?category=ideas
|
url: https://github.com/mahdimsr/laravel-bitunix-api/discussions/new?category=ideas
|
||||||
about: Share ideas for new features
|
about: Share ideas for new features
|
||||||
- name: Report a security issue
|
- name: Report a security issue
|
||||||
url: https://github.com/:vendor_slug/:package_name/security/policy
|
url: https://github.com/mahdimsr/laravel-bitunix-api/security/policy
|
||||||
about: Learn how to notify us for sensitive bugs
|
about: Learn how to notify us for sensitive bugs
|
||||||
|
|
|
||||||
|
|
@ -1,32 +0,0 @@
|
||||||
name: "Update Changelog"
|
|
||||||
|
|
||||||
on:
|
|
||||||
release:
|
|
||||||
types: [released]
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
update:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 5
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v5
|
|
||||||
with:
|
|
||||||
ref: main
|
|
||||||
|
|
||||||
- name: Update Changelog
|
|
||||||
uses: stefanzweifel/changelog-updater-action@v1
|
|
||||||
with:
|
|
||||||
latest-version: ${{ github.event.release.name }}
|
|
||||||
release-notes: ${{ github.event.release.body }}
|
|
||||||
|
|
||||||
- name: Commit updated CHANGELOG
|
|
||||||
uses: stefanzweifel/git-auto-commit-action@v6
|
|
||||||
with:
|
|
||||||
branch: main
|
|
||||||
commit_message: Update CHANGELOG
|
|
||||||
file_pattern: CHANGELOG.md
|
|
||||||
|
|
@ -1,3 +1,3 @@
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
All notable changes to `:package_name` will be documented in this file.
|
All notable changes to `laravel-bitunix-api` will be documented in this file.
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) :vendor_name <author@domain.com>
|
Copyright (c) msr <mahdi.msr4@gmail.com>
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|
|
||||||
35
README.md
35
README.md
|
|
@ -1,24 +1,15 @@
|
||||||
# :package_description
|
# composer package for using bitunix api trading
|
||||||
|
|
||||||
[](https://packagist.org/packages/:vendor_slug/:package_slug)
|
[](https://packagist.org/packages/mahdimsr/laravel-bitunix-api)
|
||||||
[](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
|
[](https://github.com/mahdimsr/laravel-bitunix-api/actions?query=workflow%3Arun-tests+branch%3Amain)
|
||||||
[](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
|
[](https://github.com/mahdimsr/laravel-bitunix-api/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
|
||||||
[](https://packagist.org/packages/:vendor_slug/:package_slug)
|
[](https://packagist.org/packages/mahdimsr/laravel-bitunix-api)
|
||||||
<!--delete-->
|
|
||||||
---
|
|
||||||
This repo can be used to scaffold a Laravel package. Follow these steps to get started:
|
|
||||||
|
|
||||||
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 where your description should go. Limit it to a paragraph or two. Consider adding a small example.
|
||||||
|
|
||||||
## Support us
|
## 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)
|
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-bitunix-api.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-bitunix-api)
|
||||||
|
|
||||||
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 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).
|
||||||
|
|
||||||
|
|
@ -29,20 +20,20 @@ We highly appreciate you sending us a postcard from your hometown, mentioning wh
|
||||||
You can install the package via composer:
|
You can install the package via composer:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
composer require :vendor_slug/:package_slug
|
composer require mahdimsr/laravel-bitunix-api
|
||||||
```
|
```
|
||||||
|
|
||||||
You can publish and run the migrations with:
|
You can publish and run the migrations with:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
php artisan vendor:publish --tag=":package_slug-migrations"
|
php artisan vendor:publish --tag="laravel-bitunix-api-migrations"
|
||||||
php artisan migrate
|
php artisan migrate
|
||||||
```
|
```
|
||||||
|
|
||||||
You can publish the config file with:
|
You can publish the config file with:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
php artisan vendor:publish --tag=":package_slug-config"
|
php artisan vendor:publish --tag="laravel-bitunix-api-config"
|
||||||
```
|
```
|
||||||
|
|
||||||
This is the contents of the published config file:
|
This is the contents of the published config file:
|
||||||
|
|
@ -55,14 +46,14 @@ return [
|
||||||
Optionally, you can publish the views using
|
Optionally, you can publish the views using
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
php artisan vendor:publish --tag=":package_slug-views"
|
php artisan vendor:publish --tag="laravel-bitunix-api-views"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```php
|
```php
|
||||||
$variable = new VendorName\Skeleton();
|
$laravelBitunixApi = new Msr\LaravelBitunixApi();
|
||||||
echo $variable->echoPhrase('Hello, VendorName!');
|
echo $laravelBitunixApi->echoPhrase('Hello, Msr!');
|
||||||
```
|
```
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
@ -85,7 +76,7 @@ Please review [our security policy](../../security/policy) on how to report secu
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
- [:author_name](https://github.com/:author_username)
|
- [mahdi mansouri](https://github.com/mahdimsr)
|
||||||
- [All Contributors](../../contributors)
|
- [All Contributors](../../contributors)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
|
||||||
|
|
@ -1,17 +1,17 @@
|
||||||
{
|
{
|
||||||
"name": ":vendor_slug/:package_slug",
|
"name": "mahdimsr/laravel-bitunix-api",
|
||||||
"description": ":package_description",
|
"description": "composer package for using bitunix api trading",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
":vendor_name",
|
"msr",
|
||||||
"laravel",
|
"laravel",
|
||||||
":package_slug"
|
"laravel-bitunix-api"
|
||||||
],
|
],
|
||||||
"homepage": "https://github.com/:vendor_slug/:package_slug",
|
"homepage": "https://github.com/mahdimsr/laravel-bitunix-api",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"authors": [
|
"authors": [
|
||||||
{
|
{
|
||||||
"name": ":author_name",
|
"name": "mahdi mansouri",
|
||||||
"email": "author@domain.com",
|
"email": "mahdi.msr4@gmail.com",
|
||||||
"role": "Developer"
|
"role": "Developer"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
|
@ -30,18 +30,17 @@
|
||||||
"pestphp/pest-plugin-laravel": "^4.0",
|
"pestphp/pest-plugin-laravel": "^4.0",
|
||||||
"phpstan/extension-installer": "^1.4",
|
"phpstan/extension-installer": "^1.4",
|
||||||
"phpstan/phpstan-deprecation-rules": "^2.0",
|
"phpstan/phpstan-deprecation-rules": "^2.0",
|
||||||
"phpstan/phpstan-phpunit": "^2.0",
|
"phpstan/phpstan-phpunit": "^2.0"
|
||||||
"spatie/laravel-ray": "^1.35"
|
|
||||||
},
|
},
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-4": {
|
"psr-4": {
|
||||||
"VendorName\\Skeleton\\": "src/",
|
"Msr\\LaravelBitunixApi\\": "src/",
|
||||||
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
|
"Msr\\LaravelBitunixApi\\Database\\Factories\\": "database/factories/"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"autoload-dev": {
|
"autoload-dev": {
|
||||||
"psr-4": {
|
"psr-4": {
|
||||||
"VendorName\\Skeleton\\Tests\\": "tests/",
|
"Msr\\LaravelBitunixApi\\Tests\\": "tests/",
|
||||||
"Workbench\\App\\": "workbench/app/"
|
"Workbench\\App\\": "workbench/app/"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
@ -63,13 +62,13 @@
|
||||||
"extra": {
|
"extra": {
|
||||||
"laravel": {
|
"laravel": {
|
||||||
"providers": [
|
"providers": [
|
||||||
"VendorName\\Skeleton\\SkeletonServiceProvider"
|
"Msr\\LaravelBitunixApi\\LaravelBitunixApiServiceProvider"
|
||||||
],
|
],
|
||||||
"aliases": {
|
"aliases": {
|
||||||
"Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
|
"LaravelBitunixApi": "Msr\\LaravelBitunixApi\\Facades\\LaravelBitunixApi"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"minimum-stability": "dev",
|
"minimum-stability": "dev",
|
||||||
"prefer-stable": true
|
"prefer-stable": true
|
||||||
}
|
}
|
||||||
|
|
@ -0,0 +1,6 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
// config for Msr/LaravelBitunixApi
|
||||||
|
return [
|
||||||
|
|
||||||
|
];
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
<?php
|
|
||||||
|
|
||||||
// config for VendorName/Skeleton
|
|
||||||
return [
|
|
||||||
|
|
||||||
];
|
|
||||||
370
configure.php
370
configure.php
|
|
@ -1,370 +0,0 @@
|
||||||
#!/usr/bin/env php
|
|
||||||
<?php
|
|
||||||
|
|
||||||
function ask(string $question, string $default = ''): string
|
|
||||||
{
|
|
||||||
$answer = readline($question.($default ? " ({$default})" : null).': ');
|
|
||||||
|
|
||||||
if (! $answer) {
|
|
||||||
return $default;
|
|
||||||
}
|
|
||||||
|
|
||||||
return $answer;
|
|
||||||
}
|
|
||||||
|
|
||||||
function confirm(string $question, bool $default = false): bool
|
|
||||||
{
|
|
||||||
$answer = ask($question.' ('.($default ? 'Y/n' : 'y/N').')');
|
|
||||||
|
|
||||||
if (! $answer) {
|
|
||||||
return $default;
|
|
||||||
}
|
|
||||||
|
|
||||||
return strtolower($answer) === 'y';
|
|
||||||
}
|
|
||||||
|
|
||||||
function writeln(string $line): void
|
|
||||||
{
|
|
||||||
echo $line.PHP_EOL;
|
|
||||||
}
|
|
||||||
|
|
||||||
function run(string $command): string
|
|
||||||
{
|
|
||||||
return trim((string) shell_exec($command));
|
|
||||||
}
|
|
||||||
|
|
||||||
function str_after(string $subject, string $search): string
|
|
||||||
{
|
|
||||||
$pos = strrpos($subject, $search);
|
|
||||||
|
|
||||||
if ($pos === false) {
|
|
||||||
return $subject;
|
|
||||||
}
|
|
||||||
|
|
||||||
return substr($subject, $pos + strlen($search));
|
|
||||||
}
|
|
||||||
|
|
||||||
function slugify(string $subject): string
|
|
||||||
{
|
|
||||||
return strtolower(trim(preg_replace('/[^A-Za-z0-9-]+/', '-', $subject), '-'));
|
|
||||||
}
|
|
||||||
|
|
||||||
function title_case(string $subject): string
|
|
||||||
{
|
|
||||||
return str_replace(' ', '', ucwords(str_replace(['-', '_'], ' ', $subject)));
|
|
||||||
}
|
|
||||||
|
|
||||||
function title_snake(string $subject, string $replace = '_'): string
|
|
||||||
{
|
|
||||||
return str_replace(['-', '_'], $replace, $subject);
|
|
||||||
}
|
|
||||||
|
|
||||||
function replace_in_file(string $file, array $replacements): void
|
|
||||||
{
|
|
||||||
$contents = file_get_contents($file);
|
|
||||||
|
|
||||||
file_put_contents(
|
|
||||||
$file,
|
|
||||||
str_replace(
|
|
||||||
array_keys($replacements),
|
|
||||||
array_values($replacements),
|
|
||||||
$contents
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_prefix(string $prefix, string $content): string
|
|
||||||
{
|
|
||||||
if (str_starts_with($content, $prefix)) {
|
|
||||||
return substr($content, strlen($prefix));
|
|
||||||
}
|
|
||||||
|
|
||||||
return $content;
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_composer_deps(array $names)
|
|
||||||
{
|
|
||||||
$data = json_decode(file_get_contents(__DIR__.'/composer.json'), true);
|
|
||||||
|
|
||||||
foreach ($data['require-dev'] as $name => $version) {
|
|
||||||
if (in_array($name, $names, true)) {
|
|
||||||
unset($data['require-dev'][$name]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
file_put_contents(__DIR__.'/composer.json', json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_composer_script($scriptName)
|
|
||||||
{
|
|
||||||
$data = json_decode(file_get_contents(__DIR__.'/composer.json'), true);
|
|
||||||
|
|
||||||
foreach ($data['scripts'] as $name => $script) {
|
|
||||||
if ($scriptName === $name) {
|
|
||||||
unset($data['scripts'][$name]);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
file_put_contents(__DIR__.'/composer.json', json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove_readme_paragraphs(string $file): void
|
|
||||||
{
|
|
||||||
$contents = file_get_contents($file);
|
|
||||||
|
|
||||||
file_put_contents(
|
|
||||||
$file,
|
|
||||||
preg_replace('/<!--delete-->.*<!--\/delete-->/s', '', $contents) ?: $contents
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
function safeUnlink(string $filename)
|
|
||||||
{
|
|
||||||
if (file_exists($filename) && is_file($filename)) {
|
|
||||||
unlink($filename);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function determineSeparator(string $path): string
|
|
||||||
{
|
|
||||||
return str_replace('/', DIRECTORY_SEPARATOR, $path);
|
|
||||||
}
|
|
||||||
|
|
||||||
function replaceForWindows(): array
|
|
||||||
{
|
|
||||||
return preg_split('/\\r\\n|\\r|\\n/', run('dir /S /B * | findstr /v /i .git\ | findstr /v /i .vendor\ | findstr /v /i '.basename(__FILE__).' | findstr /r /i /M /F:/ ":author :vendor :package VendorName skeleton migration_table_name vendor_name vendor_slug author@domain.com"'));
|
|
||||||
}
|
|
||||||
|
|
||||||
function replaceForAllOtherOSes(): array
|
|
||||||
{
|
|
||||||
return explode(PHP_EOL, run('grep -E -r -l -i ":author|:vendor|:package|VendorName|skeleton|migration_table_name|vendor_name|vendor_slug|author@domain.com" --exclude-dir=vendor ./* ./.github/* | grep -v '.basename(__FILE__)));
|
|
||||||
}
|
|
||||||
|
|
||||||
function getGitHubApiEndpoint(string $endpoint): ?stdClass
|
|
||||||
{
|
|
||||||
try {
|
|
||||||
$curl = curl_init("https://api.github.com/{$endpoint}");
|
|
||||||
curl_setopt_array($curl, [
|
|
||||||
CURLOPT_RETURNTRANSFER => true,
|
|
||||||
CURLOPT_FOLLOWLOCATION => true,
|
|
||||||
CURLOPT_HTTPGET => true,
|
|
||||||
CURLOPT_HTTPHEADER => [
|
|
||||||
'User-Agent: spatie-configure-script/1.0',
|
|
||||||
],
|
|
||||||
]);
|
|
||||||
|
|
||||||
$response = curl_exec($curl);
|
|
||||||
$statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
|
|
||||||
|
|
||||||
curl_close($curl);
|
|
||||||
|
|
||||||
if ($statusCode === 200) {
|
|
||||||
return json_decode($response);
|
|
||||||
}
|
|
||||||
} catch (Exception $e) {
|
|
||||||
// ignore
|
|
||||||
}
|
|
||||||
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
function searchCommitsForGitHubUsername(): string
|
|
||||||
{
|
|
||||||
$authorName = strtolower(trim(shell_exec('git config user.name')));
|
|
||||||
|
|
||||||
$committersRaw = shell_exec("git log --author='@users.noreply.github.com' --pretty='%an:%ae' --reverse");
|
|
||||||
$committersLines = explode("\n", $committersRaw ?? '');
|
|
||||||
$committers = array_filter(array_map(function ($line) use ($authorName) {
|
|
||||||
$line = trim($line);
|
|
||||||
[$name, $email] = explode(':', $line) + [null, null];
|
|
||||||
|
|
||||||
return [
|
|
||||||
'name' => $name,
|
|
||||||
'email' => $email,
|
|
||||||
'isMatch' => strtolower($name) === $authorName && ! str_contains($name, '[bot]'),
|
|
||||||
];
|
|
||||||
}, $committersLines), fn ($item) => $item['isMatch']);
|
|
||||||
|
|
||||||
if (empty($committers)) {
|
|
||||||
return '';
|
|
||||||
}
|
|
||||||
|
|
||||||
$firstCommitter = reset($committers);
|
|
||||||
|
|
||||||
return explode('@', $firstCommitter['email'])[0] ?? '';
|
|
||||||
}
|
|
||||||
|
|
||||||
function guessGitHubUsernameUsingCli()
|
|
||||||
{
|
|
||||||
try {
|
|
||||||
if (preg_match('/ogged in to github\.com as ([a-zA-Z-_]+).+/', shell_exec('gh auth status -h github.com 2>&1'), $matches)) {
|
|
||||||
return $matches[1];
|
|
||||||
}
|
|
||||||
} catch (Exception $e) {
|
|
||||||
// ignore
|
|
||||||
}
|
|
||||||
|
|
||||||
return '';
|
|
||||||
}
|
|
||||||
|
|
||||||
function guessGitHubUsername(): string
|
|
||||||
{
|
|
||||||
$username = searchCommitsForGitHubUsername();
|
|
||||||
if (! empty($username)) {
|
|
||||||
return $username;
|
|
||||||
}
|
|
||||||
|
|
||||||
$username = guessGitHubUsernameUsingCli();
|
|
||||||
if (! empty($username)) {
|
|
||||||
return $username;
|
|
||||||
}
|
|
||||||
|
|
||||||
// fall back to using the username from the git remote
|
|
||||||
$remoteUrl = shell_exec('git config remote.origin.url') ?? '';
|
|
||||||
$remoteUrlParts = explode('/', str_replace(':', '/', trim($remoteUrl)));
|
|
||||||
|
|
||||||
return $remoteUrlParts[1] ?? '';
|
|
||||||
}
|
|
||||||
|
|
||||||
function guessGitHubVendorInfo($authorName, $username): array
|
|
||||||
{
|
|
||||||
$remoteUrl = shell_exec('git config remote.origin.url') ?? '';
|
|
||||||
$remoteUrlParts = explode('/', str_replace(':', '/', trim($remoteUrl)));
|
|
||||||
|
|
||||||
if (! isset($remoteUrlParts[1])) {
|
|
||||||
return [$authorName, $username];
|
|
||||||
}
|
|
||||||
|
|
||||||
$response = getGitHubApiEndpoint("orgs/{$remoteUrlParts[1]}");
|
|
||||||
|
|
||||||
if ($response === null) {
|
|
||||||
return [$authorName, $username];
|
|
||||||
}
|
|
||||||
|
|
||||||
return [$response->name ?? $authorName, $response->login ?? $username];
|
|
||||||
}
|
|
||||||
|
|
||||||
$gitName = run('git config user.name');
|
|
||||||
$authorName = ask('Author name', $gitName);
|
|
||||||
|
|
||||||
$gitEmail = run('git config user.email');
|
|
||||||
$authorEmail = ask('Author email', $gitEmail);
|
|
||||||
$authorUsername = ask('Author username', guessGitHubUsername());
|
|
||||||
|
|
||||||
$guessGitHubVendorInfo = guessGitHubVendorInfo($authorName, $authorUsername);
|
|
||||||
|
|
||||||
$vendorName = ask('Vendor name', $guessGitHubVendorInfo[0]);
|
|
||||||
$vendorUsername = ask('Vendor username', $guessGitHubVendorInfo[1] ?? slugify($vendorName));
|
|
||||||
$vendorSlug = slugify($vendorUsername);
|
|
||||||
|
|
||||||
$vendorNamespace = str_replace('-', '', ucwords($vendorName));
|
|
||||||
$vendorNamespace = ask('Vendor namespace', $vendorNamespace);
|
|
||||||
|
|
||||||
$currentDirectory = getcwd();
|
|
||||||
$folderName = basename($currentDirectory);
|
|
||||||
|
|
||||||
$packageName = ask('Package name', $folderName);
|
|
||||||
$packageSlug = slugify($packageName);
|
|
||||||
$packageSlugWithoutPrefix = remove_prefix('laravel-', $packageSlug);
|
|
||||||
|
|
||||||
$className = title_case($packageName);
|
|
||||||
$className = ask('Class name', $className);
|
|
||||||
$variableName = lcfirst($className);
|
|
||||||
$description = ask('Package description', "This is my package {$packageSlug}");
|
|
||||||
|
|
||||||
$usePhpStan = confirm('Enable PhpStan?', true);
|
|
||||||
$useLaravelPint = confirm('Enable Laravel Pint?', true);
|
|
||||||
$useDependabot = confirm('Enable Dependabot?', true);
|
|
||||||
$useLaravelRay = confirm('Use Ray for debugging?', true);
|
|
||||||
$useUpdateChangelogWorkflow = confirm('Use automatic changelog updater workflow?', true);
|
|
||||||
|
|
||||||
writeln('------');
|
|
||||||
writeln("Author : {$authorName} ({$authorUsername}, {$authorEmail})");
|
|
||||||
writeln("Vendor : {$vendorName} ({$vendorSlug})");
|
|
||||||
writeln("Package : {$packageSlug} <{$description}>");
|
|
||||||
writeln("Namespace : {$vendorNamespace}\\{$className}");
|
|
||||||
writeln("Class name : {$className}");
|
|
||||||
writeln('---');
|
|
||||||
writeln('Packages & Utilities');
|
|
||||||
writeln('Use Laravel/Pint : '.($useLaravelPint ? 'yes' : 'no'));
|
|
||||||
writeln('Use Larastan/PhpStan : '.($usePhpStan ? 'yes' : 'no'));
|
|
||||||
writeln('Use Dependabot : '.($useDependabot ? 'yes' : 'no'));
|
|
||||||
writeln('Use Ray App : '.($useLaravelRay ? 'yes' : 'no'));
|
|
||||||
writeln('Use Auto-Changelog : '.($useUpdateChangelogWorkflow ? 'yes' : 'no'));
|
|
||||||
writeln('------');
|
|
||||||
|
|
||||||
writeln('This script will replace the above values in all relevant files in the project directory.');
|
|
||||||
|
|
||||||
if (! confirm('Modify files?', true)) {
|
|
||||||
exit(1);
|
|
||||||
}
|
|
||||||
|
|
||||||
$files = (str_starts_with(strtoupper(PHP_OS), 'WIN') ? replaceForWindows() : replaceForAllOtherOSes());
|
|
||||||
|
|
||||||
foreach ($files as $file) {
|
|
||||||
replace_in_file($file, [
|
|
||||||
':author_name' => $authorName,
|
|
||||||
':author_username' => $authorUsername,
|
|
||||||
'author@domain.com' => $authorEmail,
|
|
||||||
':vendor_name' => $vendorName,
|
|
||||||
':vendor_slug' => $vendorSlug,
|
|
||||||
'VendorName' => $vendorNamespace,
|
|
||||||
':package_name' => $packageName,
|
|
||||||
':package_slug' => $packageSlug,
|
|
||||||
':package_slug_without_prefix' => $packageSlugWithoutPrefix,
|
|
||||||
'Skeleton' => $className,
|
|
||||||
'skeleton' => $packageSlug,
|
|
||||||
'migration_table_name' => title_snake($packageSlug),
|
|
||||||
'variable' => $variableName,
|
|
||||||
':package_description' => $description,
|
|
||||||
]);
|
|
||||||
|
|
||||||
match (true) {
|
|
||||||
str_contains($file, determineSeparator('src/Skeleton.php')) => rename($file, determineSeparator('./src/'.$className.'.php')),
|
|
||||||
str_contains($file, determineSeparator('src/SkeletonServiceProvider.php')) => rename($file, determineSeparator('./src/'.$className.'ServiceProvider.php')),
|
|
||||||
str_contains($file, determineSeparator('src/Facades/Skeleton.php')) => rename($file, determineSeparator('./src/Facades/'.$className.'.php')),
|
|
||||||
str_contains($file, determineSeparator('src/Commands/SkeletonCommand.php')) => rename($file, determineSeparator('./src/Commands/'.$className.'Command.php')),
|
|
||||||
str_contains($file, determineSeparator('database/migrations/create_skeleton_table.php.stub')) => rename($file, determineSeparator('./database/migrations/create_'.title_snake($packageSlugWithoutPrefix).'_table.php.stub')),
|
|
||||||
str_contains($file, determineSeparator('config/skeleton.php')) => rename($file, determineSeparator('./config/'.$packageSlugWithoutPrefix.'.php')),
|
|
||||||
str_contains($file, 'README.md') => remove_readme_paragraphs($file),
|
|
||||||
default => [],
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
if (! $useLaravelPint) {
|
|
||||||
safeUnlink(__DIR__.'/.github/workflows/fix-php-code-style-issues.yml');
|
|
||||||
safeUnlink(__DIR__.'/pint.json');
|
|
||||||
}
|
|
||||||
|
|
||||||
if (! $usePhpStan) {
|
|
||||||
safeUnlink(__DIR__.'/phpstan.neon.dist');
|
|
||||||
safeUnlink(__DIR__.'/phpstan-baseline.neon');
|
|
||||||
safeUnlink(__DIR__.'/.github/workflows/phpstan.yml');
|
|
||||||
|
|
||||||
remove_composer_deps([
|
|
||||||
'phpstan/extension-installer',
|
|
||||||
'phpstan/phpstan-deprecation-rules',
|
|
||||||
'phpstan/phpstan-phpunit',
|
|
||||||
'larastan/larastan',
|
|
||||||
]);
|
|
||||||
|
|
||||||
remove_composer_script('phpstan');
|
|
||||||
}
|
|
||||||
|
|
||||||
if (! $useDependabot) {
|
|
||||||
safeUnlink(__DIR__.'/.github/dependabot.yml');
|
|
||||||
safeUnlink(__DIR__.'/.github/workflows/dependabot-auto-merge.yml');
|
|
||||||
}
|
|
||||||
|
|
||||||
if (! $useLaravelRay) {
|
|
||||||
remove_composer_deps(['spatie/laravel-ray']);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (! $useUpdateChangelogWorkflow) {
|
|
||||||
safeUnlink(__DIR__.'/.github/workflows/update-changelog.yml');
|
|
||||||
}
|
|
||||||
|
|
||||||
confirm('Execute `composer install` and run tests?') && run('composer install && composer test');
|
|
||||||
|
|
||||||
confirm('Let this script delete itself?', true) && unlink(__FILE__);
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace VendorName\Skeleton\Database\Factories;
|
namespace Msr\LaravelBitunixApi\Database\Factories;
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Factories\Factory;
|
use Illuminate\Database\Eloquent\Factories\Factory;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ return new class extends Migration
|
||||||
{
|
{
|
||||||
public function up()
|
public function up()
|
||||||
{
|
{
|
||||||
Schema::create('migration_table_name_table', function (Blueprint $table) {
|
Schema::create('laravel_bitunix_api_table', function (Blueprint $table) {
|
||||||
$table->id();
|
$table->id();
|
||||||
|
|
||||||
// add fields
|
// add fields
|
||||||
|
|
@ -16,7 +16,7 @@
|
||||||
backupStaticProperties="false"
|
backupStaticProperties="false"
|
||||||
>
|
>
|
||||||
<testsuites>
|
<testsuites>
|
||||||
<testsuite name="VendorName Test Suite">
|
<testsuite name="Msr Test Suite">
|
||||||
<directory>tests</directory>
|
<directory>tests</directory>
|
||||||
</testsuite>
|
</testsuite>
|
||||||
</testsuites>
|
</testsuites>
|
||||||
|
|
|
||||||
|
|
@ -1,12 +1,12 @@
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace VendorName\Skeleton\Commands;
|
namespace Msr\LaravelBitunixApi\Commands;
|
||||||
|
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
|
|
||||||
class SkeletonCommand extends Command
|
class LaravelBitunixApiCommand extends Command
|
||||||
{
|
{
|
||||||
public $signature = 'skeleton';
|
public $signature = 'laravel-bitunix-api';
|
||||||
|
|
||||||
public $description = 'My command';
|
public $description = 'My command';
|
||||||
|
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Msr\LaravelBitunixApi\Facades;
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Facade;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see \Msr\LaravelBitunixApi\LaravelBitunixApi
|
||||||
|
*/
|
||||||
|
class LaravelBitunixApi extends Facade
|
||||||
|
{
|
||||||
|
protected static function getFacadeAccessor(): string
|
||||||
|
{
|
||||||
|
return \Msr\LaravelBitunixApi\LaravelBitunixApi::class;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -1,16 +0,0 @@
|
||||||
<?php
|
|
||||||
|
|
||||||
namespace VendorName\Skeleton\Facades;
|
|
||||||
|
|
||||||
use Illuminate\Support\Facades\Facade;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @see \VendorName\Skeleton\Skeleton
|
|
||||||
*/
|
|
||||||
class Skeleton extends Facade
|
|
||||||
{
|
|
||||||
protected static function getFacadeAccessor(): string
|
|
||||||
{
|
|
||||||
return \VendorName\Skeleton\Skeleton::class;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Msr\LaravelBitunixApi;
|
||||||
|
|
||||||
|
class LaravelBitunixApi {}
|
||||||
|
|
@ -1,12 +1,12 @@
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace VendorName\Skeleton;
|
namespace Msr\LaravelBitunixApi;
|
||||||
|
|
||||||
use Spatie\LaravelPackageTools\Package;
|
use Spatie\LaravelPackageTools\Package;
|
||||||
use Spatie\LaravelPackageTools\PackageServiceProvider;
|
use Spatie\LaravelPackageTools\PackageServiceProvider;
|
||||||
use VendorName\Skeleton\Commands\SkeletonCommand;
|
use Msr\LaravelBitunixApi\Commands\LaravelBitunixApiCommand;
|
||||||
|
|
||||||
class SkeletonServiceProvider extends PackageServiceProvider
|
class LaravelBitunixApiServiceProvider extends PackageServiceProvider
|
||||||
{
|
{
|
||||||
public function configurePackage(Package $package): void
|
public function configurePackage(Package $package): void
|
||||||
{
|
{
|
||||||
|
|
@ -16,10 +16,10 @@ class SkeletonServiceProvider extends PackageServiceProvider
|
||||||
* More info: https://github.com/spatie/laravel-package-tools
|
* More info: https://github.com/spatie/laravel-package-tools
|
||||||
*/
|
*/
|
||||||
$package
|
$package
|
||||||
->name('skeleton')
|
->name('laravel-bitunix-api')
|
||||||
->hasConfigFile()
|
->hasConfigFile()
|
||||||
->hasViews()
|
->hasViews()
|
||||||
->hasMigration('create_migration_table_name_table')
|
->hasMigration('create_laravel_bitunix_api_table')
|
||||||
->hasCommand(SkeletonCommand::class);
|
->hasCommand(LaravelBitunixApiCommand::class);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
<?php
|
|
||||||
|
|
||||||
namespace VendorName\Skeleton;
|
|
||||||
|
|
||||||
class Skeleton {}
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
use VendorName\Skeleton\Tests\TestCase;
|
use Msr\LaravelBitunixApi\Tests\TestCase;
|
||||||
|
|
||||||
uses(TestCase::class)->in(__DIR__);
|
uses(TestCase::class)->in(__DIR__);
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,10 @@
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace VendorName\Skeleton\Tests;
|
namespace Msr\LaravelBitunixApi\Tests;
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Factories\Factory;
|
use Illuminate\Database\Eloquent\Factories\Factory;
|
||||||
use Orchestra\Testbench\TestCase as Orchestra;
|
use Orchestra\Testbench\TestCase as Orchestra;
|
||||||
use VendorName\Skeleton\SkeletonServiceProvider;
|
use Msr\LaravelBitunixApi\LaravelBitunixApiServiceProvider;
|
||||||
|
|
||||||
class TestCase extends Orchestra
|
class TestCase extends Orchestra
|
||||||
{
|
{
|
||||||
|
|
@ -13,14 +13,14 @@ class TestCase extends Orchestra
|
||||||
parent::setUp();
|
parent::setUp();
|
||||||
|
|
||||||
Factory::guessFactoryNamesUsing(
|
Factory::guessFactoryNamesUsing(
|
||||||
fn (string $modelName) => 'VendorName\\Skeleton\\Database\\Factories\\'.class_basename($modelName).'Factory'
|
fn (string $modelName) => 'Msr\\LaravelBitunixApi\\Database\\Factories\\'.class_basename($modelName).'Factory'
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function getPackageProviders($app)
|
protected function getPackageProviders($app)
|
||||||
{
|
{
|
||||||
return [
|
return [
|
||||||
SkeletonServiceProvider::class,
|
LaravelBitunixApiServiceProvider::class,
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue