chore: Establish root package.json file (#1192)

niallthomson · web-flow · commit f6e31d6b7f0f · 2024-12-10T16:36:17.000-07:00
diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
@@ -18,7 +18,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - name: Get kubectl version
         run: |
           source hack/lib/kubectl-version.sh
@@ -29,11 +29,10 @@ jobs:
           version: "${{ env.KUBECTL_VERSION }}"
         id: install
       - name: Run website build
-        working-directory: website
         run: |
           export LAB_TIMES_ENABLED='true'
-          npm install
-          npm run build
+          yarn install
+          yarn workspace website build
 
   build-lab:
     name: "Build lab"
@@ -52,27 +51,22 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
       - uses: actions/setup-python@v5
       - name: Setup TFLint
         uses: terraform-linters/setup-tflint@v4
       - name: Setup terraform-docs
         uses: jaxxstorm/action-install-gh-release@v1.12.0
         with:
           repo: terraform-docs/terraform-docs
+      - name: Yarn install
+        run: |
+          yarn install
       - uses: pre-commit/action@v3.0.1
 
-  spell-check:
-    name: "Spell checker"
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 18
-      - run: |
-          npx cspell lint "website/docs/**/*.md"
-
   terraform-validate:
     name: "Validate Terraform"
     runs-on: ubuntu-latest
diff --git a/.github/workflows/publish-content.yaml b/.github/workflows/publish-content.yaml
@@ -20,7 +20,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - name: Get kubectl version
         run: |
           source hack/lib/kubectl-version.sh
diff --git a/.github/workflows/publish-snapshot.yaml b/.github/workflows/publish-snapshot.yaml
@@ -20,7 +20,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - name: Get kubectl version
         run: |
           source hack/lib/kubectl-version.sh
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -21,7 +21,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - name: Release
         working-directory: releaser
         env:
diff --git a/.gitignore b/.gitignore
@@ -36,4 +36,15 @@ cdk.out
 node_modules
 test-output
 
-terraform-resources
+terraform-resources
+
+website/package-lock.json
+
+# Yarn files
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,37 +3,11 @@ repos:
     rev: v1.77.0
     hooks:
       - id: terraform_fmt
-      #- id: terraform_validate
-      - id: terraform_docs
-        args:
-          - "--args=--lockfile=false"
-      - id: terraform_tflint
-        args:
-          - "--args=--only=terraform_deprecated_interpolation"
-          - "--args=--only=terraform_deprecated_index"
-          - "--args=--only=terraform_unused_declarations"
-          - "--args=--only=terraform_comment_syntax"
-          - "--args=--only=terraform_documented_outputs"
-          - "--args=--only=terraform_documented_variables"
-          - "--args=--only=terraform_typed_variables"
-          - "--args=--only=terraform_module_pinned_source"
-          - "--args=--only=terraform_naming_convention"
-          - "--args=--only=terraform_workspace_remote"
 
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v3.1.0"
+  - repo: local
     hooks:
-      - id: prettier
-
-  - repo: https://github.com/tcort/markdown-link-check
-    rev: "v3.12.1"
-    hooks:
-      - id: markdown-link-check
-        args: [-q, -c, link-check-config.json]
-
-  - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.41.0
-    hooks:
-      - id: markdownlint
-        files: ^website/docs
-        args: [-r, mdlint/aws-arn-rule.js]
+      - id: lint
+        language: node
+        name: Run linting
+        entry: yarn lint:staged
+        stage: [commit]
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1 @@
+{}
diff --git a/.yarn/releases/yarn-4.5.3.cjs b/.yarn/releases/yarn-4.5.3.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.5.3.cjs
diff --git a/Makefile b/Makefile
@@ -7,11 +7,11 @@ glob='-'
 
 .PHONY: install
 install:
-	cd website; npm install
+	yarn install
 
 .PHONY: serve
 serve: install
-	bash hack/serve.sh
+	yarn serve
 
 .PHONY: tf-fmt
 tf-fmt:
@@ -40,3 +40,7 @@ create-infrastructure:
 .PHONY: destroy-infrastructure
 destroy-infrastructure:
 	bash hack/destroy-infrastructure.sh $(environment)
+
+.PHONY: lint
+lint:
+	yarn lint
diff --git a/docs/authoring_content.md b/docs/authoring_content.md
@@ -2,8 +2,6 @@
 
 This guide outlines how to author content for the workshop, whether adding new content or modifying existing content.
 
-<!-- toc -->
-
 1. [Pre-requisites](#pre-requisites)
 1. [Create a work branch](#create-a-work-branch)
 1. [Environment setup](#environment-setup)
@@ -13,7 +11,6 @@ This guide outlines how to author content for the workshop, whether adding new c
 1. [Cleaning up your lab](#cleaning-up-your-lab)
 1. [Testing](#testing)
 1. [Tear down AWS resources](#raising-a-pull-request)
-<!-- tocstop -->
 
 ## Pre-requisites
 
@@ -24,7 +21,7 @@ The following pre-requisites are necessary to work on the content:
   - Docker
   - `make`
   - `jq`
-  - `npm`
+  - Node.js + `yarn`
   - `kubectl`
 
 ## Create a work branch
@@ -42,13 +39,13 @@ To start developing you'll need to run some initial commands.
 
 First install the dependencies by running the following command in the root of the repository.
 
-```
+```bash
 make install
 ```
 
 Once this is complete you can run the following command to start the development server:
 
-```
+```bash
 make serve
 ```
 
@@ -76,13 +73,13 @@ Many of the convenience scripts we'll use will make calls to AWS APIs so will ne
 
 You can then use the following convenience command to create the infrastructure:
 
-```
+```bash
 make create-infrastructure
 ```
 
 Once you're finished with the test environment you can delete all of the infrastructure using the following convenience command:
 
-```
+```bash
 make destroy-infrastructure
 ```
 
@@ -231,6 +228,18 @@ There is an automated testing capability provided with the workshop that allows
 
 See this [doc](./automated_tests.md) for more information on automated tests.
 
+## Before your Pull Request
+
+The last step is to ensure that your submission passes all of the linting checks. These are in place to keep the codebase consistent and avoid issues such as basic spelling mistakes.
+
+```bash
+make lint
+```
+
+If you need to add a new word to the dictionary see the file `.spelling`.
+
+You can resolve prettier formatting problems using `yarn format:fix`.
+
 ## Raising a Pull Request
 
 Once your content is completed and is tested appropriately please raise a Pull Request to the `main` branch. This will trigger review processes before the content is merged. All status checks must pass before the PR will be merged, if a check fails then please check the error and attempt to resolve it. If you need assistance then leave a comment on the PR.
diff --git a/hack/lib/common-env.sh b/hack/lib/common-env.sh
@@ -21,4 +21,6 @@ if [ -z "$SKIP_CREDENTIALS" ]; then
 
   IDE_ROLE_NAME="${EKS_CLUSTER_NAME}-ide-role"
   IDE_ROLE_ARN="arn:aws:iam::${ACCOUNT_ID}:role/${IDE_ROLE_NAME}"
-fi
+fi
+
+export DOCKER_CLI_HINTS="false"
diff --git a/hack/publish-content.sh b/hack/publish-content.sh
@@ -4,14 +4,16 @@ set -e
 
 SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 
-cd $SCRIPT_DIR/../website
+cd $SCRIPT_DIR/..
 
 export ENABLE_INDEX="1"
 export MANIFESTS_REF="$BRANCH"
 
-npm install
-npm run clear
-npm run build
+yarn install
+yarn workspace website clear
+yarn workspace website build
+
+cd website
 
 aws s3 sync build/ s3://${CONTENT_BUCKET} --delete
 
diff --git a/hack/publish-snapshot.sh b/hack/publish-snapshot.sh
@@ -4,16 +4,18 @@ set -e
 
 SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 
-cd $SCRIPT_DIR/../website
+cd $SCRIPT_DIR/..
 
 export MANIFESTS_REF="$BRANCH"
 export SNAPSHOT="${BRANCH#snapshot-}"
 export BASE_URL="$SNAPSHOT"
 export LAB_TIMES_ENABLED='true'
 
-npm install
-npm run clear
-npm run build
+yarn install
+yarn workspace website clear
+yarn workspace website build
+
+cd website
 
 aws s3 cp --recursive build/ s3://${SNAPSHOT_BUCKET}/${SNAPSHOT}
 
diff --git a/hack/serve.sh b/hack/serve.sh
diff --git a/netlify.toml b/netlify.toml
@@ -1,9 +1,7 @@
 [build]
-  base = "website"
+  publish = "website/build"
 
-  publish = "build"
-
-  command = "bash netlify-build.sh"
+  command = "bash website/netlify-build.sh"
 
   environment = { NODE_VERSION = "18.13.0" }
 
diff --git a/package.json b/package.json
@@ -0,0 +1,46 @@
+{
+  "name": "eks-workshop",
+  "version": "1.0.0",
+  "description": "EKS Workshop",
+  "main": "index.js",
+  "private": true,
+  "workspaces": [
+    "website"
+  ],
+  "scripts": {
+    "serve": "yarn workspace website serve",
+    "spelling:check": "yarn cspell 'website/docs/**/*.md'",
+    "links:check": "markdown-link-check -q -c link-check-config.json website/docs/**/*.md",
+    "format:check": "prettier -c .",
+    "format:fix": "prettier -w .",
+    "markdown:check": "markdownlint-cli2 'website/docs/**/*.md'",
+    "lint": "yarn links:check && yarn format:check && yarn markdown:check && yarn spelling:check",
+    "lint:staged": "yarn lint-staged"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "cspell": "^8.8.1",
+    "lint-staged": "^15.2.7",
+    "markdown-link-check": "3.12.2",
+    "markdownlint-cli2": "^0.16.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^3.2.5",
+    "prettier-plugin-sh": "^0.14.0"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": [
+      "prettier --write"
+    ],
+    "*.{json,yaml}": [
+      "prettier --write"
+    ],
+    "*.md": [
+      "prettier --write",
+      "cspell",
+      "markdown-link-check -q -c link-check-config.json",
+      "markdownlint-cli2"
+    ]
+  },
+  "packageManager": "yarn@4.5.3"
+}
diff --git a/website/netlify-build.sh b/website/netlify-build.sh
@@ -2,7 +2,7 @@
 
 set -e
 
-source ../hack/lib/kubectl-version.sh
+source ./hack/lib/kubectl-version.sh
 
 wget -q https://dl.k8s.io/release/$KUBECTL_VERSION/bin/linux/amd64/kubectl
 chmod +x ./kubectl
@@ -18,6 +18,6 @@ if [[ $BRANCH = build-* ]]; then
   export LAB_TIMES_ENABLED='true'
 fi
 
-npm install
-npm run clear
-npm run build
+yarn install
+yarn workspace website clear
+yarn workspace website build
diff --git a/website/package-lock.json b/website/package-lock.json
diff --git a/website/package.json b/website/package.json
diff --git a/website/src/theme/DocSidebarItem/Category/index.js b/website/src/theme/DocSidebarItem/Category/index.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+nodeLinker: node-modules`
	`2`	`+`
	`3`	`+yarnPath: .yarn/releases/yarn-4.5.3.cjs`