Merge pull request #11 from healthgovau/395-support-subtheme-app-inte…

…gration

395 support subtheme app integration

.githooks/pre-commit

@@ -30,9 +30,10 @@ then
     if [ $drupalfailed != 0 ]
     then
         echo "PHPCS failed, errors found not fixable automatically, git commit denied!"
+        exit 1
     fi
 fi
 
 #### End of Code Sniffer
 
-exit $commitfailed
+exit 0

.github/workflows/build.yml

@@ -47,6 +47,7 @@ jobs:
     runs-on: ubuntu-latest
     env:
       THEME_PATH: 'themes/health'
+      HEALTH_CI_MODE: 1
     steps:
       -
         name: Checkout codebase

README.md

@@ -62,6 +62,7 @@ This documentation assumes you are using MacOS or Linux as your host environment
 - [Docker](https://docs.docker.com/install/)
 - [Pygmy](https://pygmy.readthedocs.io/en/master/)
 - [Ahoy](https://github.com/ahoy-cli/ahoy)
+- [Yarn](https://yarnpkg.com/) (required if installing apps or tools built using Yarn)
 
 ## Create new project based on ASK
 
@@ -193,12 +194,14 @@ Add the app using Composer using the package name.
 composer require healthgovau/out-of-pocket
 ```
 
-During the installation process you will be asked the following:
+During the installation process you will be asked one or more of the following questions:
 
 | Question | Description |
 | --- | --- |
-| Is this a production build? | Respond `n` to enable app console logging or if you want to use local dev version of the app (e.g. you want to run the app dev environment using `npm run start`). |
-| Remove static CSS links from project? | Will be asked when importing a React app. It is designed to support legacy apps which use the CSS stylesheets provided by the host site. Responding `y` will result in links to CSS files in `build/static/css` directory being removed from the app. This process effectively removes all CSS files compiled directly by the React app. The use of apps which are fully decoupled from the host site are strongly encouraged. In such case on would not remove static CSS links. Please consult with the app developer or app project manager if you are unclear whether or not these static CSS files should be included or not. |
+| In which theme should the app or tool be installed? | Enter the number corresponding to the theme in which the app or tool should be installed. |
+| Is this a production build? | Respond `n` to enable app console logging or if you want to use local dev version of the app (e.g. you want to run the app dev environment using `npm run start`). Default value is __yes__. |
+| Remove static CSS links from project? | Will be asked when importing a React app. The default value is __no__. It is designed to support legacy apps which use the CSS stylesheets provided by the host site. Responding `y` will result in links to CSS files in `build/static/css` directory being removed from the app. This process effectively removes all CSS files compiled directly by the React app. The use of apps which are fully decoupled from the host site are strongly encouraged. In such case on would not remove static CSS links. Please consult with the app developer or app project manager if you are unclear whether or not these static CSS files should be included or not. |
+| Which package manager would you like to use? | Enter the number of the package manager to use when building the app or tool project. The installer will attempt to detect whether npm or yarn is being used as the package manager. In the case that it detects configuration from both package managers it will ask you to confirm which one should be used. |
 
 #### Update an app
 
@@ -473,7 +476,7 @@ To use:
 
 The project makes use of [Cypress](https://www.cypress.io/) and [Percy](https://percy.io/) to implemented visual regression tests in Github workflow pipelines.
 
-When creating or updating pull requests on `develop` or `master` branches snapshots of sample content type pages will be created and analysed by Percy. In case of a failure the results can be reviewed in Percy. Once approved in Percy one will be able to merge the pull request.
+When creating or updating pull requests on the `v1.x` branch snapshots of sample content type pages will be created and analysed by Percy. In case of a failure the results can be reviewed in Percy. Once approved in Percy one will be able to merge the pull request.
 
 Cypress test configuration can be found in the `cypress/integration/` directory.
 

apps/README.md

@@ -0,0 +1,3 @@
+# Temp directory
+
+This directory is used for temporary file storage as part of the app integration process. Files in this dictory should not be commited to the project repository.

apps/apps.json

@@ -0,0 +1 @@
+[{"app":"sample-react-app","theme":"health"}]

composer.json

@@ -16,8 +16,17 @@
     },
     "repositories": [
         {
-            "type": "composer",
-            "url": "https://packages.drupal.org/8"
+            "type": "package",
+            "package": {
+                "name": "healthgovau/out-of-pocket",
+                "version": "1.2.1",
+                "type": "health-app-react",
+                "source": {
+                    "type": "git",
+                    "url": "[email protected]:healthgovau/out-of-pocket.git",
+                    "reference": "v1.2.1"
+                }
+            }
         },
         {
             "type": "package",
@@ -44,6 +53,10 @@
                     "reference": "1.0.1"
                 }
             }
+        },
+        {
+            "type": "composer",
+            "url": "https://packages.drupal.org/8"
         }
     ],
     "minimum-stability": "stable",
@@ -60,12 +73,13 @@
     },
     "scripts": {
         "post-install-cmd": [
-            "cat .githooks/pre-commit >> .git/hooks/pre-commit && chmod a+x .git/hooks/pre-commit"
+            "cat .githooks/pre-commit > .git/hooks/pre-commit && chmod a+x .git/hooks/pre-commit"
         ],
         "post-package-install": [
             "Health\\Helper::postPackageInstall",
             "Health\\App::postPackageInstall"
         ],
+        "post-package-uninstall": "Health\\App::postPackageUninstall",
         "code-check": "./vendor/bin/phpcs",
         "code-fix": "./vendor/bin/phpcbf"
     },
@@ -81,7 +95,7 @@
                 "type:health-theme",
                 "type:drupal-theme"
             ],
-            "themes/health/apps/{$name}/": [
+            "apps/{$name}/": [
                 "type:health-app-default",
                 "type:health-app-react",
                 "type:health-app-angular"

cypress/integration/modules/app_or_tool_hosted.js

@@ -14,15 +14,9 @@
     it("renders correctly", () => {
       // Take a snapshot for visual diffing.
       const percyOptions = {};
-      cy.visit(landingPageUri);
-      cy.get('.ButtonPanel_component-button-panel__3doTu button').contains('7').click();
-      cy.get('.ButtonPanel_component-button-panel__3doTu button').contains('x').click();
-      cy.get('.ButtonPanel_component-button-panel__3doTu button').contains('9').click();
-      cy.get('.ButtonPanel_component-button-panel__3doTu button').contains('=').click();
-      cy.get('.Display_component-display__T1qck div').should('contain', 63)
-      .then(() => {
-        cy.percySnapshot("health_starter_kit_sample_app_or_tool_content_page_hosted", percyOptions);
-      });
+      cy
+        .visit(landingPageUri)
+        .percySnapshot("health_starter_kit_sample_app_or_tool_content_page_hosted", percyOptions);
     });
   });
 }

phpcs.xml

@@ -3,7 +3,7 @@
   <description>PHP CodeSniffer configuration for Drupal coding standards.</description>
   <file>./dev_modules/custom</file>
   <file>./themes/health</file>
-  <exclude-pattern>./themes/*/app/*</exclude-pattern>
+  <exclude-pattern>./themes/*/apps/*</exclude-pattern>
   <exclude-pattern>./scripts/*</exclude-pattern>
   <arg name="extensions" value="php,module,inc,install,test,profile,theme,yml" />
   <config name="drupal_core_version" value="8" />