eslint-plugin-bunisms 0.1.0 → 0.2.0

package/README.md

@@ -27,6 +27,7 @@ export default defineConfig({
     'bun/prefer-bun-file': 'warn',
     'bun/prefer-bun-write': 'warn',
     'bun/prefer-bun-spawn': 'warn',
+    'bun/prefer-import-meta-path': 'warn',
   },
 });
 ```
@@ -46,15 +47,16 @@ ESLint needs [`jiti`](https://github.com/unjs/jiti) to load a TypeScript config
 
 ## Rules
 
-| Rule                                                   | Recommends                                                                 |
-| ------------------------------------------------------ | -------------------------------------------------------------------------- |
-| [bun/prefer-bun-file](docs/rules/prefer-bun-file.md)   | `Bun.file()` instead of Node's `readFile()`                                |
-| [bun/prefer-bun-write](docs/rules/prefer-bun-write.md) | `Bun.write()` instead of Node's `writeFile()`                              |
-| [bun/prefer-bun-spawn](docs/rules/prefer-bun-spawn.md) | `Bun.spawn()` / `Bun.spawnSync()` instead of Node's subprocess equivalents |
+| Rule                                                                 | Recommends                                                                 |
+| -------------------------------------------------------------------- | -------------------------------------------------------------------------- |
+| [bun/prefer-bun-file](docs/rules/prefer-bun-file.md)                 | `Bun.file()` instead of Node's `readFile()`                                |
+| [bun/prefer-bun-write](docs/rules/prefer-bun-write.md)               | `Bun.write()` instead of Node's `writeFile()`                              |
+| [bun/prefer-bun-spawn](docs/rules/prefer-bun-spawn.md)               | `Bun.spawn()` / `Bun.spawnSync()` instead of Node's subprocess equivalents |
+| [bun/prefer-import-meta-path](docs/rules/prefer-import-meta-path.md) | `import.meta.path` instead of `fileURLToPath(import.meta.url)`             |
 
 Rules recognize imports, aliases and CommonJS bindings, respecting lexical scope. They report calls without automatically rewriting them: Node and Bun APIs have different options and return values.
 
-The `recommended`, `strict` and `all` ESLint presets currently enable all three rules as warnings. Override individual rules after the preset:
+The `recommended`, `strict` and `all` ESLint presets currently enable all four rules as warnings. Override individual rules after the preset:
 
 ```ts
 export default [bun.configs.recommended, { rules: { 'bun/prefer-bun-file': 'error' } }];
@@ -70,7 +72,7 @@ Apply the plugin only to code intended for Bun. For a mixed-runtime project, sco
 export default [{ ...bun.configs.recommended, files: ['scripts/**/*.ts'] }];
 ```
 
-See [Contributing](CONTRIBUTING.md) for development and [the roadmap](https://github.com/himynameisdave/eslint-plugin-bunisms/blob/main/docs/roadmap.md) for planned rules.
+See [Contributing](CONTRIBUTING.md) for development, [the roadmap](https://github.com/himynameisdave/eslint-plugin-bunisms/blob/main/docs/roadmap.md) for planned rules, and [Versioning](https://github.com/himynameisdave/eslint-plugin-bunisms/blob/main/VERSIONING.md) for the release policy.
 
 ## See also
 

package/dist/index.d.ts

@@ -3,6 +3,7 @@ declare const rules: {
     'prefer-bun-file': import("eslint").Rule.RuleModule;
     'prefer-bun-write': import("eslint").Rule.RuleModule;
     'prefer-bun-spawn': import("eslint").Rule.RuleModule;
+    'prefer-import-meta-path': import("eslint").Rule.RuleModule;
 };
 type Preset = 'recommended' | 'strict' | 'all';
 declare const plugin: ESLint.Plugin & {

package/dist/index.js

@@ -1,7 +1,7 @@
 // package.json
 var package_default = {
   name: "eslint-plugin-bunisms",
-  version: "0.1.0",
+  version: "0.2.0",
   description: "ESLint rules for idiomatic and correct Bun code.",
   keywords: [
     "bun",
@@ -43,6 +43,7 @@ var package_default = {
     "format:check": "oxfmt --check",
     lint: "oxlint -c oxlint.config.ts --deny-warnings",
     "lint:fix": "bun run lint --fix",
+    prepare: "git config core.hooksPath .githooks",
     prepublishOnly: "bun run check",
     test: "bun test tests/rules.test.ts",
     "test:node": "node --test tests/node.test.mjs",
@@ -236,11 +237,47 @@ var prefer_bun_spawn_default = createRule("prefer-bun-spawn", { spawn: "Bun.spaw
 // src/rules/prefer-bun-write.ts
 var prefer_bun_write_default = createRule("prefer-bun-write", { writeFile: "Bun.write()" }, ["fs", "fs/promises"], true);
 
+// src/rules/prefer-import-meta-path.ts
+function isImportMetaUrl(node) {
+  if (node?.type !== "MemberExpression" || node.computed) {
+    return false;
+  }
+  const { object, property } = node;
+  return object.type === "MetaProperty" && object.meta.name === "import" && object.property.name === "meta" && property.type === "Identifier" && property.name === "url";
+}
+var rule = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "Prefer import.meta.path to convert the current module URL to a filesystem path.",
+      url: "https://github.com/himynameisdave/eslint-plugin-bunisms/blob/main/docs/rules/prefer-import-meta-path.md"
+    },
+    schema: [],
+    messages: { preferImportMetaPath: "Prefer import.meta.path for the current module path." }
+  },
+  create(context) {
+    return {
+      CallExpression(node) {
+        if (node.arguments.length !== 1 || !isImportMetaUrl(node.arguments[0])) {
+          return;
+        }
+        const reference = resolveBuiltin(context, node.callee);
+        if (reference?.module !== "url" || reference.path.join(".") !== "fileURLToPath") {
+          return;
+        }
+        context.report({ node, messageId: "preferImportMetaPath" });
+      }
+    };
+  }
+};
+var prefer_import_meta_path_default = rule;
+
 // src/index.ts
 var rules = {
   "prefer-bun-file": prefer_bun_file_default,
   "prefer-bun-write": prefer_bun_write_default,
-  "prefer-bun-spawn": prefer_bun_spawn_default
+  "prefer-bun-spawn": prefer_bun_spawn_default,
+  "prefer-import-meta-path": prefer_import_meta_path_default
 };
 var plugin = {
   meta: { name: "eslint-plugin-bunisms", version: package_default.version },

package/dist/rules/prefer-import-meta-path.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/docs/rules/prefer-import-meta-path.md

@@ -0,0 +1,36 @@
+# bun/prefer-import-meta-path
+
+Prefer Bun's `import.meta.path` when converting the current module URL to a filesystem path.
+
+## Incorrect
+
+```ts
+import { fileURLToPath } from 'node:url';
+
+const path = fileURLToPath(import.meta.url);
+```
+
+## Preferred
+
+```ts
+const path = import.meta.path;
+```
+
+Bun exposes `import.meta.path` as the absolute path of the current module. It is the path equivalent of `import.meta.url`, which is a `file:` URL. Use this rule only for code that runs on Bun.
+
+The rule recognizes direct `fileURLToPath` imports from `url` or `node:url`, including aliases, namespace/default imports, and CommonJS `require()` bindings. It reports only a call with exactly one argument whose expression is `import.meta.url`. It does not report other file URLs, computed properties, shadowed bindings, type-only imports, or unrelated functions with the same name. It does not use TypeScript type information.
+
+## When not to use it
+
+Do not enable this rule for files that also run in Node.js or another runtime. `import.meta.path` is a Bun-specific property. The rule does not suggest a fix because replacing the expression can require changing imports and may be inappropriate for shared-runtime code.
+
+## Options
+
+This rule has no options.
+
+## Bun compatibility
+
+The plugin targets Bun 1.4.0 and later. Bun's current documentation describes `import.meta.path` as the absolute path to the current file and `import.meta.url` as its file URL.
+
+- [Bun `import.meta` documentation](https://bun.sh/docs/runtime/module-resolution#importmeta)
+- [Bun `fileURLToPath` utility](https://bun.sh/docs/runtime/utils#bunfileurltopath)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-bunisms",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "ESLint rules for idiomatic and correct Bun code.",
   "keywords": [
     "bun",
@@ -42,6 +42,7 @@
     "format:check": "oxfmt --check",
     "lint": "oxlint -c oxlint.config.ts --deny-warnings",
     "lint:fix": "bun run lint --fix",
+    "prepare": "git config core.hooksPath .githooks",
     "prepublishOnly": "bun run check",
     "test": "bun test tests/rules.test.ts",
     "test:node": "node --test tests/node.test.mjs",