feat: add "eslint/universal" to export Linter (#18883)

* feat: add "eslint/universal" to export `Linter` fixes #18715 * fix: add lib/universal.js * feat: add typings * chore: add tests for "eslint/universal" types * Update lib/types/universal.d.ts Co-authored-by: Francesco Trotta <github@fasttime.org> * chore: update types tests --------- Co-authored-by: Francesco Trotta <github@fasttime.org>
eslint · Sep 18, 2024 · ec30c73 · ec30c73
1 parent c591da6
commit ec30c73
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 1 deletion.
diff --git a/eslint.config.js b/eslint.config.js
@@ -200,7 +200,7 @@ module.exports = [
     {
         name: "eslint/lib",
         files: ["lib/*.js"],
-        ignores: ["lib/unsupported-api.js"],
+        ignores: ["lib/unsupported-api.js", "lib/universal.js"],
         rules: {
             "n/no-restricted-require": ["error", [
                 ...createInternalFilesPatterns()

diff --git a/lib/types/universal.d.ts b/lib/types/universal.d.ts
@@ -0,0 +1,6 @@
+/**
+ * @fileoverview typings for "eslint/universal" module
+ * @author 唯然<weiran.zsd@outlook.com>
+ */
+
+export { Linter } from "./index";
diff --git a/lib/universal.js b/lib/universal.js
@@ -0,0 +1,10 @@
+/**
+ * @fileoverview exports for browsers
+ * @author 唯然<weiran.zsd@outlook.com>
+ */
+
+"use strict";
+
+const { Linter } = require("./linter/linter");
+
+module.exports = { Linter };
diff --git a/package.json b/package.json
@@ -20,6 +20,10 @@
     },
     "./rules": {
       "types": "./lib/types/rules/index.d.ts"
+    },
+    "./universal": {
+        "types": "./lib/types/universal.d.ts",
+        "default": "./lib/universal.js"
     }
   },
   "scripts": {

diff --git a/tests/lib/types/types.test.ts b/tests/lib/types/types.test.ts
@@ -27,6 +27,7 @@
 
 import { AST, ESLint, Linter, loadESLint, Rule, RuleTester, Scope, SourceCode } from "eslint";
 import { ESLintRules } from "eslint/rules";
+import { Linter as ESLinter } from "eslint/universal";
 import {
     builtinRules,
     FileEnumerator,
@@ -579,6 +580,7 @@ rule = {
 // #region Linter
 
 const linter = new Linter();
+const eslinter = new ESLinter();
 
 linter.version;
 

diff --git a/tests/lib/universal.js b/tests/lib/universal.js
@@ -0,0 +1,21 @@
+/**
+ * @fileoverview Tests for "eslint/universal".
+ * @author 唯然<weiran.zsd@outlook.com>
+ */
+
+"use strict";
+const assert = require("node:assert/strict");
+
+describe("universal", () => {
+    it("should have Linter exported", () => {
+        const { Linter } = require("eslint/universal");
+
+        assert.ok(Linter);
+        assert.ok(typeof Linter === "function");
+
+
+        const linter = new Linter();
+
+        assert.ok(linter);
+    });
+});