chore: utilize

Author: baseballyama

src/rules/kit-helpers/kit-helpers.ts

@@ -1,6 +1,6 @@
 import type * as ESTree from "estree"
 import { createRule } from "../utils"
-import { isKitPageComponent, hasSvelteKit } from "./kit-helpers/kit-helpers"
+import { isKitPageComponent, hasSvelteKit } from "../utils/svelte-kit"
 
 export default createRule("no-export-load-in-svelte-module-in-kit-pages", {
   meta: {
@@ -19,7 +19,9 @@ export default createRule("no-export-load-in-svelte-module-in-kit-pages", {
     type: "problem",
   },
   create(context) {
-    if (!hasSvelteKit || !isKitPageComponent(context)) return {}
+    if (!hasSvelteKit(context.getFilename()) || !isKitPageComponent(context)) {
+      return {}
+    }
     let isModule = false
     return {
       // <script context="module">

src/rules/no-export-load-in-svelte-module-in-kit-pages.ts

@@ -0,0 +1,63 @@
+/**
+ * Simple cache manager.
+ *
+ * refer: https://github.com/mysticatea/eslint-plugin-node/blob/f45c6149be7235c0f7422d1179c25726afeecd83/lib/util/cache.js
+ */
+
+const SKIP_TIME = 5000
+
+type CacheValue<T> = {
+  expire: number
+  value: T
+}
+
+/**
+ * The cache will dispose of each value if the value has not been accessed
+ * during 5 seconds.
+ * @returns getter and setter ofr the cache.
+ */
+export function createCache<T>(): {
+  get: (key: string) => T | null
+  set: (key: string, value: T) => void
+} {
+  const map: Map<string, CacheValue<T>> = new Map()
+
+  /**
+   * Get the cached value of the given key.
+   * @param key The key to get.
+   * @returns The cached value or null.
+   */
+  function get(key: string): T | null {
+    const entry = map.get(key)
+    const now = Date.now()
+
+    if (entry) {
+      if (entry.expire > now) {
+        entry.expire = now + SKIP_TIME
+        return entry.value
+      }
+      map.delete(key)
+    }
+    return null
+  }
+
+  /**
+   * Set the value of the given key.
+   * @param key The key to set.
+   * @param value The value to set.
+   * @returns
+   */
+  function set(key: string, value: T): void {
+    const entry = map.get(key)
+    const expire = Date.now() + SKIP_TIME
+
+    if (entry) {
+      entry.value = value
+      entry.expire = expire
+    } else {
+      map.set(key, { value, expire })
+    }
+  }
+
+  return { get, set }
+}

src/utils/cache.ts

@@ -0,0 +1,77 @@
+/**
+ * refer: https://github.com/mysticatea/eslint-plugin-node/blob/f45c6149be7235c0f7422d1179c25726afeecd83/lib/util/get-package-json.js
+ */
+
+import fs from "fs"
+import path from "path"
+import { createCache } from "./cache"
+
+type PackageJson = Record<string, any> & { filePath: string }
+
+const isRunOnBrowser = !fs.readFileSync
+const cache = createCache<PackageJson | null>()
+
+/**
+ * Reads the `package.json` data in a given path.
+ *
+ * Don't cache the data.
+ *
+ * @param dir The path to a directory to read.
+ * @returns The read `package.json` data, or null.
+ */
+function readPackageJson(dir: string): PackageJson | null {
+  if (isRunOnBrowser) return null
+  const filePath = path.join(dir, "package.json")
+  try {
+    const text = fs.readFileSync(filePath, "utf8")
+    const data = JSON.parse(text)
+
+    if (typeof data === "object" && data !== null) {
+      data.filePath = filePath
+      return data
+    }
+  } catch (_err) {
+    // do nothing.
+  }
+
+  return null
+}
+
+/**
+ * Gets a `package.json` data.
+ * The data is cached if found, then it's used after.
+ * @param startPath A file path to lookup.
+ * @returns A found `package.json` data or `null`.
+ *      This object have additional property `filePath`.
+ */
+export function getPackageJson(startPath = "a.js"): PackageJson | null {
+  if (isRunOnBrowser) return null
+  const startDir = path.dirname(path.resolve(startPath))
+  let dir = startDir
+  let prevDir = ""
+  let data = null
+
+  do {
+    data = cache.get(dir)
+    if (data) {
+      if (dir !== startDir) {
+        cache.set(startDir, data)
+      }
+      return data
+    }
+
+    data = readPackageJson(dir)
+    if (data) {
+      cache.set(dir, data)
+      cache.set(startDir, data)
+      return data
+    }
+
+    // Go to next.
+    prevDir = dir
+    dir = path.resolve(dir, "..")
+  } while (dir !== prevDir)
+
+  cache.set(startDir, null)
+  return null
+}

src/utils/get-package-json.ts

@@ -0,0 +1,65 @@
+/**
+ * refer: https://github.com/mysticatea/eslint-plugin-node/blob/f45c6149be7235c0f7422d1179c25726afeecd83/lib/util/get-package-json.js
+ */
+
+import type { RuleContext } from "../types"
+import fs from "fs"
+import path from "path"
+import { getPackageJson } from "./get-package-json"
+
+const isRunOnBrowser = !fs.readFileSync
+
+/**
+ * return true if it's a Svelte Kit page component.
+ * @param context
+ * @returns
+ */
+export function isKitPageComponent(context: RuleContext): boolean {
+  // Hack: if it runs on browser, it regards as Svelte Kit project.
+  if (isRunOnBrowser) return true
+
+  const routes =
+    context.settings?.kit?.files?.routes?.replace(/^\//, "") ?? "src/routes"
+  const filePath = context.getFilename()
+  const projectRootDir = getProjectRootDir(context.getFilename()) ?? ""
+  return filePath.startsWith(path.join(projectRootDir, routes))
+}
+
+/**
+ * Check givin file is under SvelteKit project.
+ *
+ * If it runs on browser, it always returns true.
+ *
+ * @param filePath A file path.
+ * @returns
+ */
+export function hasSvelteKit(filePath: string): boolean {
+  // Hack: if it runs on browser, it regards as Svelte Kit project.
+  if (isRunOnBrowser) return true
+  try {
+    const packageJson = getPackageJson(filePath)
+    if (!packageJson) return false
+    if (packageJson.name === "eslint-plugin-svelte")
+      // Hack: CI removes `@sveltejs/kit` and it returns false and test failed.
+      // So always it returns true if it runs on the package.
+      return true
+    return Boolean(
+      packageJson.dependencies["@sveltejs/kit"] ??
+        packageJson.devDependencies["@sveltejs/kit"],
+    )
+  } catch (_e) {
+    return false
+  }
+}
+
+/**
+ * Gets a  project root folder path.
+ * @param filePath A file path to lookup.
+ * @returns A found project root folder path or null.
+ */
+function getProjectRootDir(filePath: string): string | null {
+  if (isRunOnBrowser) return null
+  const packageJsonFilePath = getPackageJson(filePath)?.filePath
+  if (!packageJsonFilePath) return null
+  return path.dirname(path.resolve(packageJsonFilePath))
+}