Add prefer-import-meta-properties rule

[ota-meshi]

This PR adds prefer-import-meta-properties rule that reports the following code:

import path from "path";
import { fileURLToPath } from "url";
const dirname1 = path.dirname(fileURLToPath(import.meta.url));
const dirname2 = path.dirname(import.meta.filename);
const dirname3 = fileURLToPath(new URL(".", import.meta.url));
const filename1 = fileURLToPath(import.meta.url);
const filename2 = fileURLToPath(new URL(import.meta.url));

close #2255

[ota-meshi]

I realized that new URL(".", import.meta.url).pathname shouldn't be reported because it can be used in the browser.
I'll change this PR.

[ota-meshi]

I have changed this PR.

[fisker]

I realized that new URL(".", import.meta.url).pathname shouldn't be reported because it can be used in the browser. I'll change this PR.

new URL("./", import.meta.url).pathname should use the same logic.

[ota-meshi]

Thank you!
I changed it to check new URL("./", ...) as well.

[fisker]

Should import.meta already ensure these files are in ESM? Why this check needed?

[fisker]

Should we give the community some time to drop Node.js 18, and add an option instead?

[ota-meshi]

Oh, you're right, no need to check for mjs 😓
It's definitely an ESM because it already uses import.meta.
I'll change that.

[ota-meshi]

Should we give the community some time to drop Node.js 18, and add an option instead?

With Node v18 reaching EOL next month, I'm not sure if it should be an option 😅

#2255 (comment)

[ota-meshi]

Thank you for your review!
I have made some changes to this PR.

[fisker]

@ota-meshi Please take a look

[ota-meshi]

Thank you for reviewing this PR!
I've made some changes to this PR, could you please check it again?

[fisker]

Pushed some commits, most of them are making all kinds of check stricter and improve readability.

[fisker]

Due to bug in iterateProblemsFromFilename, I found a broken case 7816928 , can you fix?

[ota-meshi]

I think it's the same test case as L406, and I think it's intentional. Any suggestions on how to fix it 🤔

[fisker]

I think it's the same test case as L406, and I think it's intentional. Any suggestions on how to fix it 🤔

Sorry, I was wrong about it.

[fisker]

Everything looks good to me, except one thing.

Do you think it's possible that we break this case?

const x = new URL(import.meta.url).pathname
const filename = isWindows() ? x.slice(1) :x

Since new URL('file:///C:/file').pathname is actually /C:/file, not C:/file

[fisker]

Also, about this

Should we give the community some time to drop Node.js 18, and add an option instead?

Your answer make sense to me

With Node v18 reaching EOL next month, I'm not sure if it should be an option 😅

But I don't want people to disable this rule only because their target environment doesn't have import.meta.{dirname,filename}.

Personally, I even prefer add this PR as a separate rule, this part also not technically "prefer-module".

import.meta maybe also keep adding new stuff, having a separate rule should be easier to maintain.

@sindresorhus What do you think?

[ota-meshi]

Since new URL('file:///C:/file').pathname is actually /C:/file, not C:/file

Thank you for your comment, I didn't know it would return different results for Windows paths 😅
I will change it to not report .pathname.

[ota-meshi]

Personally, I even prefer add this PR as a separate rule, this part also not technically "prefer-module".

By the way, originally I wanted a rule to be added to convert path.dirname(fileURLToPath(import.meta.url)) to import.meta.dirname. I searched for similar issues in this repository and found #2255, so I implemented it in prefer-module and opened a PR.
It's useful for me either in the prefer-module rule or in another rule 😄

[sindresorhus]

It could be a separate rule, but isn't it easier just to keep it in here under an option? We still want this rule to enforce not using __dirname, and we want a fix-it for that, and that fix it should ideally be import.meta.dirname (when an option is enabled). So while a different rule could handle the fileURLToPath(import.meta.url) and path.dirname(import.meta.filename) case. It just seems easier to have it all here.

[fisker]

__dirname

We already provide both
import.meta.dirname and path.dirname(url.fileURLToPath(import.meta.url)) as suggestion.

If the new rule enabled, it doesn't matter which one user choose, user will end up using import.meta.dirname.

Since you are not against seperate rule, let's do it.

My suggestion for rule name is prefer-import-meta-properties.

[ota-meshi]

My suggestion for rule name is prefer-import-meta-properties.

👍

I will change this PR to add the new rule.

[fisker]

Good job! Thank you!