Move config, lib, tasks into shared directory

.github/workflows/actions/install-node/action.yml

@@ -16,6 +16,7 @@ runs:
           app/node_modules
           docs/examples/*/node_modules
           package/node_modules
+          shared/*/node_modules
 
     - name: Setup Node.js
       uses: ./.github/workflows/actions/setup-node

app/tsconfig.json

@@ -1,5 +1,11 @@
 {
   "extends": "../tsconfig.base.json",
-  "include": ["**/*.js", "**/*.mjs", "../config", "../lib", "../tasks"],
+  "include": [
+    "**/*.js",
+    "**/*.mjs",
+    "../shared/config",
+    "../shared/lib",
+    "../shared/tasks"
+  ],
   "exclude": ["./dist/**"]
 }

docs/contributing/application-architecture.md

@@ -8,10 +8,6 @@
 
   Binary/executable files (i.e. bash scripts) mainly used in the [publishing process](/docs/releasing/publishing.md).
 
-- `config/`
-
-  Configuration files for the review app and [Jest](https://github.com/facebook/jest).
-
 - `dist/` **contains auto-generated files**
 
   Standalone builds of govuk-frontend. Provides a way to consume govuk-frontend without using npm.
@@ -20,19 +16,25 @@
 
   Documentation files.
 
-- `lib/`
-
-  Application modules and helpers.
-
 - `package/` **contains auto-generated files**
 
   package published on npm.
   Consume all of govuk-frontend through a single package.
 
-- `src/`
+- `shared/`
 
-  Source files. See README.md in the src directory for details.
+  - `config/`
+
+    Configuration files for the review app and [Jest](https://github.com/facebook/jest).
 
-- `tasks/`
+  - `lib/`
 
-  Application modules and helpers. See [tasks](tasks.md) for more information about the tasks.
+    Application modules and helpers.
+
+  - `tasks/`
+
+    See [tasks](tasks.md) for more information about the tasks.
+
+- `src/`
+
+  Source files. See README.md in the src directory for details.

docs/contributing/tasks.md

@@ -53,7 +53,7 @@ npm scripts are defined in `package.json`. These trigger a number of Gulp tasks.
 
 ## Gulp tasks
 
-Project Gulp tasks are defined in [`gulpfile.mjs`](../../gulpfile.mjs) and the [`tasks/`](../../tasks) folder.
+Project Gulp tasks are defined in [`gulpfile.mjs`](../../gulpfile.mjs) and the [`tasks/`](../../shared/tasks) folder.
 
 **`gulp --tasks`**
 

package.json

@@ -9,11 +9,9 @@
   "license": "MIT",
   "workspaces": [
     "app",
-    "config",
     "docs/examples/*",
-    "lib",
     "package",
-    "tasks"
+    "shared/*"
   ],
   "scripts": {
     "postinstall": "npm ls --depth=0",

package.json.unit.test.js

@@ -1,5 +1,5 @@
 const packageLockJson = require('./package-lock.json')
-const packageJson = require('./tasks/package.json')
+const packageJson = require('./shared/tasks/package.json')
 
 describe('because rollup 0.60 drops support for Internet Explorer 8', () => {
   describe('rollup', () => {

config/jest/server/start.mjs → shared/config/jest/server/start.mjs

@@ -1,6 +1,6 @@
 import { setup } from 'jest-dev-server'
 
-import config from '../../../jest-dev-server.config.js'
+import config from '../../../../jest-dev-server.config.js'
 
 // Start web server(s)
 export default async () => {

config/paths.js → shared/config/paths.js

@@ -1,7 +1,7 @@
-const { dirname, join } = require('path')
+const { join, resolve } = require('path')
 
 // Repository root directory
-const rootPath = dirname(__dirname)
+const rootPath = resolve(__dirname, '../../')
 
 /**
  * Config paths

config/tsconfig.json → shared/config/tsconfig.json

@@ -1,4 +1,4 @@
 {
-  "extends": "../tsconfig.base.json",
+  "extends": "../../tsconfig.base.json",
   "include": ["**/*.js", "**/*.mjs"]
 }

shared/lib/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["**/*.js", "**/*.mjs", "../config"],
+  "compilerOptions": {
+    "lib": ["ESNext", "DOM"]
+  }
+}

tasks/tsconfig.json → shared/tasks/tsconfig.json

@@ -1,4 +1,4 @@
 {
-  "extends": "../tsconfig.base.json",
+  "extends": "../../tsconfig.base.json",
   "include": ["**/*.js", "**/*.mjs", "../config", "../lib"]
 }

src/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "extends": "../tsconfig.base.json",
-  "include": ["**/*.js", "**/*.mjs", "../config", "../lib"],
+  "include": ["**/*.js", "**/*.mjs", "../shared/config", "../shared/lib"],
   "compilerOptions": {
     "lib": ["ESNext", "DOM"],
     "target": "ES2015",

tsconfig.json

@@ -6,16 +6,16 @@
       "path": "./app"
     },
     {
-      "path": "./config"
+      "path": "./shared/config"
     },
     {
-      "path": "./lib"
+      "path": "./shared/lib"
     },
     {
-      "path": "./src"
+      "path": "./shared/tasks"
     },
     {
-      "path": "./tasks"
+      "path": "./src"
     }
   ]
 }