chore: add prettier & lint-staged (#7)

* chore: add prettier & lint-staged

the package was using eslint to enforce a code style(@mysticatea/eslint-config)
while it's no longer maintained. It just added a prettier config to be close to
the eslint config

* fix: ignore .eslintcache

* chore: do not run prettier on md files for less changes

* chore: fix linting errors

refs: prettier/prettier#12137

* chore: prettier lib/* tests/lib/*

* chore: add eol

Author: aladdin-add

.eslintrc.js

@@ -8,11 +8,16 @@
 // to make the ci passing.
 module.exports = {
     reportUnusedDisableDirectives: true,
-    extends: ["eslint:recommended", "plugin:n/recommended", "plugin:eslint-plugin/recommended"],
+    extends: [
+        "eslint:recommended",
+        "plugin:n/recommended",
+        "plugin:eslint-plugin/recommended",
+        "prettier",
+    ],
     env: {
         mocha: true,
-    }
-};
+    },
+}
 
 // const version = require("./package.json").version
 

.gitignore

@@ -3,3 +3,4 @@
 /npm-debug.log
 /node_modules
 /test.js
+.eslintcache

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.prettierrc

@@ -0,0 +1,16 @@
+{
+  "useTabs": false,
+  "semi": false,
+  "tabWidth": 4,
+  "arrowParens": "avoid",
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "printWidth": 70,
+        "trailingComma": "none",
+        "proseWrap": "never"
+      }
+    }
+  ]
+}

lib/index.js

@@ -46,7 +46,7 @@ module.exports = {
         "prefer-promises/dns": require("./rules/prefer-promises/dns"),
         "prefer-promises/fs": require("./rules/prefer-promises/fs"),
         "process-exit-as-throw": require("./rules/process-exit-as-throw"),
-        "shebang": require("./rules/shebang"),
+        shebang: require("./rules/shebang"),
 
         // Deprecated rules.
         "no-hide-core-modules": require("./rules/no-hide-core-modules"),

lib/rules/callback-return.js

@@ -11,8 +11,7 @@ module.exports = {
             description: "require `return` statements after callbacks",
             category: "Stylistic Issues",
             recommended: false,
-            url:
-                "https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/callback-return.md",
+            url: "https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/callback-return.md",
         },
         schema: [
             {

lib/rules/exports-style.js

@@ -145,8 +145,7 @@ module.exports = {
             description: "enforce either `module.exports` or `exports`",
             category: "Stylistic Issues",
             recommended: false,
-            url:
-                "https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/exports-style.md",
+            url: "https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/exports-style.md",
         },
         type: "suggestion",
         fixable: null,

lib/rules/file-extension-in-import.js

@@ -9,7 +9,8 @@ const fs = require("fs")
 const getTryExtensions = require("../util/get-try-extensions")
 const visitImport = require("../util/visit-import")
 const packageNamePattern = /^(?:@[^/\\]+[/\\])?[^/\\]+$/u
-const corePackageOverridePattern = /^(?:assert|async_hooks|buffer|child_process|cluster|console|constants|crypto|dgram|dns|domain|events|fs|http|http2|https|inspector|module|net|os|path|perf_hooks|process|punycode|querystring|readline|repl|stream|string_decoder|sys|timers|tls|trace_events|tty|url|util|v8|vm|worker_threads|zlib)[/\\]$/u
+const corePackageOverridePattern =
+    /^(?:assert|async_hooks|buffer|child_process|cluster|console|constants|crypto|dgram|dns|domain|events|fs|http|http2|https|inspector|module|net|os|path|perf_hooks|process|punycode|querystring|readline|repl|stream|string_decoder|sys|timers|tls|trace_events|tty|url|util|v8|vm|worker_threads|zlib)[/\\]$/u
 
 /**
  * Get all file extensions of the files which have the same basename.
@@ -38,8 +39,7 @@ module.exports = {
                 "enforce the style of file extensions in `import` declarations",
             category: "Stylistic Issues",
             recommended: false,
-            url:
-                "https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/file-extension-in-import.md",
+            url: "https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/file-extension-in-import.md",
         },
         fixable: "code",
         messages: {

lib/rules/global-require.js

@@ -55,8 +55,7 @@ module.exports = {
                 "require `require()` calls to be placed at top-level module scope",
             category: "Stylistic Issues",
             recommended: false,
-            url:
-                "https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/global-require.md",
+            url: "https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/global-require.md",
         },
         fixable: null,
         schema: [],