feat: add eslint rule about use build-in import node module (#48)

* feat: add eslint rule about use build-in import node module

* feat: update pnpm-lock.yaml

* fix: fix plugin-copy.ts module by eslint config

---------

Co-authored-by: winches <329487092@qq.com>

.eslintrc

@@ -13,7 +13,8 @@
     "unused-imports",
     "sort-keys-fix",
     "sort-destructure-keys",
-    "prettier"
+    "prettier",
+    "unicorn"
   ],
   "parserOptions": {
     "sourceType": "module",
@@ -98,6 +99,8 @@
           "caseInsensitive": true
         }
       }
-    ]
+    ],
+    "unicorn/better-regex": "error",
+    "unicorn/prefer-node-protocol": "error"
   }
 }

package.json

@@ -85,6 +85,7 @@
     "eslint-plugin-prettier": "5.0.0",
     "eslint-plugin-sort-destructure-keys": "1.5.0",
     "eslint-plugin-sort-keys-fix": "1.1.2",
+    "eslint-plugin-unicorn": "52.0.0",
     "eslint-plugin-unused-imports": "3.0.0",
     "husky": "8.0.3",
     "lint-staged": "14.0.1",

plugins/plugin-copy.ts

@@ -1,6 +1,6 @@
 import type {Options} from 'tsup';
 
-import {copyFileSync} from 'fs';
+import {copyFileSync} from 'node:fs';
 
 import {resolver} from 'src/constants/path';
 

src/constants/path.ts

@@ -1,5 +1,5 @@
-import {resolve} from 'path';
-import {fileURLToPath} from 'url';
+import {resolve} from 'node:path';
+import {fileURLToPath} from 'node:url';
 
 export const ROOT = process.cwd();
 export const resolver = (path: string) => resolve(ROOT, path);

src/constants/required.ts

@@ -25,7 +25,7 @@ export const DOCS_PROVIDER_SETUP = 'https://nextui.org/docs/guide/installation#p
 
 // Record the required content of tailwind.config file
 export const tailwindRequired = {
-  checkPluginsRegex: /nextui(([\w\W]+)?)/,
+  checkPluginsRegex: /nextui(([\W\w]+)?)/,
   content: './node_modules/@nextui-org/theme/dist/**/*.{js,ts,jsx,tsx}',
   darkMode: 'darkMode: "class"',
   importContent: (isTypescript = false) => {

src/helpers/exec.ts

@@ -1,6 +1,6 @@
 import type {AppendKeyValue} from './type';
 
-import {type CommonExecOptions, execSync} from 'child_process';
+import {type CommonExecOptions, execSync} from 'node:child_process';
 
 import {Logger} from './logger';
 import {omit} from './utils';

src/helpers/fetch.ts

@@ -1,5 +1,5 @@
-import {Readable} from 'stream';
-import {pipeline} from 'stream/promises';
+import {Readable} from 'node:stream';
+import {pipeline} from 'node:stream/promises';
 
 import retry from 'async-retry';
 import tar from 'tar';

src/helpers/fix.ts

@@ -33,7 +33,7 @@ export function fixProvider(appPath: string, options: FixProvider) {
 }
 
 function wrapWithNextUIProvider(content: string) {
-  const returnRegex = /return\s*\(([\s\S]*?)\);/g;
+  const returnRegex = /return\s*\(([\S\s]*?)\);/g;
   const wrappedCode = content.replace(returnRegex, (_, p1) => {
     return `return (
       <NextUIProvider>

src/helpers/match.ts

@@ -4,7 +4,7 @@
  * @param str
  */
 export function getMatchImport(str: string) {
-  const importRegexAll = /import {?\s*([\w\W]+?)\s*}? from ['"](.+)['"]/g;
+  const importRegexAll = /import {?\s*([\W\w]+?)\s*}? from ["'](.+)["']/g;
 
   const matchAll = str.match(importRegexAll) ?? [];
   const result: string[][] = [];
@@ -16,7 +16,7 @@ export function getMatchImport(str: string) {
   return result.length ? result : [];
 
   function matchImport(itemImport: string) {
-    const importRegex = /import {?\s*([\w\W]+?)\s*}? from ['"](.+)['"]/;
+    const importRegex = /import {?\s*([\W\w]+?)\s*}? from ["'](.+)["']/;
     const match = itemImport.match(importRegex) ?? [];
 
     return [match[1] ?? '', match[2] ?? ''];
@@ -37,7 +37,7 @@ export function getMatchArray(key: string, target: string) {
       target
         .match(mixinReg)?.[1]
         ?.split(/,\n/)
-        .map((i) => i.trim().replace(/[`'"]/g, ''))
+        .map((i) => i.trim().replace(/["'`]/g, ''))
         .filter(Boolean) ?? []
     );
 
@@ -77,7 +77,7 @@ export function replaceMatchArray(
     : targetArray.splice(
         insertIndex + 1,
         0,
-        `  ${key}: [${value.map((v) => v.replace(/['"`]/g, ''))}],`
+        `  ${key}: [${value.map((v) => v.replace(/["'`]/g, ''))}],`
       );
 
   return targetArray.join('\n');

src/helpers/remove.ts

@@ -56,7 +56,7 @@ export async function removeTailwind(
     tailwindContent = replaceMatchArray('plugins', tailwindContent, pluginsMatch);
 
     // Remove the import nextui content
-    tailwindContent = tailwindContent.replace(/(const|var|let|import)[\w\W]+?nextui.*?;\n/, '');
+    tailwindContent = tailwindContent.replace(/(const|var|let|import)[\W\w]+?nextui.*?;\n/, '');
   }
 
   // If there are already have all nextui content include then don't need to remove the content

src/scripts/helpers.ts

@@ -1,4 +1,4 @@
-import {exec} from 'child_process';
+import {exec} from 'node:child_process';
 import {existsSync, readFileSync, writeFileSync} from 'node:fs';
 
 import retry from 'async-retry';