Scala3doc: Add build step for FE resources

.github/workflows/scala3doc.yaml

@@ -53,6 +53,17 @@ jobs:
 
       - name: Generate testcases documentation
         run: ./project/scripts/sbt scala3doc/generateTestcasesDocumentation
+
+      - name: Install node
+        uses: actions/setup-node@v2-beta
+        with:
+          node-version: 12
+          check-latest: true
+
+      - name: Run e2e tests
+        run: |
+          npm --prefix ./scala3doc/e2e ci
+          npm --prefix ./scala3doc/e2e run ci
 
       - name: Generate Scala 3 documentation
         run: ./project/scripts/sbt scala3doc/generateScala3Documentation

project/Build.scala

@@ -1470,6 +1470,10 @@ object Build {
 
     def asScala3doc: Project = {
       def generateDocumentation(targets: String, name: String, outDir: String, ref: String, params: String = "") = Def.taskDyn {
+          val frontEndDir = baseDirectory.value / "resources"
+          runProcess(Seq("npm", "install"), wait = true, directory = Some(frontEndDir))
+          runProcess(Seq("npm", "run", "build"), wait = true, directory = Some(frontEndDir))
+
           val projectVersion = version.value
           val sourcesAndRevision = s"-s github://lampepfl/dotty  --revision $ref --projectVersion $projectVersion"
           val cmd = s""" -d $outDir -t $targets -n "$name" $sourcesAndRevision $params"""

scala3doc/.gitignore

@@ -1,2 +1,8 @@
 # root where we generate documentation
-output
+output
+
+# generated resources
+resources/dotty_res/scripts/bundle.js
+resources/dotty_res/styles/main.css
+
+e2e/cypress/videos

scala3doc/README.md

@@ -38,6 +38,18 @@ respectively.
 It's not strictly necessary to go through an HTTP server, but because of CORS
 the documentation won't work completely if you don't.
 
+## Building frontend
+
+Make sure you have installed `node`
+
+Frontend resources should be built automatically after running any `sbt` task that uses
+`generateDocumentation`, such as `sbt scala3/generateTestcasesDocumentation`
+
+You can also do it manually by running `npm i` and `npm run build`in the `resources` folder.
+To see the changes you still need to copy sources to `output` folder, this is normally done automatically by the `sbt` task.
+
+You might want to turn on sourcemaps for local development.
+
 ## CLI Documentation
 
 CLI command for running our tool is in form: `sbt main -n <name> -o <output> -t <tasty-files> -cp <classpath> -s { <sources> } -d <documentation> ` where:

scala3doc/e2e/README.md

@@ -5,8 +5,8 @@
 - install Node.js
 - run `npm i`
 
-### Running tests
+### Running tests locally
 
 - generate the test docs: `sbt scala3doc/generateTestcasesDocumentation`
-- run the web server in the `output` directory: `python3 -m http.server 8080`
-- run `npm run cypress:open` to see the cypress UI or `npm run cypress:run` to run tests heedlessly
+- run the web server: `npm run serve`
+- run `npm run cypress:open` to see the cypress UI or `npm run cypress:run` to run tests headlessly

scala3doc/e2e/cypress.json

@@ -1 +1,3 @@
-{}
+{
+  "video": false
+}

scala3doc/e2e/cypress/integration/filter-bar.spec.ts

@@ -7,6 +7,7 @@ describe('filter-bar', () => {
     const testTable: TestTable = [
       ['Visibility', ['public', 'protected']],
       ['Keywords', ['no keywords', 'abstract', 'case', 'final', 'sealed']],
+      ['Inherited', ['Not inherited', 'FilterTestBase', 'FilterTestBaseTrait']],
       ['Extension', ['Standard member', 'from tests']],
     ];
 
@@ -32,6 +33,7 @@ describe('filter-bar', () => {
     const testTable: TestTable = [
       ['Visibility', ['public', 'protected']],
       ['Keywords', ['no keywords']],
+      ['Inherited', ['Not inherited', 'FilterTestBase']],
       ['Extension', ['Standard member']],
     ];
 
@@ -71,7 +73,7 @@ describe('filter-bar', () => {
       });
 
       it(`'Standard member'`, () => {
-        new FilterBarFixture().toggle().group(2).toggleFilter('Standard member');
+        new FilterBarFixture().toggle().group(3).toggleFilter('Standard member');
 
         new TabsFixture().definitionTypes.should('not.be.visible');
       });
@@ -91,8 +93,17 @@ describe('filter-bar', () => {
         new TabsFixture().definitionTypes.should('not.be.visible');
       });
 
+      it('all inherited options', () => {
+        new FilterBarFixture()
+          .toggle()
+          .group(2)
+          .toggleFilter('Not inherited', 'FilterTestBase', 'FilterTestBaseTrait');
+
+        new TabsFixture().definitionTypes.should('not.be.visible');
+      });
+
       it('all extension options', () => {
-        new FilterBarFixture().toggle().group(2).toggleFilter('Standard member', 'from tests');
+        new FilterBarFixture().toggle().group(3).toggleFilter('Standard member', 'from tests');
 
         new TabsFixture().definitionTypes.should('not.be.visible');
       });
@@ -288,7 +299,7 @@ class BatchSelectionFixture {
 }
 
 function openPage() {
-  cy.visit('http://localhost:8080/testcases/api/tests/-filter-test/index.html');
+  cy.visit('http://localhost:8080/testcases/-scala3doc%20testcases/tests/-filter-test/index.html');
 }
 
 type TestTable = [string, string[]][];