eslint-plugin-n 15.1.0 → 15.2.0

package/README.md

@@ -93,7 +93,7 @@ $ npm install --save-dev eslint eslint-plugin-n
 | Rule ID | Description |    |
 |:--------|:------------|:--:|
 | [n/callback-return](./docs/rules/callback-return.md) | require `return` statements after callbacks |  |
-| [n/exports-style](./docs/rules/exports-style.md) | enforce either `module.exports` or `exports` |  |
+| [n/exports-style](./docs/rules/exports-style.md) | enforce either `module.exports` or `exports` | ✒️ |
 | [n/file-extension-in-import](./docs/rules/file-extension-in-import.md) | enforce the style of file extensions in `import` declarations | ✒️ |
 | [n/global-require](./docs/rules/global-require.md) | require `require()` calls to be placed at top-level module scope |  |
 | [n/no-mixed-requires](./docs/rules/no-mixed-requires.md) | disallow `require` calls to be mixed with regular variable declarations |  |
@@ -167,7 +167,7 @@ Those preset config:
 
 ## 📰 Changelog
 
--   [GitHub Releases](https://github.com/weiran-zsd/eslint-plugin-n/releases)
+-   [GitHub Releases](https://github.com/weiran-zsd/eslint-plugin-node/releases)
 
 ## ❤️ Contributing
 

package/lib/rules/exports-style.js

@@ -139,6 +139,90 @@ function getExportsNodes(scope) {
     return variable.references.map(reference => reference.identifier)
 }
 
+function getReplacementForProperty(property, sourceCode) {
+    if (property.type !== "Property" || property.kind !== "init") {
+        // We don't have a nice syntax for adding these directly on the exports object. Give up on fixing the whole thing:
+        // property.kind === 'get':
+        //   module.exports = { get foo() { ... } }
+        // property.kind === 'set':
+        //   module.exports = { set foo() { ... } }
+        // property.type === 'SpreadElement':
+        //   module.exports = { ...foo }
+        return null
+    }
+
+    let fixedValue = sourceCode.getText(property.value)
+    if (property.method) {
+        fixedValue = `function${
+            property.value.generator ? "*" : ""
+        } ${fixedValue}`
+        if (property.value.async) {
+            fixedValue = `async ${fixedValue}`
+        }
+    }
+    const lines = sourceCode
+        .getCommentsBefore(property)
+        .map(comment => sourceCode.getText(comment))
+    if (property.key.type === "Literal" || property.computed) {
+        // String or dynamic key:
+        // module.exports = { [ ... ]: ... } or { "foo": ... }
+        lines.push(
+            `exports[${sourceCode.getText(property.key)}] = ${fixedValue};`
+        )
+    } else if (property.key.type === "Identifier") {
+        // Regular identifier:
+        // module.exports = { foo: ... }
+        lines.push(`exports.${property.key.name} = ${fixedValue};`)
+    } else {
+        // Some other unknown property type. Conservatively give up on fixing the whole thing.
+        return null
+    }
+    lines.push(
+        ...sourceCode
+            .getCommentsAfter(property)
+            .map(comment => sourceCode.getText(comment))
+    )
+    return lines.join("\n")
+}
+
+// Check for a top level module.exports = { ... }
+function isModuleExportsObjectAssignment(node) {
+    return (
+        node.parent.type === "AssignmentExpression" &&
+        node.parent.parent.type === "ExpressionStatement" &&
+        node.parent.parent.parent.type === "Program" &&
+        node.parent.right.type === "ObjectExpression"
+    )
+}
+
+// Check for module.exports.foo or module.exports.bar reference or assignment
+function isModuleExportsReference(node) {
+    return (
+        node.parent.type === "MemberExpression" && node.parent.object === node
+    )
+}
+
+function fixModuleExports(node, sourceCode, fixer) {
+    if (isModuleExportsReference(node)) {
+        return fixer.replaceText(node, "exports")
+    }
+    if (!isModuleExportsObjectAssignment(node)) {
+        return null
+    }
+    const statements = []
+    const properties = node.parent.right.properties
+    for (const property of properties) {
+        const statement = getReplacementForProperty(property, sourceCode)
+        if (statement) {
+            statements.push(statement)
+        } else {
+            // No replacement available, give up on the whole thing
+            return null
+        }
+    }
+    return fixer.replaceText(node.parent, statements.join("\n\n"))
+}
+
 module.exports = {
     meta: {
         docs: {
@@ -148,7 +232,7 @@ module.exports = {
             url: "https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/exports-style.md",
         },
         type: "suggestion",
-        fixable: null,
+        fixable: "code",
         schema: [
             {
                 //
@@ -253,6 +337,9 @@ module.exports = {
                     loc: getLocation(node),
                     message:
                         "Unexpected access to 'module.exports'. Use 'exports' instead.",
+                    fix(fixer) {
+                        return fixModuleExports(node, sourceCode, fixer)
+                    },
                 })
             }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "eslint-plugin-n",
-    "version": "15.1.0",
+    "version": "15.2.0",
     "description": "Additional ESLint's rules for Node.js",
     "engines": {
         "node": ">=12.22.0"