Merge pull request #65 from seamapi/feat-prettier

Author: codetheweb

.github/workflows/npm-lint.yml

@@ -0,0 +1,19 @@
+name: NPM Format Check
+on: ["pull_request"]
+jobs:
+  npm_test:
+    if: "!contains(github.event.head_commit.message, 'skip ci')"
+    name: Run NPM Test
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 18
+      - name: Run NPM Install
+        run: yarn install
+      - name: Check formatting
+        run: npm run format:check

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "jsxSingleQuote": true,
+  "endOfLine": "lf"
+}

ava.config.js

@@ -2,5 +2,5 @@ module.exports = {
   files: ["tests/**/*.test.ts"],
   extensions: ["ts"],
   timeout: "2m",
-  require: ["esbuild-runner/register"]
+  require: ["esbuild-runner/register"],
 }

bin.js

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 
 require("esbuild-runner/register")
-require("./lib/cli.js").default().catch(error => {
-  console.error(error)
-  process.exit(1)
-})
+require("./lib/cli.js")
+  .default()
+  .catch((error) => {
+    console.error(error)
+    process.exit(1)
+  })

lib/build.js

@@ -21,7 +21,7 @@ const build = async ({
   skipBuild = false,
   nextless = false,
   onlyApiFiles = false,
-  skipNextBuild = false
+  skipNextBuild = false,
 }) => {
   if (skipNextBuild) {
     console.log("Deprecated. Use --skip-build and/or --nextless instead")
@@ -33,14 +33,14 @@ const build = async ({
     (await findUp(
       async (directory) => {
         const hasNext = await findUp.exists(
-          path.join(directory, "node_modules/next")
+          path.join(directory, "node_modules/next"),
         )
         return hasNext && directory
       },
       {
         type: "directory",
         cwd: dir,
-      }
+      },
     )) || dir
   logv({ packageDirWithNext })
 
@@ -49,7 +49,7 @@ const build = async ({
       require.resolve(`${packageDirWithNext}/node_modules/next`)
     } catch (e) {
       throw new Error(
-        `Couldn't find next module, it might not be installed in your project. I checked the path: "${dir}/node_modules/next"`
+        `Couldn't find next module, it might not be installed in your project. I checked the path: "${dir}/node_modules/next"`,
       )
     }
   }

lib/cli.js

@@ -49,7 +49,7 @@ async function main() {
         skipBuild: argv["skip-build"],
         nextless: argv["nextless"],
         onlyApiFiles: argv["only-api-files"],
-        skipNextBuild: argv["skip-next-build"]
+        skipNextBuild: argv["skip-next-build"],
       })
       break
     }

nsm/get-server-fixture.ts

@@ -34,15 +34,15 @@ async function getServerFixture(t: ExecutionContext, options: Options = {}) {
 
   const customAxios = axios.create({
     baseURL: serverURL,
-    ...options.axiosConfig
+    ...options.axiosConfig,
   })
 
   customAxios.interceptors.response.use(
     (res) => res,
     (err) =>
       err instanceof AxiosError
         ? Promise.reject(new SimpleAxiosError(err))
-        : Promise.reject(err)
+        : Promise.reject(err),
   )
 
   return {

nsm/index.ts

@@ -57,7 +57,13 @@ function resolveDynamicRoute(pathname: string, pages: string[]) {
 
 type Middleware = (next: NextApiHandler) => NextApiHandler
 
-export const runServer = async ({ port, middlewares = [] }: {port: number, middlewares?: Middleware[]}) => {
+export const runServer = async ({
+  port,
+  middlewares = [],
+}: {
+  port: number
+  middlewares?: Middleware[]
+}) => {
   debug(`starting server on port ${port}`)
 
   const routeMatcher = getRouteMatcher(routes)
@@ -74,7 +80,7 @@ export const runServer = async ({ port, middlewares = [] }: {port: number, middl
         ...(nextConfig as any).rewrites,
       },
       query,
-      (s) => resolveDynamicRoute(s, Object.keys(routes))
+      (s) => resolveDynamicRoute(s, Object.keys(routes)),
     )
     debug(`resolved request to "${resolveResult.parsedAs.pathname}"`)
 
@@ -93,7 +99,7 @@ export const runServer = async ({ port, middlewares = [] }: {port: number, middl
     }
 
     const wrappedServerFunc = (wrappers as any)(
-      ...[...middlewares, serverFunc?.default || serverFunc]
+      ...[...middlewares, serverFunc?.default || serverFunc],
     )
 
     wrappedServerFunc.config = serverFunc.config || {}
@@ -104,12 +110,12 @@ export const runServer = async ({ port, middlewares = [] }: {port: number, middl
       { ...query, ...match },
       wrappedServerFunc,
       {},
-      false
+      false,
     )
   })
 
   await new Promise<void>((resolve, reject) => {
-    server.once('error', (err) => {
+    server.once("error", (err) => {
       if (err) reject(err)
     })
     server.listen(port, () => {

nsm/nextjs-middleware/api-utils.ts

@@ -45,7 +45,7 @@ export async function apiResolver(
   apiContext: __ApiPreviewProps,
   propagateError: boolean,
   dev?: boolean,
-  page?: string
+  page?: string,
 ): Promise<void> {
   const apiReq = req as NextApiRequest
   const apiRes = res as NextApiResponse
@@ -76,7 +76,7 @@ export async function apiResolver(
         apiReq,
         config.api && config.api.bodyParser && config.api.bodyParser.sizeLimit
           ? config.api.bodyParser.sizeLimit
-          : "1mb"
+          : "1mb",
       )
     }
 
@@ -94,7 +94,7 @@ export async function apiResolver(
 
       if (contentLength >= 4 * 1024 * 1024) {
         console.warn(
-          `API response for ${req.url} exceeds 4MB. This will cause the request to fail in a future version. https://nextjs.org/docs/messages/api-routes-body-size-limit`
+          `API response for ${req.url} exceeds 4MB. This will cause the request to fail in a future version. https://nextjs.org/docs/messages/api-routes-body-size-limit`,
         )
       }
 
@@ -127,7 +127,7 @@ export async function apiResolver(
       !wasPiped
     ) {
       console.warn(
-        `API resolved without sending a response for ${req.url}, this may result in stalled requests.`
+        `API resolved without sending a response for ${req.url}, this may result in stalled requests.`,
       )
     }
   } catch (err) {
@@ -156,7 +156,7 @@ export async function apiResolver(
  */
 export async function parseBody(
   req: IncomingMessage,
-  limit: string | number
+  limit: string | number,
 ): Promise<any> {
   let contentType
   try {
@@ -234,7 +234,7 @@ export function getCookieParser(headers: {
  */
 export function sendStatusCode(
   res: NextApiResponse,
-  statusCode: number
+  statusCode: number,
 ): NextApiResponse<any> {
   res.statusCode = statusCode
   return res
@@ -249,15 +249,15 @@ export function sendStatusCode(
 export function redirect(
   res: NextApiResponse,
   statusOrUrl: string | number,
-  url?: string
+  url?: string,
 ): NextApiResponse<any> {
   if (typeof statusOrUrl === "string") {
     url = statusOrUrl
     statusOrUrl = 307
   }
   if (typeof statusOrUrl !== "number" || typeof url !== "string") {
     throw new Error(
-      `Invalid redirect arguments. Please use a single argument URL, e.g. res.redirect('/destination') or use a status code and URL, e.g. res.redirect(307, '/destination').`
+      `Invalid redirect arguments. Please use a single argument URL, e.g. res.redirect('/destination') or use a status code and URL, e.g. res.redirect(307, '/destination').`,
     )
   }
   res.writeHead(statusOrUrl, { Location: url })
@@ -275,7 +275,7 @@ export function redirect(
 export function sendData(
   req: NextApiRequest,
   res: NextApiResponse,
-  body: any
+  body: any,
 ): void {
   if (body === null || body === undefined) {
     res.end()
@@ -291,7 +291,7 @@ export function sendData(
     if (process.env.NODE_ENV === "development" && body) {
       console.warn(
         `A body was attempted to be set with a 204 statusCode for ${req.url}, this is invalid and the body was ignored.\n` +
-          `See more info here https://nextjs.org/docs/messages/invalid-api-status-body`
+          `See more info here https://nextjs.org/docs/messages/invalid-api-status-body`,
       )
     }
     res.end()
@@ -354,7 +354,7 @@ const SYMBOL_CLEARED_COOKIES = Symbol(COOKIE_NAME_PRERENDER_BYPASS)
 export function tryGetPreviewData(
   req: IncomingMessage,
   res: ServerResponse,
-  options: __ApiPreviewProps
+  options: __ApiPreviewProps,
 ): any {
   // Read cached preview data if present
   if (SYMBOL_PREVIEW_DATA in req) {
@@ -437,7 +437,7 @@ function setPreviewData<T>(
   data: object | string, // TODO: strict runtime type checking
   options: {
     maxAge?: number
-  } & __ApiPreviewProps
+  } & __ApiPreviewProps,
 ): NextApiResponse<T> {
   if (isNotValidData(options.previewModeId!)) {
     throw new Error("invariant: invalid previewModeId")
@@ -567,7 +567,7 @@ export class ApiError extends Error {
 export function sendError(
   res: NextApiResponse,
   statusCode: number,
-  message: string
+  message: string,
 ): void {
   res.statusCode = statusCode
   res.statusMessage = message
@@ -587,7 +587,7 @@ interface LazyProps {
 export function setLazyProp<T>(
   { req }: LazyProps,
   prop: string,
-  getter: () => T
+  getter: () => T,
 ): void {
   const opts = { configurable: true, enumerable: true }
   const optsReset = { ...opts, writable: true }

nsm/nextjs-middleware/normalize-locale-path.ts

@@ -16,7 +16,7 @@ export interface PathLocale {
  */
 export function normalizeLocalePath(
   pathname: string,
-  locales?: string[]
+  locales?: string[],
 ): PathLocale {
   let detectedLocale: string | undefined
   // first item will be empty string from splitting at first char