@tuomashatakka/eslint-config 2.2.2 → 2.2.3

package/README.md

@@ -1,9 +1,57 @@
-# Rules for my linter
+# @tuomashatakka/eslint-config
 
-Heavily opionated yet heavily clean and effective linter configuration for ESLint.
+> Opinionated yet functional AF base config for ESLint using the new flat config format
 
-For Next, React and TS
+For Next.js, React and TypeScript projects.
 
+## Installation
+
+```bash
+npm install --save-dev @tuomashatakka/eslint-config
+```
+
+## Usage
+
+### Using the full config
+
+Create an `eslint.config.js` file in your project root:
+
+```javascript
+import config from '@tuomashatakka/eslint-config'
+
+export default config
+```
+
+### Using just the rules
+
+If you want to use only the rules in your own config:
+
+```javascript
+import { rules } from '@tuomashatakka/eslint-config'
+
+export default [
+  // Your custom config here
+  {
+    // ...
+    rules
+  }
+]
+```
+
+## Features
+
+- TypeScript support
+- React/JSX support
+- Modern JavaScript features
+- Stylistic rules for consistent code formatting
+- Import/export validation
+
+## Structure
+
+The package uses ESLint's flat config format and has a simple structure:
+
+- `index.mjs` - Exports the full config and rules
+- `rules.mjs` - Contains all the ESLint rules
 
 ### Todo
 
@@ -11,3 +59,7 @@ For Next, React and TS
 - I really love Python's enforced linting style for having two rows between major blocks
   and 1 row between minor. I should finish my block padding plugin some day for the ESLinter.
   My linting rules would really appreciate that.
+
+## License
+
+ISC

package/eslint.config.js

@@ -0,0 +1,4 @@
+import { config } from './index.js'
+
+
+export default config

package/{eslint.config.mjs → index.js}

@@ -1,4 +1,3 @@
-/* eslint-disable multiline-comment-style */
 import stylistic from '@stylistic/eslint-plugin'
 import tsplugin from '@typescript-eslint/eslint-plugin'
 import importPlugin from 'eslint-plugin-import'
@@ -6,7 +5,7 @@ import react from 'eslint-plugin-react'
 import globals from 'globals'
 import tseslint from 'typescript-eslint'
 
-import rules from './rules.mjs'
+import { rules } from './rules.js'
 
 
 const plugins = {
@@ -18,11 +17,13 @@ const plugins = {
 
 /**
  * @type {tseslint.configs.base}
- **/
+ */
 const config = tseslint.config(
   ...tseslint.configs.recommended,
   {
     languageOptions: {
+      ecmaVersion:   'latest',
+      sourceType:    'module',
       parserOptions: {
         ecmaFeatures: {
           jsx: true,
@@ -46,13 +47,31 @@ const config = tseslint.config(
     },
     plugins,
     rules,
+  },
+  {
+    files:           [ '**/*.{js,jsx,mjs,cjs,ts,tsx}' ],
+    languageOptions: {
+      ecmaVersion:   'latest',
+      sourceType:    'module',
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+      globals: {
+        ...globals.browser,
+      },
+    }
   }
 )
 
 /**
  * @summary ESLint configuration
  * @description Opinionated yet functional AF base config for ESLint
- * @author {@author}
- * @version {@version}
- **/
+ */
 export default config
+
+export {
+  config,
+  rules
+}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@tuomashatakka/eslint-config",
-  "version": "2.2.2",
+  "version": "2.2.3",
   "description": "Default eslint configuration",
   "type": "module",
-  "main": "index.mjs",
+  "main": "index.js",
   "scripts": {
-    "lint": "eslint . --config eslint.config.mjs"
+    "lint": "eslint . --config index.mjs"
   },
   "repository": {
     "type": "git",

package/{rules.mjs → rules.js}

@@ -2,7 +2,6 @@
  * @exports {import("eslint/rules").ESLintRules} rules
  * @type {import("@eslint/core").RulesConfig}
  */
-
 export const rules = {
 
   // '@next/next/no-styled-jsx-in-document':    [ 'error' ],
@@ -193,4 +192,5 @@ export const rules = {
   '@stylistic/space-before-function-paren':  [ 1, 'always' ]
 }
 
+// Make sure we export both named and default exports
 export default rules

package/index.mjs

@@ -1,34 +0,0 @@
-import globals from 'globals'
-import tseslint from 'typescript-eslint'
-
-import config from './eslint.config.mjs'
-
-
-const configType = tseslint.configs.base
-
-/**
- * @name config
- * @type {typeof configType}
- */
-export default [
-  ...config,
-  {
-    files:           [ '**/*.{js,jsx,mjs,cjs,ts,tsx}' ],
-    languageOptions: {
-      ecmaVersion:   'latest',
-      sourceType:    'module',
-      parserOptions: {
-        ecmaFeatures: {
-          jsx: true,
-        },
-      },
-      globals: {
-        ...globals.browser,
-      },
-    }
-  }]
-
-export {
-  config,
-  configType
-}