feat: add format script + optional git hooks

.gitignore

@@ -1,5 +1,5 @@
 node_modules
-.husky
+.husky/_
 .idea
 .vscode
 .zed

.husky/commit-msg

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+pnpm exec commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+pnpm exec lint-staged

.prettierignore

@@ -21,9 +21,5 @@ logs
 .idea
 
 CHANGELOG.md
+CHANGELOG
 .husky
-
-
-controlplane/migrations
-
-composition/tests/unstaged-tests

CONTRIBUTING.md

@@ -65,8 +65,8 @@ use (
 
 We use [conventionalcommits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#why-use-conventional-commits) for changelog generation and more structured commit messages.
 
-In order to enforce this standard we use a linter on pre-commit hook. This functionality is provided by [husky](https://typicode.github.io/husky/#/).
-In some setup, you have to tell husky where to find your package manager or binaries. Here is the file `.huskyrc` you have to put in your user home directory.
+If you want to enforce this standard, you can set up a pre-commit hook. This functionality is provided by [husky](https://typicode.github.io/husky/#/). Run `pnpm husky` to install pre-commit hooks which format code and check commit message format.
+In some setup, you have to tell husky where to find your package manager or binaries. Here is the file `husky.sh` which you should put in your home's configuration directory (`~/.config/husky/husky.sh`).
 
 ```bash
 export NVM_DIR=/home/starptech/.nvm
@@ -170,29 +170,36 @@ We manage multiple compose files:
 We use Codecov for code coverage. Code coverage is used for both PRs and also our default branch main.
 
 #### Workaround for uploading to main
+
 Codecov relies on commit hashes to map code to Codecov reports, however unfortunately we use "Squash Merge", which means that the HEAD of any merged PR is never present on main post-merge, leading to no code coverage uploaded for main (which is used as a base for comparisons).
 
 In order to circumvent this we do the following steps:
-* Upload Codecov reports from PR runs to GitHub as artifacts for the PR's HEAD commit
-* Upon merge we find the PR and it's HEAD commit using the GitHub rest API
-* We find the github artifact from this commit hash
-* We then upload it again, but this time it acts as if it was uploaded from main
+
+- Upload Codecov reports from PR runs to GitHub as artifacts for the PR's HEAD commit
+- Upon merge we find the PR and it's HEAD commit using the GitHub rest API
+- We find the github artifact from this commit hash
+- We then upload it again, but this time it acts as if it was uploaded from main
 
 #### Adding new projects
+
 When you add a new project (i.e. a subfolder in the cosmo repository root), if you wish to add code coverage for it you can follow these steps:
 
-* Add a flag in the codecov.yaml for your project with the folder name, this is important so coverage does not get overwritten (for example if a router pr gets merged, cli coverage won't be set to empty for that commit)
+- Add a flag in the codecov.yaml for your project with the folder name, this is important so coverage does not get overwritten (for example if a router pr gets merged, cli coverage won't be set to empty for that commit)
+
 ```yaml
 flags:
   router:
     paths:
       - router
     carryforward: true
 ```
-* You should be running tests in ci for your project via a GH Workflow, You need to add the GH Workflow name to `codecov-post-merge.yaml`, the line you are looking for will look something like this
+
+- You should be running tests in ci for your project via a GH Workflow, You need to add the GH Workflow name to `codecov-post-merge.yaml`, the line you are looking for will look something like this
+
 ```yaml
 workflow-paths: .github/workflows/cli-ci.yaml,.github/workflows/router-ci.yaml,
 ```
+
 Ensure you add the full relative path from the cosmo repository root and it is comma-separated, e.g.: for graphqlmetrics `,.github/workflows/graphqlmetrics-ci.yaml`
 
 **Clean up a compose stack before starting another one!**

Makefile

@@ -52,6 +52,24 @@ infra-debug-down-v:
 infra-debug-up:
 	docker compose -f docker-compose.yml --profile debug up --remove-orphans --detach
 
+format-all:
+	pnpm -r --parallel format
+
+format:
+	@package="$(word 2,$(MAKECMDGOALS))"; \
+	if [ -z "$$package" ]; then \
+		echo "Usage: make format <package>"; \
+		exit 1; \
+	fi; \
+	pnpm --filter "./$$package" --fail-if-no-match run format
+
+ifneq ($(filter format,$(MAKECMDGOALS)),)
+FORMAT_ARGS := $(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
+.PHONY: $(FORMAT_ARGS)
+$(FORMAT_ARGS):
+	@:
+endif
+
 seed:
 	pnpm -r run --filter './controlplane' seed
 

admission-server/package.json

@@ -6,7 +6,8 @@
   ],
   "scripts": {
     "dev": "tsx watch src/index.ts",
-    "build": "rm -rf dist && tsc"
+    "build": "rm -rf dist && tsc",
+    "format": "prettier -w -c ."
   },
   "dependencies": {
     "@hono/node-server": "1.13.7",
@@ -19,4 +20,4 @@
     "tsx": "^4.16.0",
     "typescript": "^5.3.2"
   }
-}
+}

aws-lambda-router/package.json

@@ -11,6 +11,9 @@
     "aws-lambda",
     "serverless"
   ],
+  "scripts": {
+    "format": "go fmt ./..."
+  },
   "author": {
     "name": "WunderGraph Maintainers",
     "email": "info@wundergraph.com"

cdn-server/.prettierignore

@@ -0,0 +1 @@
+CHANGELOG.md

cdn-server/package.json

@@ -19,7 +19,7 @@
     "build": "rm -rf dist && tsc",
     "start": "tsx src/index.ts",
     "lint": "eslint --cache && prettier -c src",
-    "format:fix": "prettier --write -c src",
+    "format": "prettier -w -c .",
     "postversion": "name=$(jq -r .name package.json); version=$(jq -r .version package.json); gh workflow run image-release.yml -F name=$name -F workingDirectory=cdn-server -F tag=$version -F dockerContext=."
   },
   "dependencies": {
@@ -36,4 +36,4 @@
     "tsx": "^4.16.0",
     "typescript": "5.5.2"
   }
-}
+}

cli/.prettierignore

@@ -0,0 +1 @@
+CHANGELOG.md

cli/package.json

@@ -28,7 +28,8 @@
     "test": "pnpm lint && vitest run test/",
     "coverage": "vitest run test/ --coverage",
     "lint": "eslint --cache --ext .ts,.mjs,.cjs . && prettier -c src",
-    "lint:fix": "eslint --cache --fix --ext .ts,.mjs,.cjs . && prettier --write -c src",
+    "lint:fix": "eslint --cache --fix --ext .ts,.mjs,.cjs . && pnpm format",
+    "format": "prettier -w -c .",
     "e2e": "bun test e2e/"
   },
   "keywords": [
@@ -109,4 +110,4 @@
     "vitest": "3.2.4"
   },
   "gitHead": "c37aed755e1b19ed91d30f9b5f7041e15c56901a"
-}
+}

client-tests/apollo-js/package.json

@@ -4,6 +4,7 @@
   "description": "Apollo Client tests for GraphQL",
   "main": "index.js",
   "scripts": {
+    "format": "prettier -w .",
     "test": "vitest run",
     "test:watch": "vitest watch",
     "test:coverage": "vitest run --coverage"

composition/.prettierignore

@@ -0,0 +1,3 @@
+tests/unstaged-tests
+coverage/
+CHANGELOG.md

composition/README.md

@@ -2,7 +2,7 @@
 
 [![npm version](https://badge.fury.io/js/%40wundergraph%2Fcomposition.svg)](https://badge.fury.io/js/%40wundergraph%2Fcomposition)
 
-The WunderGraph composition library facilitates the federation of multiple subgraph schemas into a 
+The WunderGraph composition library facilitates the federation of multiple subgraph schemas into a
 single federated GraphQL schema.
 
 ### Prerequisites
@@ -53,29 +53,31 @@ const subgraphB: Subgraph = {
 
 ### FederationResult
 
-The `federateSubgraphs` function returns `FederationResult`, which is a union of `FederationResultSuccess` and 
+The `federateSubgraphs` function returns `FederationResult`, which is a union of `FederationResultSuccess` and
 `FederationResultFailure`. Both types in the union always define the following mutual properties:
 
 | property | Description                            | type           |
-|----------|----------------------------------------|----------------|
+| -------- | -------------------------------------- | -------------- |
 | success  | assertion of composition success       | boolean        |
 | warnings | array of composition warnings (if any) | Array<Warning> |
 
 #### FederationResultSuccess
+
 If federation was successful, the return type is `FederationResultSuccess`.
 
-| property             | Description                                                 | type                  |
-|----------------------|-------------------------------------------------------------|-----------------------|
-| federatedGraphAST    | an AST object representation of the federated graph sdl     | graphql.DocumentNode  |
-| federatedGraphSchema | a schema object representation of the federated graph sdl   | graphql.GraphQLSchema |
-| success              | assertion that composition was successful                   | true                  |
-| warnings             | array of composition warnings (if any)                      | Array<Warning>        |
+| property             | Description                                               | type                  |
+| -------------------- | --------------------------------------------------------- | --------------------- |
+| federatedGraphAST    | an AST object representation of the federated graph sdl   | graphql.DocumentNode  |
+| federatedGraphSchema | a schema object representation of the federated graph sdl | graphql.GraphQLSchema |
+| success              | assertion that composition was successful                 | true                  |
+| warnings             | array of composition warnings (if any)                    | Array<Warning>        |
 
 #### FederationResultFailure
+
 If federation was unsuccessful, the return type is `FederationResultFailure`.
 
 | property | Description                                 | type           |
-|----------|---------------------------------------------|----------------|
+| -------- | ------------------------------------------- | -------------- |
 | errors   | array of composition errors                 | Array<Error>   |
 | success  | assertion that composition was unsuccessful | false          |
 | warnings | array of composition warnings (if any)      | Array<Warning> |
@@ -112,9 +114,10 @@ for (const warning of result.warnings) {
 ### Errors
 
 Errors can happen in three main stages:
+
 1. While validating the subgraph metadata, e.g., validating that each `Subgraph` object has a unique name.
 2. During the normalization process, which prepares the subgraph for federation.
-(if this stage fails, federation will not be attempted)
+   (if this stage fails, federation will not be attempted)
 3. During the federation process itself.
 
 All errors will be appended to the `FederationResultFailure.errors` array.
@@ -127,7 +130,7 @@ This is easily achieved by passing string representation of the subgraph SDL to
 An example is shown below:
 
 ```typescript
-import { Subgraph } from '@wundergraph/composition'
+import { Subgraph } from '@wundergraph/composition';
 import { parse } from 'graphql';
 
 const subgraphA: Subgraph = {
@@ -148,13 +151,15 @@ const subgraphA: Subgraph = {
 ### Subgraph Properties
 
 | property    | Description                               | type                 |
-|-------------|-------------------------------------------|----------------------|
+| ----------- | ----------------------------------------- | -------------------- |
 | name        | unique name of the subgraph               | string               |
 | url         | unique endpoint for the subgraph          | string               |
 | definitions | an AST representation of the subgraph SDL | graphql.DocumentNode |
 
 ### Contributing
+
 When adding or changing error, please ensure GraphQL types begin with a capital letter for clarity:
+
 - Enum
 - Input Object
 - Interface

composition/package.json

@@ -19,8 +19,9 @@
     "test": "vitest run",
     "test:core": "vitest run --exclude ./tests/unstaged-tests",
     "test:coverage": "vitest run --coverage",
-    "lint": "prettier --check src tests",
-    "lint:fix": "prettier --write src tests",
+    "lint": "prettier --check .",
+    "lint:fix": "pnpm format",
+    "format": "prettier -w -c .",
     "postversion": "node ./scripts/get-composition-version.mjs"
   },
   "main": "./dist/index.js",

composition/tsconfig.json

@@ -4,7 +4,7 @@
     "declaration": true,
     "outDir": "./dist",
     "module": "NodeNext",
-    "moduleResolution": "NodeNext",
+    "moduleResolution": "NodeNext"
   },
   "include": ["src/**/*"],
   "exclude": ["node_modules"]

composition/vite.config.ts

@@ -5,4 +5,4 @@ export default defineConfig({
     // Ensure always the CJS version is used otherwise we might conflict with multiple versions of graphql
     alias: [{ find: /^graphql$/, replacement: 'graphql/index.js' }],
   },
-});
+});

controlplane/.prettierignore

@@ -0,0 +1,3 @@
+migrations/
+src/templates/emails/
+CHANGELOG.md

controlplane/README.md

@@ -75,4 +75,4 @@ A user session "cookie" is valid for 1 day. The refresh token has the same lifes
 That implies that the user can interact with the app for 1 day until the refresh token is expired. The user can renew the session by calling the session endpoint `/v1/auth/session`.
 The session endpoint will refresh the access and refresh token and update the session cookie. The user can interact with the app for another day.
 
-__Summary: If the frontend ensure that the session endpoint `/v1/auth/session` is called on focus and load. The user might never be logged out again.__
+**Summary: If the frontend ensure that the session endpoint `/v1/auth/session` is called on focus and load. The user might never be logged out again.**

controlplane/emails/package.json

@@ -6,7 +6,9 @@
   "type": "module",
   "scripts": {
     "dev": "email dev --dir src --port 3400",
-    "build": "email export --dir src --outDir ../src/templates/emails --pretty && pnpm run --filter ../ lint:fix"
+    "build": "email export --dir src --outDir ../src/templates/emails --pretty && pnpm run --filter ../ lint:fix",
+    "format": "prettier -w .",
+    "lint:fix": "eslint --cache --fix --ext .ts,.mjs,.cjs . && pnpm format"
   },
   "author": {
     "name": "WunderGraph Maintainers",

controlplane/emails/src/components/cosmo-logo.tsx

@@ -7,13 +7,8 @@ export function CosmoLogo() {
       href="https://wundergraph.com/"
       className="flex items-center space-x-2 font-bold text-slate-800 no-underline w-full"
     >
-      <Img
-        alt="WunderGraph"
-        src="https://wundergraph.com/images/logos/wundergraph-light.png"
-        width="45"
-        height="45"
-      />
+      <Img alt="WunderGraph" src="https://wundergraph.com/images/logos/wundergraph-light.png" width="45" height="45" />
       WunderGraph
     </Link>
   );
-}
+}

controlplane/emails/src/components/main-container.tsx

@@ -12,4 +12,4 @@ export function MainContainer({ children }: React.PropsWithChildren) {
       {children}
     </Container>
   );
-}
+}

controlplane/emails/src/components/tailwind-config.tsx

@@ -1,5 +1,5 @@
 import React from 'react';
-import { Tailwind, } from '@react-email/components';
+import { Tailwind } from '@react-email/components';
 
 export function TailwindConfig({ children }: React.PropsWithChildren) {
   return (
@@ -9,12 +9,12 @@ export function TailwindConfig({ children }: React.PropsWithChildren) {
           extend: {
             colors: {
               brand: '#ea4899',
-            }
-          }
-        }
+            },
+          },
+        },
       }}
     >
       {children}
     </Tailwind>
   );
-}
+}