fix: use cjs and specify commonjs type package

aminya · aminya · commit e0bd7bbc503a · 2023-09-30T01:07:02.000-07:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,4 +1,4 @@
 {
-  "extends": "./strict",
+  "extends": "eslint-config-atomic/strict",
   "ignorePatterns": ["dist/", "node_modules/"]
 }
diff --git a/index.js b/index.js
@@ -1 +1 @@
-module.exports = require("./dist/index.js").default
+module.exports = require("./dist/index.cjs").default
diff --git a/package.json b/package.json
@@ -5,20 +5,22 @@
   "repository": "https://github.com/atom-ide-community/eslint-config-atomic",
   "license": "MIT",
   "author": "Amin Yahyaabadi",
-  "main": "index.js",
+  "type": "commonjs",
+  "main": "index.cjs",
   "files": [
     "src",
     "dist",
-    "*.js"
+    "*.cjs"
   ],
   "scripts": {
     "build": "tsc",
     "bump": "ncu -u -x coffeescript,execa,read-pkg-up",
-    "clean": "shx rm -rf ./spec/fixtures/atom-community ./spec/fixtures/atom-minimap ./spec/fixtures/steelbrain ./strict.js ./strict-react.js",
+    "clean": "shx rm -rf ./spec/fixtures/ ./dist",
     "format": "prettier --write .",
     "lint": "eslint . --ignore-pattern ./spec/fixtures/ --fix",
-    "prepare": "npm run build",
-    "test": "node ./spec/test.js",
+    "prepare": "pnpm run build",
+    "prepublishOnly": "pnpm run clean && pnpm run build",
+    "test": "node ./spec/test.cjs",
     "test.format": "prettier . --check",
     "test.lint": "eslint . --ignore-pattern spec/fixtures/**"
   },
@@ -58,11 +60,13 @@
     "@types/read-pkg-up": "^6.0.0",
     "@types/semver": "^7.5.3",
     "@types/shelljs": "^0.8.13",
+    "eslint-config-atomic": "link:",
     "execa": "^5.1.1",
     "gitly": "^2.4.5",
     "npm-check-updates": "16.14.4",
     "prettier-config-atomic": "^3.1.0",
-    "shelljs": "^0.8.5"
+    "shelljs": "^0.8.5",
+    "shx": "^0.3.4"
   },
   "peerDependencies": {
     "eslint": "^8 || ^7 || ^6"
@@ -80,7 +84,7 @@
     "lint",
     "prettier"
   ],
-  "react": "react.js",
-  "strict": "strict.js",
-  "strict-react": "strict-react.js"
-}
+  "react": "react.cjs",
+  "strict": "strict.cjs",
+  "strict-react": "strict-react.cjs"
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/react.js b/react.js
@@ -1 +1 @@
-module.exports = require("./dist/index-react.js").default
+module.exports = require("./dist/index-react.cjs").default
diff --git a/spec/test.cjs b/spec/test.cjs
diff --git a/src/coffeescript.cts b/src/coffeescript.cts
@@ -1,5 +1,5 @@
-import { pluginNodeRules } from "./plugin-node-rules.js"
-import { pluginImportRulesExtra } from "./plugin-import-rules.js"
+import { pluginNodeRules } from "./plugin-node-rules.cjs"
+import { pluginImportRulesExtra } from "./plugin-import-rules.cjs"
 
 export const coffeeConfig = {
   // CoffeeScript files
diff --git a/src/cson.cts b/src/cson.cts
@@ -1,4 +1,4 @@
-import { coffeeConfig } from "./coffeescript.js"
+import { coffeeConfig } from "./coffeescript.cjs"
 
 export const csonConfig = {
   ...coffeeConfig,
diff --git a/src/eslint-version.cts b/src/eslint-version.cts
@@ -2,7 +2,7 @@ import child_process from "child_process"
 import eslintPackageJson from "eslint/package.json"
 
 export function getEslintVersion() {
-  if (process.argv[1].includes("eslint.js")) {
+  if (process.argv[1].includes("eslint.cjs")) {
     const eslintVersion = child_process.execFileSync(process.argv[0], [process.argv[1], "--version"], {
       encoding: "utf8",
       stdio: "pipe",
diff --git a/src/html.cts b/src/html.cts
diff --git a/src/index-react.cts b/src/index-react.cts
@@ -1,5 +1,5 @@
-import base from "./index.js"
-import { tsConfig } from "./typescript"
+import base from "./index.cjs"
+import { tsConfig } from "./typescript.cjs"
 
 const nonStrictConfig = {
   ...base,
diff --git a/src/index-strict-react.cts b/src/index-strict-react.cts
@@ -1,4 +1,4 @@
-import nonStrictConfig from "./index-react.js"
+import nonStrictConfig from "./index-react.cjs"
 
 // remove only-warn from javascript
 if (nonStrictConfig.plugins[nonStrictConfig.plugins.length - 1] === "only-warn") {
diff --git a/src/index-strict.cts b/src/index-strict.cts
@@ -1,4 +1,4 @@
-import nonStrictConfig from "./index"
+import nonStrictConfig from "./index.cjs"
 
 // remove only-warn from javascript
 if (nonStrictConfig.plugins[nonStrictConfig.plugins.length - 1] === "only-warn") {
diff --git a/src/index.cts b/src/index.cts
@@ -1,13 +1,13 @@
-import { jsConfig } from "./javascript"
-import { tsConfig } from "./typescript"
-import { coffeeConfig } from "./coffeescript"
-import { jsonConfig } from "./json"
-import { csonConfig } from "./cson"
-import { yamlConfig } from "./yaml"
-import { htmlConfig } from "./html"
-import { pluginImportSettings } from "./plugin-import-rules"
+import { jsConfig } from "./javascript.cjs"
+import { tsConfig } from "./typescript.cjs"
+import { coffeeConfig } from "./coffeescript.cjs"
+import { jsonConfig } from "./json.cjs"
+import { csonConfig } from "./cson.cjs"
+import { yamlConfig } from "./yaml.cjs"
+import { htmlConfig } from "./html.cjs"
+import { pluginImportSettings } from "./plugin-import-rules.cjs"
 import semverLt from "semver/functions/lt"
-import { getEslintVersion } from "./eslint-version"
+import { getEslintVersion } from "./eslint-version.cjs"
 
 const overrides = [tsConfig, jsonConfig, yamlConfig, htmlConfig]
 
diff --git a/src/javascript.cts b/src/javascript.cts
@@ -1,6 +1,6 @@
-import { eslintRulesExtra } from "./official-eslint-rules"
-import { pluginNodeRules } from "./plugin-node-rules"
-import { pluginImportRulesExtra } from "./plugin-import-rules"
+import { eslintRulesExtra } from "./official-eslint-rules.cjs"
+import { pluginNodeRules } from "./plugin-node-rules.cjs"
+import { pluginImportRulesExtra } from "./plugin-import-rules.cjs"
 
 export const jsConfig = {
   parser: "@babel/eslint-parser",
diff --git a/src/json.cts b/src/json.cts
diff --git a/src/official-eslint-rules.cts b/src/official-eslint-rules.cts
diff --git a/src/plugin-import-rules.cts b/src/plugin-import-rules.cts
@@ -25,14 +25,14 @@ export const pluginImportTypeScriptRulesExtra = {
 export const pluginImportSettings = {
   "import/core-modules": ["atom", "electron"],
   // support TypeScript and Coffee importing
-  "import/extensions": [".ts", ".tsx", ".d.ts", ".js", ".jsx", ".coffee"],
+  "import/extensions": [".ts", ".tsx", ".cts", ".mts", ".d.ts", ".js", ".cjs", ".mjs", ".jsx", ".coffee"],
   "import/external-module-folders": ["node_modules", "node_modules/@types"],
   "import/parsers": {
     "@typescript-eslint/parser": [".ts", ".tsx", ".d.ts"],
   },
   "import/resolver": {
     node: {
-      extensions: [".ts", ".tsx", ".d.ts", ".js", ".jsx", ".coffee"],
+      extensions: [".ts", ".tsx", ".cts", ".mts", ".d.ts", ".js", ".cjs", ".mjs", ".jsx", ".coffee"],
     },
   },
 }
diff --git a/src/plugin-node-rules.cts b/src/plugin-node-rules.cts
diff --git a/src/typescript.cts b/src/typescript.cts
@@ -1,8 +1,8 @@
-import { eslintRulesExtra } from "./official-eslint-rules"
-import { pluginImportRulesExtra, pluginImportTypeScriptRulesExtra } from "./plugin-import-rules"
-import { pluginNodeRules } from "./plugin-node-rules"
+import { eslintRulesExtra } from "./official-eslint-rules.cjs"
+import { pluginImportRulesExtra, pluginImportTypeScriptRulesExtra } from "./plugin-import-rules.cjs"
+import { pluginNodeRules } from "./plugin-node-rules.cjs"
 import makeSynchronous from "make-synchronous"
-import { findOneFile } from "./utils"
+import { findOneFile } from "./utils.cjs"
 import type { GlobifiedEntry } from "globify-gitignore"
 
 const tsFiles = ["**/*.tsx", "**/*.ts"]
diff --git a/src/utils.cts b/src/utils.cts
diff --git a/src/yaml.cts b/src/yaml.cts
diff --git a/strict-react.js b/strict-react.js
@@ -1 +1 @@
-module.exports = require("./dist/index-strict-react.js").default
+module.exports = require("./dist/index-strict-react.cjs").default
diff --git a/strict.js b/strict.js
@@ -1 +1 @@
-module.exports = require("./dist/index-strict.js").default
+module.exports = require("./dist/index-strict.cjs").default

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`		`- "extends": "./strict",`
	`2`	`+ "extends": "eslint-config-atomic/strict",`
`3`	`3`	`"ignorePatterns": ["dist/", "node_modules/"]`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-module.exports = require("./dist/index.js").default`
	`1`	`+module.exports = require("./dist/index.cjs").default`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { coffeeConfig } from "./coffeescript.js"`
	`1`	`+import { coffeeConfig } from "./coffeescript.cjs"`
`2`	`2`
`3`	`3`	`export const csonConfig = {`
`4`	`4`	`...coffeeConfig,`