README.md

Same filename in this branch
  1. 11.x composer/Plugin/ProjectMessage/README.md
  2. 11.x composer/Plugin/Scaffold/README.md
  3. 11.x composer/Plugin/RecipeUnpack/README.md
  4. 11.x core/themes/olivero/README.md
  5. 11.x core/themes/claro/images/core/README.md
  6. 11.x core/themes/starterkit_theme/README.md
  7. 11.x core/modules/package_manager/tests/fixtures/build_test_projects/README.md
  8. 11.x core/modules/package_manager/tests/fixtures/fake_site/README.md
  9. 11.x core/tests/Drupal/Tests/Composer/Plugin/Scaffold/fixtures/project-with-illegal-dir-scaffold/assets/README.md
  10. 11.x core/tests/Drupal/Tests/Composer/Plugin/Scaffold/fixtures/drupal-composer-drupal-project/docroot/sites/default/README.md
  11. 11.x core/tests/Drupal/Tests/Composer/Plugin/Scaffold/fixtures/drupal-composer-drupal-project/docroot/README.md
  12. 11.x core/tests/PHPStan/README.md
  13. 11.x core/tests/README.md
  14. 11.x README.md

Fixtures README

These fixtures are automatically copied to a temporary directory during test runs. After the test run, the fixtures are automatically deleted.

Set the SCAFFOLD_FIXTURE_DIR environment variable to place the fixtures in a specific location rather than a temporary directory. If this is done, then the fixtures will not be deleted after the test run. This is useful for ad-hoc testing.

Example:

$ SCAFFOLD_FIXTURE_DIR=$HOME/tmp/scaffold-fixtures composer unit $ cd $HOME/tmp/scaffold-fixtures $ cd drupal-drupal $ composer drupal:scaffold

Scaffolding files for fixtures/drupal-assets-fixture:

  • Link [web-root]/.csslintrc from assets/.csslintrc
  • Link [web-root]/.editorconfig from assets/.editorconfig
  • Link [web-root]/.eslintignore from assets/.eslintignore
  • Link [web-root]/.eslintrc.json from assets/.eslintrc.json
  • Link [web-root]/.gitattributes from assets/.gitattributes
  • Link [web-root]/.ht.router.php from assets/.ht.router.php
  • Skip [web-root]/.htaccess: overridden in my/project
  • Link [web-root]/sites/default/default.services.yml from assets/default.services.yml
  • Skip [web-root]/sites/default/default.settings.php: overridden in fixtures/scaffold-override-fixture
  • Link [web-root]/sites/example.settings.local.php from assets/example.settings.local.php
  • Link [web-root]/sites/example.sites.php from assets/example.sites.php
  • Link [web-root]/index.php from assets/index.php
  • Skip [web-root]/robots.txt: overridden in my/project
  • Link [web-root]/update.php from assets/update.php Scaffolding files for fixtures/scaffold-override-fixture:
  • Link [web-root]/sites/default/default.settings.php from assets/override-settings.php Scaffolding files for my/project:
  • Skip [web-root]/.htaccess: disabled
  • Link [web-root]/robots.txt from assets/robots-default.txt

File

core/tests/Drupal/Tests/Composer/Plugin/Scaffold/fixtures/README.md

View source
# Fixtures README

These fixtures are automatically copied to a temporary directory during test
runs. After the test run, the fixtures are automatically deleted.

Set the SCAFFOLD_FIXTURE_DIR environment variable to place the fixtures in a
specific location rather than a temporary directory. If this is done, then the
fixtures will not be deleted after the test run. This is useful for ad-hoc
testing.

Example:

$ SCAFFOLD_FIXTURE_DIR=$HOME/tmp/scaffold-fixtures composer unit
$ cd $HOME/tmp/scaffold-fixtures
$ cd drupal-drupal
$ composer drupal:scaffold

Scaffolding files for fixtures/drupal-assets-fixture:
  - Link [web-root]/.csslintrc from assets/.csslintrc
  - Link [web-root]/.editorconfig from assets/.editorconfig
  - Link [web-root]/.eslintignore from assets/.eslintignore
  - Link [web-root]/.eslintrc.json from assets/.eslintrc.json
  - Link [web-root]/.gitattributes from assets/.gitattributes
  - Link [web-root]/.ht.router.php from assets/.ht.router.php
  - Skip [web-root]/.htaccess: overridden in my/project
  - Link [web-root]/sites/default/default.services.yml from assets/default.services.yml
  - Skip [web-root]/sites/default/default.settings.php: overridden in fixtures/scaffold-override-fixture
  - Link [web-root]/sites/example.settings.local.php from assets/example.settings.local.php
  - Link [web-root]/sites/example.sites.php from assets/example.sites.php
  - Link [web-root]/index.php from assets/index.php
  - Skip [web-root]/robots.txt: overridden in my/project
  - Link [web-root]/update.php from assets/update.php
Scaffolding files for fixtures/scaffold-override-fixture:
  - Link [web-root]/sites/default/default.settings.php from assets/override-settings.php
Scaffolding files for my/project:
  - Skip [web-root]/.htaccess: disabled
  - Link [web-root]/robots.txt from assets/robots-default.txt

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.