@@ -6,8 +6,8 @@ Composer plugin for automatically downloading Drupal scaffold files (like
6
6
It is recommended that the vendor directory be placed in its standard location
7
7
at the project root, outside of the Drupal root; however, the location of the
8
8
vendor directory and the name of the Drupal root may be placed in whatever
9
- location suits the project. Drupal-scaffold will generate the autoload.php
10
- file at the Drupal root to require the Composer-generated autoload file in the
9
+ location suits the project. Drupal-scaffold will generate the autoload.php
10
+ file at the Drupal root to require the Composer-generated autoload file in the
11
11
vendor directory.
12
12
13
13
## Usage
@@ -28,7 +28,7 @@ of your root `composer.json`.
28
28
{
29
29
"extra" : {
30
30
"drupal-scaffold" : {
31
- "source" : " https ://ftp.drupal .org/files/projects/drupal-{ version}.tar.gz " ,
31
+ "source" : " http ://cgit.drupalcode .org/drupal/plain/{path}?h={ version}" ,
32
32
"excludes" : [
33
33
" google123.html" ,
34
34
" robots.txt"
@@ -47,37 +47,26 @@ scaffold files from; the default source is drupal.org. The literal string
47
47
Drupal core being updated prior to download.
48
48
49
49
With the ` drupal-scaffold ` option ` excludes ` , you can provide additional paths
50
- that should not be copied or overwritten. Default excludes are provided by the
51
- plugin:
52
- ```
53
- .gitkeep
54
- autoload.php
55
- composer.json
56
- composer.lock
57
- core
58
- drush
59
- example.gitignore
60
- LICENSE.txt
61
- README.txt
62
- vendor
63
- themes
64
- profiles
65
- modules
66
- sites/*
67
- sites/default/*
68
- ```
50
+ that should not be copied or overwritten. The plugin provides no excludes by
51
+ default.
69
52
70
- If there are some files inside of an excluded location that should be
71
- copied over, they can be individually selected for inclusion via the
72
- ` includes ` option. Default includes are provided by the plugin:
53
+ Default includes are provided by the plugin:
73
54
```
74
- sites
75
- sites/default
55
+ .csslintrc
56
+ .editorconfig
57
+ .eslintignore
58
+ .eslintrc
59
+ .gitattributes
60
+ .htaccess
61
+ index.php
62
+ robots.txt
76
63
sites/default/default.settings.php
77
64
sites/default/default.services.yml
78
65
sites/development.services.yml
79
66
sites/example.settings.local.php
80
67
sites/example.sites.php
68
+ update.php
69
+ web.config
81
70
```
82
71
83
72
When setting ` omit-defaults ` to ` true ` , neither the default excludes nor the
@@ -114,8 +103,7 @@ command callback to the `scripts`-section of your root `composer.json`, like thi
114
103
After that you can manually download the scaffold files according to your
115
104
configuration by using ` composer drupal-scaffold ` .
116
105
117
- Note that drupal-scaffold does not automatically run after ` composer install ` .
118
106
It is assumed that the scaffold files will be committed to the repository, to
119
107
ensure that the correct files are used on the CI server (see ** Limitation** ,
120
- above). After running ` composer install ` for the first time, also run
121
- ` composer drupal-scaffold ` , and commit the scaffold files to your repository.
108
+ above). After running ` composer install ` for the first time commit the scaffold
109
+ files to your repository.
0 commit comments