narrowspark / automatic
Composer plugin for automate the most common tasks of applications.
Fund package maintenance!
prisis
Installs: 482
Dependents: 1
Suggesters: 0
Security: 0
Stars: 12
Watchers: 3
Forks: 1
Open Issues: 33
Type:composer-plugin
Requires
- php: ^7.2
- composer-plugin-api: ^1.0
- ext-json: *
- ext-tokenizer: *
Requires (Dev)
- composer/composer: ^1.7.0 || ^1.8.0 || ^1.9.0
- infection/infection: ^0.13.6
- mockery/mockery: ^1.2.2
- narrowspark/coding-standard: ^3.2.0
- narrowspark/testing-helper: ^8.0.2
- nyholm/nsa: ^1.1.0
- ocramius/package-versions: ^1.4.0 || ^1.5.0
- phpunit/phpunit: ^8.4.1
- slam/phpstan-extensions: ^3.6.1
- 1.0.x-dev
- dev-master / 0.13.x-dev
- 0.13.1
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.6
- 0.8.5
- 0.8.4
- 0.8.3
- 0.8.2
- 0.8.1
- 0.8.0
- 0.7.0
- 0.6.1
- 0.6.0
- 0.5.2
- 0.5.1
- 0.5.0
- 0.4.1
- v0.4.0
- v0.3.6
- v0.3.5
- v0.3.4
- v0.3.3
- v0.3.2
- v0.3.1
- v0.3.0
- v0.2.0
- v0.1.7
- v0.1.6
- v0.1.5
- v0.1.4
- v0.1.3
- v0.1.2
- v0.1.1
- v0.1.0
- dev-dependabot/npm_and_yarn/json5-2.2.3
- dev-renovate/configure
- dev-dependabot/npm_and_yarn/node-fetch-2.6.7
- dev-dependabot/npm_and_yarn/path-parse-1.0.7
- dev-dependabot/npm_and_yarn/textlint-12.0.2
- dev-dependabot/npm_and_yarn/textlint-rule-write-good-2.0.0
- dev-dependabot/npm_and_yarn/textlint-rule-alex-3.0.0
- dev-dependabot/npm_and_yarn/textlint-rule-helper-2.2.0
- dev-dependabot/npm_and_yarn/textlint-rule/textlint-rule-no-invalid-control-character-2.0.0
- dev-dependabot/npm_and_yarn/textlint-rule-terminology-2.1.5
- dev-dependabot/npm_and_yarn/textlint-rule-en-capitalization-2.0.3
- dev-dependabot/npm_and_yarn/textlint-rule-no-dead-link-4.7.0
- dev-dependabot/npm_and_yarn/ini-1.3.7
- dev-dependabot/npm_and_yarn/lodash-4.17.21
- dev-dependabot/npm_and_yarn/dot-prop-4.2.1
- dev-dependabot/composer/dot-build/wikimedia/composer-merge-plugin-tw-2.0.1
- dev-dependabot/npm_and_yarn/hosted-git-info-2.8.9
- dev-dependabot/npm_and_yarn/node-fetch-2.6.1
- dev-dependabot/npm_and_yarn/ini-1.3.8
- dev-dependabot/add-v2-config-file
- dev-dependabot/composer/phpunit/phpunit-tw-8.5.14
- dev-dependabot/composer/symfony/process-tw-5.2.1
- dev-dependabot/composer/composer/composer-tw-2.0.8
- dev-dependabot/composer/nyholm/nsa-tw-1.2.1
- dev-dependabot/composer/mockery/mockery-tw-1.4.2
- dev-dependabot/composer/justinrainbow/json-schema-tw-5.2.10
This package is auto-updated.
Last update: 2023-03-04 23:28:22 UTC
README
Narrowspark Automatic automates the most common tasks of applications, like installing and removing bundles or providers, copying files, boosting dependencies downloads, creating skeletons and other Composer dependencies based configurations.
How Does Narrowspark Automatic Work
Narrowspark Automatic is a Composer plugin that modifies the behavior of the require
, update
, create project
, and remove
commands.
When installing or removing dependencies in an Automatic extended app, your Application can perform tasks before and after the execution of Composer tasks.
Consider the following example:
cd your-project
composer require viserio/console
If you execute this command in your Application that doesn’t support Narrowspark Automatic, this command will execute in the normal composer require behavior.
Note The
automatic.json
and composer.json extra keyautomatic
are used to configure Narrowspark Automatic with configurators, script executors, custom-configurators, and more.
When Narrowspark Automatic is installed in your Application, it will check if a automatic.json
file or a composer.json extra key with automatic
exists.
In the above example, Automatic decided which automated tasks need to be run after the installation.
Note Narrowspark Automatic keeps tracks of the configuration, in a
automatic.lock
file, which must be committed to your code repository.
Using Narrowspark Automatic in New Applications
Include Narrowspark Automatic as a required dependency to your app with this command:
composer require narrospark/automatic
.
Using Narrowspark Automatic for Skeleton Application
Narrowspark Automatic supports skeleton generation. For example this is your composer.json
file:
{ "type": "project", "license": "MIT", "require": { "php": "^7.2", "ext-mbstring": "*", "narrowspark/automatic": "^0.3.5", "narrowspark/skeleton-generators": "^0.1.0" }, "extra": { "app-dir": "app", "config-dir": "config", "database-dir": "database", "public-dir": "public", "resources-dir": "resources", "routes-dir": "routes", "storage-dir": "storage", "tests-dir": "tests" }, "autoload": { "psr-4": { "App\\": "app/" }, "exclude-from-classmap": [ "tests/" ] }, "autoload-dev": { "psr-4": { "App\\Tests\\": "tests/" } }, "minimum-stability": "dev", "prefer-stable": true }
Automatic search all packages for the package type: automatic-skeleton
.
If packages are found with this type, all skeletons will be saved in the automatic.lock
for the runtime.
This means you can execute the following command: composer create-project your/project
to create an Automatic extended app, Automatic will ask which skeleton can be generated for your app.
Read the skeleton documentation to learn everything about how to create skeletons for your own app.
Narrowspark Automatic tasks are defined in a automatic.json
file or in the composer extra key automatic
and can contain any number of other files and directories. For example, this is the automatic.json
for viserio/console
:
{ "configurators": { "providers": { "Viserio\\Component\\Console\\Provider\\ConsoleServiceProvider": ["global"], "Viserio\\Component\\Console\\Provider\\LazilyCommandsServiceProvider": ["global"] }, "proxies": { "Viserio\\Component\\Console\\Proxy\\Console": ["global"] } }, "script-extenders": [ "Viserio\\Component\\Console\\Automatic\\CerebroScriptExtender" ] }
The providers
and proxies
option tells Narrowspark Automatic in which environments this provider
, proxy
can be turn on automatically (all in this case).
The script-extenders
option adds a new script executor to the Narrowspark Automatic auto-scripts
.
Now you can run viserio console
commands in the auto-scripts
section of your composer.json
app file.
The instructions defined in this automatic.json
file are also used by Narrowspark Automatic when uninstalling dependencies (for example composer remove viserio/console
) to undo all changes.
This means that Automatic can remove the Console Provider and Proxy from the app and remove the script executor from Narrowspark Automatic.
Read the configuration documentation to learn everything about how to create configuration for your own packages.
Automatic extends Composer
Narrowspark Automatic adds a parallel downloader with the feature to skip old dependencies tags for a download boost.
With the below example you can see how to add a skip tag to Narrowspark Automatic, with this it will skip all tags of cakephp
that are older then 3.5
.
{ "extra": { "automatic": { "require": { "cakephp/cakephp": ">=3.5" } } } }
You can skip auto discovery
for packages with this Narrowspark Automatic key dont-discover
in your composer.json extra automatic
section. Use the package name to skip the auto discovery
, like in this example:
{ "extra" : { "dont-discover": [ "viserio/console" ] } }
Auto discovery will now be skipped for viserio/console
.
Automatic Security Audit
Narrowspark Automatic shows you on every composer install
and composer update
known security vulnerabilities for your installed dependencies based on FriendsOfPHP/security-advisories database.
If you like to change the default HTTP timeout = 20
for the downloader, add audit
to your composer.json extra
section, like in this example:
{ "extra" : { "audit": { "timeout": "30" } } }
Testing
You need to run:
$ php vendor/bin/phpunit
Versioning
This library follows semantic versioning, and additions to the code ruleset are performed in major releases.
Changelog
Please have a look at CHANGELOG.md
.
Contributing
Please have a look at CONTRIBUTING.md
.
Code of Conduct
Please have a look at CODE_OF_CONDUCT.md
.
Credits
- Daniel Bannert
- All Contributors
- Narrowspark Automatic has been inspired by symfony/flex
License
This package is licensed using the MIT License.
Please have a look at LICENSE.md
.