Feat/striper throw check

.changeset/curvy-eggs-deliver.md

@@ -0,0 +1,5 @@
+---
+'vite-plugin-watch-and-run': patch
+---
+
+add absolutePath in second param of run as info

.changeset/pre.json

@@ -0,0 +1,16 @@
+{
+  "mode": "pre",
+  "tag": "next",
+  "initialVersions": {
+    "@kitql-old/all-in": "0.9.6",
+    "create-kitql": "0.0.2",
+    "eslint-config-kitql": "0.0.2",
+    "@kitql/handles": "0.1.3",
+    "@kitql/helpers": "0.8.4",
+    "vite-plugin-kit-routes": "0.1.0",
+    "vite-plugin-striper": "0.0.4",
+    "vite-plugin-watch-and-run": "1.4.3",
+    "website": "1.1.2"
+  },
+  "changesets": []
+}

.changeset/quiet-horses-drop.md

@@ -0,0 +1,5 @@
+---
+'vite-plugin-striper': patch
+---
+
+add log_warning_on_throw_is_not_a_class option

packages/vite-plugin-striper/package.json

@@ -42,7 +42,8 @@
   "dependencies": {
     "@babel/parser": "^7.23.0",
     "@kitql/helpers": "workspace:*",
-    "recast": "^0.23.4"
+    "recast": "^0.23.4",
+    "vite-plugin-watch-and-run": "workspace:*"
   },
   "sideEffects": false,
   "publishConfig": {

packages/vite-plugin-striper/src/lib/plugin.ts

@@ -1,14 +1,27 @@
 import { green, Log, yellow } from '@kitql/helpers'
+import { readFileSync } from 'node:fs'
 import type { Plugin } from 'vite'
+import watch_and_run from 'vite-plugin-watch-and-run'
 
-import { transform } from './transform.js'
+import { transformDecorator } from './transformDecorator.js'
+import { transformWarningThrow, type WarningThrow } from './transformWarningThrow.js'
 
 export type ViteStriperOptions = {
   /**
    * for example: `['BackendMethod']`
    */
-  decorators: string[]
+  decorators?: string[]
 
+  /**
+   * If true, skip warnings if a throw is not a class.
+   *
+   * Default: `true`
+   */
+  log_warning_on_throw_is_not_a_class?: boolean
+
+  /**
+   * internal usage ;-)
+   */
   debug?: boolean
 }
 
@@ -30,34 +43,104 @@ export type ViteStriperOptions = {
  * ```
  * 
  */
-export function striper(options: ViteStriperOptions): Plugin {
+export function striper(options?: ViteStriperOptions): Plugin[] {
   const log = new Log('striper')
+  let listOrThrow: WarningThrow[] = []
+  const logWarningThrow =
+    options?.log_warning_on_throw_is_not_a_class === undefined ||
+    options?.log_warning_on_throw_is_not_a_class === true
 
-  return {
-    name: 'vite-plugin-striper',
-    enforce: 'pre',
+  return [
+    {
+      name: 'vite-plugin-striper-decorator',
+      enforce: 'pre',
 
-    transform: async (code, filepath, option) => {
-      // Don't transform server-side code
-      if (option?.ssr) {
-        return
-      }
-      // files are only in ts
-      if (!filepath.endsWith('.ts')) {
-        return
-      }
+      buildStart: () => {
+        listOrThrow = []
+      },
+
+      transform: async (code, filepath, option) => {
+        if (logWarningThrow) {
+          const prjPath = process.cwd()
+          // Only file in our project
+          if (filepath.startsWith(prjPath)) {
+            const { list } = await transformWarningThrow(filepath, code, logWarningThrow)
+            listOrThrow.push(
+              ...list.map(item => ({ ...item, pathFile: filepath.replace(prjPath, '') })),
+            )
+          }
+        }
 
-      const { transformed, ...rest } = await transform(code, options.decorators ?? [])
+        // Don't transform server-side code
+        if (option?.ssr) {
+          return
+        }
+        // files are only in ts
+        if (!filepath.endsWith('.ts')) {
+          return
+        }
 
-      if (options?.debug && transformed) {
-        log.info(`
-${green('-----')} after transform of ${yellow(filepath)}
-${rest.code}
-${green('-----')}
-`)
-      }
+        if (options && (options?.decorators ?? []).length > 0) {
+          const { transformed, ...rest } = await transformDecorator(code, options.decorators ?? [])
 
-      return rest
+          if (options?.debug && transformed) {
+            log.info(
+              `` +
+                `${green('-----')} after transform of ${yellow(filepath)}` +
+                `${rest.code}` +
+                `${green('-----')}` +
+                ``,
+            )
+          }
+
+          return rest
+        }
+
+        return
+      },
+
+      buildEnd: async () => {
+        listOrThrow.forEach(item => {
+          log.error(
+            `Throw is not a new class in ${yellow(item.pathFile)}:${yellow(String(item.line))}`,
+          )
+        })
+      },
     },
-  }
+
+    // Run the thing when any change in a +page.svelte (add, remove, ...)
+    watch_and_run([
+      {
+        name: 'kit-routes-watch',
+        logs: [],
+        watch: ['**/*.ts'],
+        run: async (server, absolutePath) => {
+          if (logWarningThrow) {
+            const prjPath = process.cwd()
+
+            // Only file in our project
+            if (absolutePath && absolutePath.startsWith(prjPath)) {
+              const code = readFileSync(absolutePath, { encoding: 'utf8' })
+
+              const { list } = await transformWarningThrow(
+                absolutePath + '?' + new Date().toISOString(),
+                code,
+                logWarningThrow,
+              )
+              listOrThrow.push(
+                ...list.map(item => ({ ...item, pathFile: absolutePath.replace(prjPath, '') })),
+              )
+              listOrThrow.forEach(item => {
+                log.error(
+                  `Throw is not a new class in ${yellow(item.pathFile)}:${yellow(
+                    String(item.line),
+                  )}`,
+                )
+              })
+            }
+          }
+        },
+      },
+    ]),
+  ]
 }

packages/vite-plugin-striper/src/lib/transform.spec.ts → packages/vite-plugin-striper/src/lib/transformDecorator.spec.ts

@@ -1,9 +1,10 @@
-import { expect, it } from 'vitest'
+import { describe, expect, it } from 'vitest'
 
-import { transform } from './transform.js'
+import { transformDecorator } from './transformDecorator.js'
 
-it('should empty @BackendMethod and clean imports', async () => {
-  const code = `import { Allow, BackendMethod, remult } from "remult";
+describe('decorator', () => {
+  it('should empty @BackendMethod and clean imports', async () => {
+    const code = `import { Allow, BackendMethod, remult } from "remult";
 import { Task } from "./task";
 import { AUTH_SECRET } from "$env/static/private";
 
@@ -34,9 +35,9 @@ export class TasksController {
 }
 	`
 
-  const transformed = await transform(code, ['BackendMethod'])
+    const transformed = await transformDecorator(code, ['BackendMethod'])
 
-  expect(transformed).toMatchInlineSnapshot(`
+    expect(transformed).toMatchInlineSnapshot(`
     {
       "code": "import { Allow, BackendMethod } from \\"remult\\";
 
@@ -56,10 +57,10 @@ export class TasksController {
       "transformed": true,
     }
   `)
-})
+  })
 
-it('should not crash if there is an error in the original file', async () => {
-  const code = `import { Allow, BackendMethod, remult } from "remult";
+  it('should not crash if there is an error in the original file', async () => {
+    const code = `import { Allow, BackendMethod, remult } from "remult";
 import { Task } from "./task";
 import { AUTH_SECRET } from "$env/static/private";
 
@@ -71,9 +72,9 @@ export class TasksController {
 }
 	`
 
-  const transformed = await transform(code, ['BackendMethod'])
+    const transformed = await transformDecorator(code, ['BackendMethod'])
 
-  expect(transformed).toMatchInlineSnapshot(`
+    expect(transformed).toMatchInlineSnapshot(`
     {
       "code": "import { Allow, BackendMethod, remult } from \\"remult\\";
     import { Task } from \\"./task\\";
@@ -89,10 +90,10 @@ export class TasksController {
       "transformed": false,
     }
   `)
-})
+  })
 
-it('should not do anything as there is no @BackendMethod', async () => {
-  const code = `import { Allow, BackendMethod, remult } from "remult";
+  it('should not do anything as there is no @BackendMethod', async () => {
+    const code = `import { Allow, BackendMethod, remult } from "remult";
 import { Task } from "./task";
 import { AUTH_SECRET } from "$env/static/private";
 
@@ -112,9 +113,9 @@ export class TasksController {
 }
 	`
 
-  const transformed = await transform(code, ['BackendMethod'])
+    const transformed = await transformDecorator(code, ['BackendMethod'])
 
-  expect(transformed).toMatchInlineSnapshot(`
+    expect(transformed).toMatchInlineSnapshot(`
     {
       "code": "import { Allow, BackendMethod, remult } from \\"remult\\";
     import { Task } from \\"./task\\";
@@ -140,10 +141,10 @@ export class TasksController {
       "transformed": false,
     }
   `)
-})
+  })
 
-it('should strip also unused methods', async () => {
-  const code = `import { TOP_SECRET, TOP_SECRET_NOT_USED } from '$env/static/private';
+  it('should strip also unused methods', async () => {
+    const code = `import { TOP_SECRET, TOP_SECRET_NOT_USED } from '$env/static/private';
   import { stry0 } from '@kitql/helper';
   import { BackendMethod, Entity, Fields, remult } from 'remult';
 
@@ -171,9 +172,9 @@ it('should strip also unused methods', async () => {
   }  
 	`
 
-  const transformed = await transform(code, ['BackendMethod'])
+    const transformed = await transformDecorator(code, ['BackendMethod'])
 
-  expect(transformed).toMatchInlineSnapshot(`
+    expect(transformed).toMatchInlineSnapshot(`
     {
       "code": "import { BackendMethod, Entity, Fields } from \\"remult\\";
 
@@ -192,4 +193,5 @@ it('should strip also unused methods', async () => {
       "transformed": true,
     }
   `)
+  })
 })

packages/vite-plugin-striper/src/lib/transform.ts → packages/vite-plugin-striper/src/lib/transformDecorator.ts

@@ -4,7 +4,7 @@ import { prettyPrint } from 'recast'
 
 const { visit } = recast.types
 
-export const transform = async (code: string, decorators_to_strip: string[]) => {
+export const transformDecorator = async (code: string, decorators_to_strip: string[]) => {
   try {
     const codeParsed = parse(code ?? '', {
       plugins: ['typescript', 'importAssertions', 'decorators-legacy'],

packages/vite-plugin-striper/src/lib/transformWarningThrow.spec.ts

@@ -0,0 +1,45 @@
+import { describe, expect, it } from 'vitest'
+
+import { transformWarningThrow } from './transformWarningThrow.js'
+
+describe('warning on throw is not a class', () => {
+  it('should not warn', async () => {
+    const code = `import type { RequestHandler } from './$types'
+
+    export const GET: RequestHandler = async () => {
+      throw new Error('Not implemented')
+      return new Response()
+    }`
+
+    const transformed = await transformWarningThrow('myfile', code, true)
+
+    expect(transformed).toMatchInlineSnapshot(`
+      {
+        "list": [],
+      }
+    `)
+  })
+
+  it('should warn', async () => {
+    const code = `import type { RequestHandler } from './$types'
+
+    export const GET: RequestHandler = async () => {
+      throw 7
+      return new Response()
+    }
+    `
+
+    const transformed = await transformWarningThrow('myfile', code, true)
+
+    expect(transformed).toMatchInlineSnapshot(`
+      {
+        "list": [
+          {
+            "line": 4,
+            "pathFile": "myfile",
+          },
+        ],
+      }
+    `)
+  })
+})