chore(test): add code formatting and linting tests

* chore(prettier): fix /drupal path in .prettierignore
* test: add code formatting and linting tests
* chore(test): use Drupal code formatting standards in modules
* chore(prettier): fix prettier formatting issues
* chore(eslint): fix eslint issues
* fix(www): fix TypeScript error
* chore(prettier): upgrade prettier to v3

Fixes #573

.eslintignore

@@ -3,4 +3,4 @@ dist
 public
 node_modules
 *.esm.js
-drupal
+/drupal

.eslintrc.json

@@ -19,6 +19,11 @@
     "node": true,
     "jest": true
   },
+  "globals": {
+    "Drupal": true,
+    "drupalSettings": true,
+    "jQuery": true
+  },
   "rules": {
     "react/prop-types": 0,
     "prettier/prettier": ["error"],

.github/pull_request_template.md

@@ -1,4 +1,5 @@
 This pull request is for: (mark with an "x")
+
 - [ ] `examples/*`
 - [ ] `modules/next`
 - [ ] `packages/next-drupal`
@@ -11,8 +12,8 @@ _Please add a link to the GitHub issue
 where this problem is discussed._
 
 - [ ] I need help adding tests. (mark with an "x")
-  _Code changes need test coverage. If you don't know
-  how to make tests, check this box to ask for help._
+      _Code changes need test coverage. If you don't know
+      how to make tests, check this box to ask for help._
 
 ## Describe your changes
 

.github/version-pr/action.yml

@@ -4,5 +4,5 @@ outputs:
   version:
     description: "npm package version"
 runs:
-  using: "node16"
+  using: node20
   main: "index.js"

.github/workflows/release-pr.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: yarn install
       - name: Determine version

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npx pretty-quick --staged
+npx lint-staged

.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+  "*": "prettier --write"
+}

.nvmrc

@@ -1 +1 @@
-v16
+v18

.prettierignore

@@ -1,14 +1,26 @@
-cache
-.cache
+# Ignore everything.
+/*
+
+# Don't ignore some files in the root directory.
+!/*.js
+!/*.ts
+!/*.md
+!/*.json
+
+# Don't ignore these nested directories.
+!/examples
+!/modules
+!/packages
+!/scripts
+!/starters
+!/test
+!/www
+
+# In any nested folder, ignore these paths:
+.next
+CHANGELOG.md
+composer.json
+dist
 package.json
 package-lock.json
 public
-CHANGELOG.md
-.yarn
-packages/codemod/transforms/__testfixtures__/**/*
-packages/codemod/transforms/__tests__/**/*
-packages/codemod/**/*.js
-packages/codemod/**/*.d.ts
-dist
-.next
-./drupal

.prettierrc.json

@@ -1,7 +1,14 @@
 {
-  "endOfLine": "lf",
   "semi": false,
-  "singleQuote": false,
-  "tabWidth": 2,
-  "trailingComma": "es5"
+  "trailingComma": "es5",
+  "overrides": [
+    {
+      "files": "modules/**/*",
+      "options": {
+        "semi": true,
+        "singleQuote": true,
+        "trailingComma": "all"
+      }
+    }
+  ]
 }

SECURITY.md

@@ -9,20 +9,20 @@ Refer to the table below for versions supported with security updates.
 | Version | Supported          |
 | ------- | ------------------ |
 | 1.x.x   | :white_check_mark: |
-| < 1.0.0   | :x:                |
+| < 1.0.0 | :x:                |
 
 ### `next` Drupal module
 
 | Version | Supported          |
 | ------- | ------------------ |
 | 1.x.x   | :white_check_mark: |
-| < 1.0.0   | :x:                |
+| < 1.0.0 | :x:                |
 
 ## Reporting a Vulnerability
 
 If you believe you have found a security vulnerability in `next-drupal` package or the `next` Drupal module, we encourage you to let us know right away.
 
-We will do our best to quickly fix the problem. 
+We will do our best to quickly fix the problem.
 
 We will sync with the [Drupal Security Team](https://www.drupal.org/drupal-security-team) if the vulnerability affects the `next` Drupal module.
 

examples/example-auth/cypress/support/index.js

@@ -14,7 +14,7 @@
 // ***********************************************************
 
 // Import commands.js using ES2015 syntax:
-import './commands'
+import "./commands"
 
 // Alternatively you can use CommonJS syntax:
 // require('./commands')

examples/example-auth/types/next-auth.d.ts

@@ -1,4 +1,4 @@
-import { DefaultSession, Session } from "next-auth"
+import { DefaultSession } from "next-auth"
 
 declare module "next-auth" {
   interface Session {

examples/example-blog/tsconfig.json

@@ -1,11 +1,7 @@
 {
   "compilerOptions": {
     "target": "es5",
-    "lib": [
-      "dom",
-      "dom.iterable",
-      "esnext"
-    ],
+    "lib": ["dom", "dom.iterable", "esnext"],
     "allowJs": true,
     "skipLibCheck": true,
     "strict": false,
@@ -19,24 +15,12 @@
     "jsx": "preserve",
     "baseUrl": "./",
     "paths": {
-      "@/components/*": [
-        "src/components/*"
-      ],
-      "@utils/*": [
-        "src/utils/*"
-      ],
-      "@/config": [
-        "src/config"
-      ]
+      "@/components/*": ["src/components/*"],
+      "@utils/*": ["src/utils/*"],
+      "@/config": ["src/config"]
     },
     "incremental": true
   },
-  "include": [
-    "next-env.d.ts",
-    "**/*.ts",
-    "**/*.tsx"
-  ],
-  "exclude": [
-    "node_modules"
-  ]
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules"]
 }

examples/example-custom-cache/lib/drupal.ts

@@ -1,4 +1,4 @@
-import { Experiment_DrupalClient, DataCache } from "next-drupal"
+import { DataCache, DrupalClient } from "next-drupal"
 import Redis from "ioredis"
 
 const redis = new Redis(process.env.REDIS_URL)

examples/example-marketing/cypress/support/index.js

@@ -14,7 +14,7 @@
 // ***********************************************************
 
 // Import commands.js using ES2015 syntax:
-import './commands'
+import "./commands"
 
 // Alternatively you can use CommonJS syntax:
 // require('./commands')

examples/example-marketing/pages/_app.tsx

@@ -1,6 +1,10 @@
 import * as React from "react"
 import Router from "next/router"
-import { QueryClient, QueryClientProvider, Hydrate } from "@tanstack/react-query"
+import {
+  QueryClient,
+  QueryClientProvider,
+  Hydrate,
+} from "@tanstack/react-query"
 import NProgress from "nprogress"
 import { syncDrupalPreviewRoutes } from "next-drupal"
 import "nprogress/nprogress.css"

examples/example-query/pages/[...slug].tsx

@@ -51,7 +51,7 @@ export async function getStaticProps(context) {
     }
   }
 
-  const type = path.jsonapi.resourceName as typeof RESOURCE_TYPES[number]
+  const type = path.jsonapi.resourceName as (typeof RESOURCE_TYPES)[number]
 
   if (!RESOURCE_TYPES.includes(type)) {
     return {

examples/example-query/types/drupal/field.ts

@@ -8,7 +8,7 @@ export interface FieldTextFormatted {
 
 export type FieldEntityReference<
   Types,
-  Cardinality extends FieldCardinality = "limited"
+  Cardinality extends FieldCardinality = "limited",
 > = Cardinality extends "unlimited" ? Array<Partial<Types>> : Partial<Types>
 
 export type FieldList<List> = keyof List

examples/example-search-api/cypress/support/index.js

@@ -14,7 +14,7 @@
 // ***********************************************************
 
 // Import commands.js using ES2015 syntax:
-import './commands'
+import "./commands"
 
 // Alternatively you can use CommonJS syntax:
 // require('./commands')

examples/example-umami/components/meta.tsx

@@ -19,9 +19,7 @@ export function Meta({ title, description }: MetaProps) {
         rel="canonical"
         href={absoluteURL(router.asPath !== "/" ? router.asPath : "")}
       />
-      <title>
-        {`${title} | ${siteConfig.name}`}
-      </title>
+      <title>{`${title} | ${siteConfig.name}`}</title>
       <meta name="description" content={description || siteConfig.slogan} />
       <meta
         property="og:image"

examples/example-umami/pages/_app.tsx

@@ -1,7 +1,11 @@
 import * as React from "react"
 import Router from "next/router"
 import { SessionProvider } from "next-auth/react"
-import { QueryClient, QueryClientProvider, Hydrate } from "@tanstack/react-query"
+import {
+  QueryClient,
+  QueryClientProvider,
+  Hydrate,
+} from "@tanstack/react-query"
 import { appWithTranslation } from "next-i18next"
 import NProgress from "nprogress"
 import "nprogress/nprogress.css"

examples/example-webform/cypress/support/index.js

@@ -14,7 +14,7 @@
 // ***********************************************************
 
 // Import commands.js using ES2015 syntax:
-import './commands'
+import "./commands"
 
 // Alternatively you can use CommonJS syntax:
 // require('./commands')