@plugjs/eslint-plugin 0.2.5 → 0.2.6

package/configs/javascript.mjs

@@ -1,4 +1,28 @@
 /** Basic extra rules for JavaScript sources. */
+import process from 'node:process'
+import path from 'node:path'
+import fs from 'node:fs'
+
+import globals from 'globals'
+
+function findModuleType(directory) {
+  const file = path.join(directory, 'package.json')
+  try {
+    const data = JSON.parse(fs.readFileSync(file, 'utf-8'))
+    return data.type || 'commonjs'
+  } catch (error) {
+    if (error.code !== 'ENOENT') {
+      throw new Error(`Error reading "${file}"`, { cause: error })
+    }
+
+    const parent = path.dirname(directory)
+    if (parent === directory) return 'commonjs'
+    return findModuleType(parent)
+  }
+}
+
+const moduleType = findModuleType(process.cwd())
+
 export const javascript = {
   name: 'plugjs-javascript',
 
@@ -21,10 +45,11 @@ export const javascript = {
 export const javascriptCommonJs = {
   name: 'plugjs-javascript-cjs',
 
-  files: [ '*.cjs' ],
+  files: moduleType === 'commonjs' ? [ '**/*.cjs', '**/*.js' ] : [ '**/*.cjs' ],
 
   languageOptions: {
     sourceType: 'commonjs',
+    globals: globals.node,
   },
 }
 
@@ -32,10 +57,11 @@ export const javascriptCommonJs = {
 export const javascriptModule = {
   name: 'plugjs-javascript-esm',
 
-  files: [ '*.mjs' ],
+  files: moduleType === 'module' ? [ '**/*.mjs', '**/*.js' ] : [ '**/*.mjs' ],
 
   languageOptions: {
     sourceType: 'module',
+    globals: globals.nodeBuiltin,
   },
 }
 

package/eslint.config.mjs

@@ -1,43 +1,16 @@
-import js from '@eslint/js'
+import configurations from './index.mjs'
 
-import basic from './configs/basic.mjs'
-import javascript from './configs/javascript.mjs'
-import typescript from './configs/typescript.mjs'
-
-export * from './configs/basic.mjs'
-export * from './configs/javascript.mjs'
-
-/**
- * Base `ESLint` configuration for PlugJS.
- *
- * This includes a number of configurations:
- *
- * * `eslint-recommended`: recommended JavaScript config from ESLint.
- *
- * * `plugjs-base`: basic configuration of ESLint rules.
- * * `plugjs-stylistic`: style shared between JavaScript and TypeScript.
- * * `plugjs-unicorn`: extra niceties from the ESLint Unicorn plugin.
- * * `plugjs-importx`: defines the style of our imports.
- *
- * * `plugjs-javascript`: basic extra rules for JavaScript sources.
- * * `plugjs-javascript-cjs`: marks `*.cjs` files as `commonjs`.
- * * `plugjs-javascript-mjs`: marks `*.mjs` files as `module`.
- *
- * * `typescript-eslint/recommended`: imports all the configurations from
- *   TypeScript ESlint recommended, but restrict them to operate only on
- *   `.ts`, `.cts`, and `.mts` files. This *should* include:
- *   * `typescript-eslint/base`: basic parser configuration.
- *   * `typescript-eslint/eslint-recommended`: disable ESLint rules conflicting
- *     with TypeScript.
- *   * `typescript-eslint/recommended`: recommended config for TypeScript
- * * `plugjs-typescript`: our rules overriding `typescript-eslint/recommended`.
- */
 export default [
-  { // give a name to this config before we go completely nuts!
-    name: 'eslint/js/recommended',
-    ...js.configs.recommended,
+  ...configurations,
+
+  // ===== IGNORED FILES =======================================================
+  // REMEMBER! Ignores *must* be in its own configuration, they can not coexist
+  // with "rules", "languageOptions", "files", ... or anything else, otherwise
+  // ESLint will blaantly ignore the ignore files!
+  {
+    ignores: [
+      'bundles/',
+      'node_modules/',
+    ],
   },
-  ...basic,
-  ...javascript,
-  ...typescript,
 ]

package/index.mjs

@@ -0,0 +1,43 @@
+import js from '@eslint/js'
+
+import basic from './configs/basic.mjs'
+import javascript from './configs/javascript.mjs'
+import typescript from './configs/typescript.mjs'
+
+export * from './configs/basic.mjs'
+export * from './configs/javascript.mjs'
+
+/**
+ * Base `ESLint` configuration for PlugJS.
+ *
+ * This includes a number of configurations:
+ *
+ * * `eslint-recommended`: recommended JavaScript config from ESLint.
+ *
+ * * `plugjs-base`: basic configuration of ESLint rules.
+ * * `plugjs-stylistic`: style shared between JavaScript and TypeScript.
+ * * `plugjs-unicorn`: extra niceties from the ESLint Unicorn plugin.
+ * * `plugjs-importx`: defines the style of our imports.
+ *
+ * * `plugjs-javascript`: basic extra rules for JavaScript sources.
+ * * `plugjs-javascript-cjs`: marks `*.cjs` files as `commonjs`.
+ * * `plugjs-javascript-mjs`: marks `*.mjs` files as `module`.
+ *
+ * * `typescript-eslint/recommended`: imports all the configurations from
+ *   TypeScript ESlint recommended, but restrict them to operate only on
+ *   `.ts`, `.cts`, and `.mts` files. This *should* include:
+ *   * `typescript-eslint/base`: basic parser configuration.
+ *   * `typescript-eslint/eslint-recommended`: disable ESLint rules conflicting
+ *     with TypeScript.
+ *   * `typescript-eslint/recommended`: recommended config for TypeScript
+ * * `plugjs-typescript`: our rules overriding `typescript-eslint/recommended`.
+ */
+export default [
+  { // give a name to this config before we go completely nuts!
+    name: 'eslint/js/recommended',
+    ...js.configs.recommended,
+  },
+  ...basic,
+  ...javascript,
+  ...typescript,
+]

package/package.json

@@ -1,23 +1,37 @@
 {
   "name": "@plugjs/eslint-plugin",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "Shared ESLint configurations and extras",
-  "main": "./eslint.config.mjs",
+  "main": "./index.mjs",
   "type": "module",
   "author": "Team Juit <developers@juit.com>",
   "license": "Apache-2.0",
   "scripts": {
-    "build": "eslint build.mjs eslint.config.mjs configs"
+    "build": "eslint"
   },
   "peerDependencies": {
     "eslint": "^9.7.0"
   },
   "files": [
     "*.md",
-    "eslint.config.mjs",
     "bundles/",
-    "configs/"
+    "configs/",
+    "eslint.config.mjs",
+    "index.mjs"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/plugjs/eslint-plugin.git"
+  },
+  "keywords": [
+    "validation",
+    "typescript",
+    "javascript"
+  ],
+  "bugs": {
+    "url": "https://github.com/plugjs/eslint-plugin/issues"
+  },
+  "homepage": "https://github.com/plugjs/eslint-plugin#readme",
   "dependencies": {
     "@eslint/js": "9.7.0",
     "@rtsao/scc": "1.1.0",