Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #3302654 by bnjmnm, xjm, quietone, lauriii, phenaproxima: Create Starterkit readme 

(cherry picked from commit 7e4c0f9675)
merge-requests/2674/head
xjm 2022-08-23 19:42:28 -05:00
parent e2a229fba1
commit 7512b90172
No known key found for this signature in database
GPG Key ID: 206B0B8743BDF4C2
3 changed files with 56 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
core/lib/Drupal/Core/Command/GenerateTheme.php
View File

@ -97,6 +97,13 @@ class GenerateTheme extends Command {
$tmp_dir = $this->getUniqueTmpDirPath();
$this->copyRecursive($source, $tmp_dir);
// Readme is specific to Starterkit, so remove it from the generated theme.
$readme_file = "$tmp_dir/README.md";
if (!file_put_contents($readme_file, "$destination_theme theme, generated from $source_theme_name. Additional information on generating themes can be found in the [Starterkit documentation](https://www.drupal.org/docs/core-modules-and-themes/core-themes/starterkit-theme).")) {
$io->getErrorStyle()->error("The readme could not be rewritten.");
return 1;
}
// Rename files based on the theme machine name.
$file_pattern = "/$source_theme_name\.(theme|[^.]+\.yml)/";
if ($files = @scandir($tmp_dir)) {

38
core/tests/Drupal/Tests/Core/Command/GenerateThemeTest.php
View File

@ -99,6 +99,10 @@ class GenerateThemeTest extends QuickStartTestBase {
self::assertArrayHasKey('generator', $info);
self::assertEquals('starterkit_theme:9.4.0', $info['generator']);
// Confirm readme is rewritten.
$readme_file = $this->getWorkspaceDirectory() . "/$theme_path_relative/README.md";
$this->assertSame('test_custom_theme theme, generated from starterkit_theme. Additional information on generating themes can be found in the [Starterkit documentation](https://www.drupal.org/docs/core-modules-and-themes/core-themes/starterkit-theme).', file_get_contents($readme_file));
// Ensure that the generated theme can be installed.
$this->installQuickStart('minimal');
$this->formLogin($this->adminUsername, $this->adminPassword);
@ -121,6 +125,40 @@ class GenerateThemeTest extends QuickStartTestBase {
$this->assertFileDoesNotExist($theme_path_absolute . '/test_custom_theme.theme');
}
/**
* Tests generating a theme from another Starterkit enabled theme.
*/
public function testGeneratingFromAnotherTheme() {
// Do not rely on \Drupal::VERSION: change the version to a concrete version
// number, to simulate using a tagged core release.
$starterkit_info_yml = $this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/starterkit_theme.info.yml';
$info = Yaml::decode(file_get_contents($starterkit_info_yml));
$info['version'] = '9.4.0';
file_put_contents($starterkit_info_yml, Yaml::encode($info));
$process = $this->generateThemeFromStarterkit();
$exit_code = $process->run();
$this->assertSame('Theme generated successfully to themes/test_custom_theme', trim($process->getOutput()), $process->getErrorOutput());
$this->assertSame(0, $exit_code);
$install_command = [
$this->php,
'core/scripts/drupal',
'generate-theme',
'generated_from_another_theme',
'--name="Generated from another theme"',
'--description="Custom theme generated from a theme other than starterkit_theme"',
'--starterkit=test_custom_theme',
];
$process = new Process($install_command);
$exit_code = $process->run();
$this->assertSame('Theme generated successfully to themes/generated_from_another_theme', trim($process->getOutput()), $process->getErrorOutput());
$this->assertSame(0, $exit_code);
// Confirm readme is rewritten.
$readme_file = $this->getWorkspaceDirectory() . '/themes/generated_from_another_theme/README.md';
$this->assertSame('generated_from_another_theme theme, generated from test_custom_theme. Additional information on generating themes can be found in the [Starterkit documentation](https://www.drupal.org/docs/core-modules-and-themes/core-themes/starterkit-theme).', file_get_contents($readme_file));
}
/**
* Tests the generate-theme command on a dev snapshot of Drupal core.
*/

11
core/themes/starterkit_theme/README.md Normal file
View File

@ -0,0 +1,11 @@
# Starterkit Theme
## How to use Starterkit
The Starterkit theme is not directly used by Drupal, nor is it used as a base theme.
**Starterkit is for generating new themes** that include
reasonably un-opinionated templates and styles that eliminate much of the
the initial work required to create a theme.
Starterkit is the recommended approach for creating new themes. For more
information, consult the
[Starterkit documentation on Drupal.org](https://www.drupal.org/docs/core-modules-and-themes/core-themes/starterkit-theme).