feat: add Fresh lint plugin

Author: csvn

packages/init/src/init.ts

@@ -4,6 +4,7 @@ import * as path from "@std/path";
 
 // Keep these as is, as we replace these version in our release script
 const FRESH_VERSION = "2.0.0-alpha.59";
+const FRESH_LINT_VERSION = "0.0.0";
 const FRESH_TAILWIND_VERSION = "0.0.1-alpha.9";
 const PREACT_VERSION = "10.27.1";
 const PREACT_SIGNALS_VERSION = "2.3.1";
@@ -511,13 +512,15 @@ if (Deno.args.includes("build")) {
       update: "deno run -A -r jsr:@fresh/update .",
     },
     lint: {
+      plugins: ["jsr:@fresh/lint"],
       rules: {
         tags: ["fresh", "recommended"],
       },
     },
     exclude: ["**/_fresh/*"],
     imports: {
       "fresh": `jsr:@fresh/core@^${FRESH_VERSION}`,
+      "@fresh/lint": `jsr:@fresh/lint@^${FRESH_LINT_VERSION}`,
       "preact": `npm:preact@^${PREACT_VERSION}`,
       "@preact/signals": `npm:@preact/signals@^${PREACT_SIGNALS_VERSION}`,
     } as Record<string, string>,

packages/lint/README.md

@@ -0,0 +1,26 @@
+# Fresh Lint rules
+
+This is a plugin with custom rules specifically for Fresh.
+
+## Usage
+
+1. Install the Fresh lint plugin
+   ```sh
+   deno add jsr:@fresh/lint
+   ```
+2. Configure the plugin in `deno.json`
+   ```json deno.json
+   {
+     "lint": {
+       "plugins": ["@fresh/lint"],
+       "rules": {
+         "include": ["fresh/[lint-rule]"]
+       }
+     }
+   }
+   ```
+3. You can now start linting Fresh code! 🎉
+
+## Rules
+
+TODO: COMING SOON!

packages/lint/deno.json

@@ -0,0 +1,13 @@
+{
+  "name": "@fresh/lint",
+  "version": "0.0.0",
+  "license": "MIT",
+  "exports": "./src/plugin.ts",
+  "publish": {
+    "include": [
+      "src/**/*.ts",
+      "deno.json",
+      "README.md"
+    ]
+  }
+}

packages/lint/src/plugin.ts

@@ -0,0 +1,41 @@
+import * as handlerExport from "./rules/handler-export.ts";
+import * as serverEventHandlers from "./rules/server-event-handlers.ts";
+
+/** Expected shape of each lint rule module */
+export interface RuleModule {
+  /** The name of the lint rule, which becomes `fresh/<rule-name>` */
+  RULE_NAME: string;
+  /** Rule implementation */
+  rule: Deno.lint.Rule;
+}
+
+/**
+ * Plugin for Fresh linting rules.
+ *
+ * For a full list of rules, see {@linkcode rules}.
+ *
+ * Enable lint rules by updating `deno.json`, each rule
+ * should be prefixed with `fresh/<rule_name>`.
+ *
+ * @example
+ * ```json deno.json
+ * {
+ *   "lint": {
+ *     "plugins": ["@fresh/lint"],
+ *     "rules": {
+ *       "include": ["fresh/test"]
+ *     }
+ *   }
+ * }
+ * ```
+ */
+const plugin: Deno.lint.Plugin = {
+  name: "fresh",
+  rules: createRules(handlerExport, serverEventHandlers),
+};
+
+function createRules(...modules: RuleModule[]): Deno.lint.Plugin["rules"] {
+  return Object.fromEntries(modules.map((mod) => [mod.RULE_NAME, mod.rule]));
+}
+
+export default plugin;

packages/lint/src/rules/handler-export.test.ts

@@ -0,0 +1,51 @@
+import { expect } from "@std/expect";
+import { testPlugin } from "../test-utils.ts";
+import * as testRule from "./handler-export.ts";
+
+const okCases = new Set<[filename: string, code: string]>([
+  ["file:///foo.jsx", "const handler = {}"],
+  ["file:///foo.jsx", "function handler() {}"],
+  ["file:///foo.jsx", "export const handler = {}"],
+  ["file:///foo.jsx", "export const handlers = {}"],
+  ["file:///foo.jsx", "export function handlers() {}"],
+  ["file:///routes/foo.jsx", "export const handler = {}"],
+  ["file:///routes/foo.jsx", "export function handler() {}"],
+  ["file:///routes/foo.jsx", "export async function handler() {}"],
+  ["file:///routes/foo.jsx", "export const handler = define.handlers({});"],
+  ["file:///C:/www/routes/foo.jsx", "export const handler = {}"],
+]);
+
+const errCases = new Set<[file: string, code: string, range: [number, number]]>(
+  [
+    ["file:///routes/index.tsx", "export const handlers = {}", [13, 21]],
+    ["file:///routes/index.tsx", "export function handlers() {}", [16, 24]],
+    ["file:///routes/index.tsx", "export async function handlers() {}", [
+      22,
+      30,
+    ]],
+    ["file:///C:/www/routes/foo.jsx", "export const handlers = {}", [13, 21]],
+  ],
+);
+
+Deno.test("fresh/handler-export - ok", () => {
+  for (const [file, code] of okCases) {
+    const diagnostics = Deno.lint.runPlugin(testPlugin(testRule), file, code);
+
+    expect(diagnostics.length).toBe(0);
+  }
+});
+
+Deno.test("fresh/handler-export - err", () => {
+  for (const [file, code, range] of errCases) {
+    const [d, ...rest] = Deno.lint.runPlugin(testPlugin(testRule), file, code);
+
+    expect(rest.length).toBe(0);
+    expect(d.fix).toEqual([]);
+    expect(d.range).toEqual(range);
+    expect(d.id).toBe("fresh/handler-export");
+    expect(d.message).toBe(
+      'Fresh middlewares must be exported as "handler" but got "handlers" instead.',
+    );
+    expect(d.hint).toBe('Did you mean "handler"?');
+  }
+});

packages/lint/src/rules/handler-export.ts

@@ -0,0 +1,43 @@
+import { NO_VISITOR, pathSegments } from "../utils.ts";
+
+/**
+ * Reports routes using an incorrect export name for handlers.
+ *
+ * @example
+ * ```tsx
+ * // routes/index.ts
+ * export const handlers = () => {};
+ *           // ^^^^^^^^ should be "handler"
+ * ```
+ *
+ * @module
+ */
+
+export const RULE_NAME = "handler-export";
+
+const MESSAGE =
+  'Fresh middlewares must be exported as "handler" but got "handlers" instead.';
+const HINT = 'Did you mean "handler"?';
+
+const HANDLERS_NAME = "handlers";
+const HANDLERS_EXPORT_SELECTOR =
+  `ExportNamedDeclaration > VariableDeclaration > VariableDeclarator > Identifier[name=${HANDLERS_NAME}],
+   ExportNamedDeclaration > FunctionDeclaration > Identifier[name=${HANDLERS_NAME}]`;
+
+export const rule: Deno.lint.Rule = {
+  create(ctx) {
+    // Ignore files outside `routes/` dir
+    if (!pathSegments(ctx.filename).isRoute()) return NO_VISITOR;
+
+    return {
+      [HANDLERS_EXPORT_SELECTOR](node: Deno.lint.Identifier) {
+        ctx.report({
+          message: MESSAGE,
+          hint: HINT,
+          node,
+          range: node.range,
+        });
+      },
+    };
+  },
+};

packages/lint/src/rules/server-event-handlers.test.ts

@@ -0,0 +1,59 @@
+import { expect } from "@std/expect";
+import { testPlugin } from "../test-utils.ts";
+import * as testRule from "./server-event-handlers.ts";
+
+const okCases = new Set<[filename: string, code: string]>([
+  ["file:///foo.jsx", "<Foo onClick={() => {}} />"],
+  ["file:///foo.jsx", "<button onClick={() => {}} />"],
+  ["file:///foo.jsx", "<button onClick={function () {}} />"],
+  ["file:///foo.jsx", "<button onclick={function () {}} />"],
+  ["file:///foo.jsx", "<button onClick=\"console.log('hey')\" />"],
+  ["file:///foo.jsx", '<button online="foo" />'],
+  ["file:///foo.jsx", "<x-foo onClick=\"console.log('hey')\" />"],
+  [
+    "file:///routes/foo/(_islands)/foo.jsx",
+    "<button onClick={function () {}} />",
+  ],
+]);
+
+const errCases = new Set<[file: string, code: string, range: [number, number]]>(
+  [
+    ["file:///routes/index.tsx", "<button onClick={() => {}} />", [8, 26]],
+    ["file:///routes/index.tsx", "<button onTouchMove={() => {}} />", [8, 30]],
+    [
+      "file:///routes/index.tsx",
+      `<button onTouchMove={"console.log('hey')"} />`,
+      [8, 42],
+    ],
+    ["file:///routes/index.tsx", "<foo-button foo={() => {}} />", [12, 26]],
+    ["file:///routes/index.tsx", "<foo-button foo={function () {}} />", [
+      12,
+      32,
+    ]],
+  ],
+);
+
+Deno.test("fresh/server-event-handlers - ok", () => {
+  for (const [file, code] of okCases) {
+    const diagnostics = Deno.lint.runPlugin(testPlugin(testRule), file, code);
+
+    expect(diagnostics.length).toBe(0);
+  }
+});
+
+Deno.test("fresh/server-event-handlers - err", () => {
+  for (const [file, code, range] of errCases) {
+    const [d, ...rest] = Deno.lint.runPlugin(testPlugin(testRule), file, code);
+
+    expect(rest.length).toBe(0);
+    expect(d.fix).toEqual([]);
+    expect(d.range).toEqual(range);
+    expect(d.id).toBe("fresh/server-event-handlers");
+    expect(d.message).toBe(
+      "Server components cannot install client side event handlers.",
+    );
+    expect(d.hint).toBe(
+      "Remove this property or turn the enclosing component into an island",
+    );
+  }
+});

packages/lint/src/rules/server-event-handlers.ts

@@ -0,0 +1,61 @@
+import { NO_VISITOR, pathSegments } from "../utils.ts";
+
+/**
+ * Reports server components that install client side event handlers.
+ *
+ * Disallows `on*` attributes for JSX components inside the
+ * `routes/` directory, as these components are rendered on the server.
+ *
+ * @example
+ * ```tsx
+ * // routes/index.ts
+ * <button onClick={() => {}} />
+ *      // ^^^^^^^^^^^^^^^^^^ invalid handler
+ * ```
+ *
+ * The `(_islands)` directory is excluded from this lint rule.
+ *
+ * @module
+ */
+
+export const RULE_NAME = "server-event-handlers";
+
+const MESSAGE = "Server components cannot install client side event handlers.";
+const HINT =
+  "Remove this property or turn the enclosing component into an island";
+
+const CUSTOM_ELEMENT_FN_EXPR_ATTR_SELECTOR =
+  'JSXOpeningElement[name.type="JSXIdentifier"][name.name=/-/] > JSXAttribute[name.type="JSXIdentifier"]:has(> JSXExpressionContainer[expression.type=/^(FunctionExpression|ArrowFunctionExpression)$/])';
+const HTML_ELEMENT_ON_ATTR_SELECTOR =
+  'JSXOpeningElement[name.type="JSXIdentifier"] > JSXAttribute[name.type="JSXIdentifier"][name.name=/^on/]';
+
+export const rule: Deno.lint.Rule = {
+  create(ctx) {
+    const path = pathSegments(ctx.filename);
+
+    // Ignore island components or components outside `routes/` dir
+    if (path.isIsland() || !path.isRoute()) return NO_VISITOR;
+
+    const reportNode = (node: Deno.lint.JSXAttribute) => {
+      ctx.report({
+        message: MESSAGE,
+        hint: HINT,
+        node,
+        range: node.range,
+      });
+    };
+
+    return {
+      [CUSTOM_ELEMENT_FN_EXPR_ATTR_SELECTOR]: reportNode,
+      [HTML_ELEMENT_ON_ATTR_SELECTOR](node: Deno.lint.JSXAttribute) {
+        const parent = node.parent.name;
+        // Should already be a JSXIdentifier
+        // Regex used on parent manually here, because there is an issue with character classes
+        // See: https://github.com/denoland/deno/issues/30460
+        if (parent.type === "JSXIdentifier" && /^[a-z]+$/.test(parent.name)) {
+          reportNode(node);
+        }
+      },
+    };
+  },
+};

packages/lint/src/test-utils.ts

@@ -0,0 +1,9 @@
+import type { RuleModule } from "./plugin.ts";
+
+/** Create a test lint plugin for the given rule */
+export function testPlugin({ rule, RULE_NAME }: RuleModule): Deno.lint.Plugin {
+  return {
+    name: `fresh`,
+    rules: { [RULE_NAME]: rule },
+  };
+}

packages/lint/src/utils.ts

@@ -0,0 +1,21 @@
+import { SEPARATOR_PATTERN } from "@std/path";
+
+/** Utility for e.g. ignored files to avoid visiting any AST nodes */
+export const NO_VISITOR: Deno.lint.LintVisitor = Object.freeze({});
+
+/** Utility for inspecting the path segments of a file */
+export function pathSegments(filename: string) {
+  // TODO: Make this folder respect Fresh config?
+  const ROUTES_DIR = "routes";
+  const ISLANDS_DIR = "(_islands)";
+  const segments = filename.split(SEPARATOR_PATTERN);
+
+  return {
+    isRoute() {
+      return segments.includes(ROUTES_DIR);
+    },
+    isIsland() {
+      return segments.includes(ISLANDS_DIR);
+    },
+  };
+}