@zthun/janitor-eslint-config 21.2.4 → 21.2.5

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2024 Anthony Bonta
+Copyright (c) 2026 Anthony Bonta
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

package/README.md

@@ -6,23 +6,56 @@ This is the shared eslint configuration for zthun scoped projects.
 
 ```sh
 # NPM
-npm install @zthun/janitor-eslint-config --save-dev
+npm install @zthun/janitor-eslint-config eslint --save-dev
+
 # Yarn
-yarn add @zthun/janitor-eslint-config --dev
+yarn add @zthun/janitor-eslint-config eslint --dev
 ```
 
-Make sure to install typescript and @typescript-eslint/eslint-plugin with all
-peer dependencies.
-
 ## Usage
 
-In the .eslintrc file, add the following
+This package is only for a flat config. The legacy config is no longer
+supported.
+
+The lint files are divided into multiple configurations for each project, but
+for zthun scoped projects, you'll just use the recommended.
+
+In your eslint.config.mjs file, add the following.
+
+```ts
+import { environments, recommended } from "@zthun/janitor-eslint-config";
 
-```json
-{
-  "extends": ["@zthun/janitor-eslint-config"]
-}
+export default [...recommended, ...environments.node];
 ```
 
 That's it. You now have the recommended rules for zthun scoped projects with
-typescript.
+typescript. Note that using recommended also requires the prettier and
+typescript node packages to be installed.
+
+## Available configs
+
+| Config                                     | For                                                                                           | Recommended |
+| ------------------------------------------ | --------------------------------------------------------------------------------------------- | ----------- |
+| [html](./lib/configs/html.mjs)             | HTML linting                                                                                  | ✅          |
+| [ignores](./lib/configs/ignores.mjs)       | Standard global ignores for generated files and build outputs                                 | ✅          |
+| [javascript](./lib/configs/javascript.mjs) | JavaScript linting and import sorting                                                         | ✅          |
+| [json](./lib/configs/json.mjs)             | JSON, JSONC, and JSON5 linting                                                                | ✅          |
+| [markdown](./lib/configs/markdown.mjs)     | Markdown linting                                                                              | ✅          |
+| [prettier](./lib/configs/prettier.mjs)     | Code formatting with Prettier. Requires [prettier](https://prettier.io/)                      | ✅          |
+| [react](./lib/configs/react.mjs)           | React linting. Requires [react](https://react.dev/)                                           |             |
+| [spelling](./lib/configs/spelling.mjs)     | Spell checking with a project dictionary                                                      | ✅          |
+| [styles](./lib/configs/styles.mjs)         | CSS linting                                                                                   | ✅          |
+| [test](./lib/configs/test.mjs)             | Vitest test linting                                                                           | ✅          |
+| [typescript](./lib/configs/typescript.mjs) | TypeScript linting with type checking. Requires [typescript](https://www.typescriptlang.org/) | ✅          |
+| [yaml](./lib/configs/yaml.mjs)             | YAML linting                                                                                  | ✅          |
+
+## Environments
+
+You will probably need to add at least one environment to your eslint config.
+There are two main environments. You can add plugins for various globals by
+adding fields from the environment structure.
+
+| Environment                               | For                                 |
+| ----------------------------------------- | ----------------------------------- |
+| [browser](./lib/configs/environments.mjs) | Adds browser based globals          |
+| [node](./lib/configs/environments.mjs)    | Adds node globals and node builtins |

package/lib/configs/environments.mjs

@@ -11,7 +11,16 @@ function environment(environment) {
   });
 }
 
+/**
+ * Configurations for different environments.
+ */
 export const environments = {
+  /**
+   * Adds support for browser globals.
+   */
   browser: [...environment(globals.browser)],
+  /**
+   * Adds support for node globals and node built in apis.
+   */
   node: [...environment(globals.node), ...environment(globals.nodeBuiltin)],
 };

package/lib/configs/html.mjs

@@ -4,6 +4,9 @@ import { defineConfig } from "eslint/config";
 
 import { ExtCss, ExtHtml, files } from "../files/files.mjs";
 
+/**
+ * Adds html linting to your project.
+ */
 export const html = defineConfig([
   {
     ..._html.configs["flat/recommended"],

package/lib/configs/ignores.mjs

@@ -1,5 +1,8 @@
 import { defineConfig, globalIgnores } from "eslint/config";
 
+/**
+ * Adds the standard global ignores.
+ */
 export const ignores = defineConfig([
   globalIgnores([
     // Outputs

package/lib/configs/javascript.mjs

@@ -6,6 +6,11 @@ import _unused from "eslint-plugin-unused-imports";
 
 import { ExtEs, files } from "../files/files.mjs";
 
+/**
+ * Adds javascript linting to your project.
+ *
+ * You will most likely always need this one.
+ */
 export const javascript = defineConfig([
   {
     ...js.configs.recommended,

package/lib/configs/json.mjs

@@ -3,6 +3,9 @@ import { defineConfig } from "eslint/config";
 
 import { ExtJson, files } from "../files/files.mjs";
 
+/**
+ * Adds json linting to your project.
+ */
 export const json = defineConfig([
   {
     ..._json.configs.recommended,

package/lib/configs/markdown.mjs

@@ -1,4 +1,7 @@
 import md from "@eslint/markdown";
 import { defineConfig } from "eslint/config";
 
+/**
+ * Adds markdown linting to your project.
+ */
 export const markdown = defineConfig(...md.configs.recommended);

package/lib/configs/prettier.mjs

@@ -1,6 +1,13 @@
 import { defineConfig } from "eslint/config";
 import pretty from "eslint-plugin-prettier/recommended";
 
+/**
+ * Adds stylistic code format linting to your project.
+ *
+ * If you have this as a plugin, then you should not use
+ * prettier as your default formatter, but instead just
+ * do an eslint fix on each save.
+ */
 export const prettier = defineConfig([
   pretty,
   {

package/lib/configs/react.mjs

@@ -3,6 +3,9 @@ import { defineConfig } from "eslint/config";
 
 import { ExtEs, files } from "../files/files.mjs";
 
+/**
+ * Adds linting for react based projects.
+ */
 export const react = defineConfig([
   {
     files: files(...ExtEs),

package/lib/configs/recommended.mjs

@@ -12,6 +12,23 @@ import { test } from "./test.mjs";
 import { typescript } from "./typescript.mjs";
 import { yaml } from "./yaml.mjs";
 
+/**
+ * A composite plugin list that adds all recommended plugins.
+ *
+ * This adds the following:
+ *
+ * 1. {@link ignores}
+ * 1. {@link javascript}
+ * 1. {@link typescript}
+ * 1. {@link markdown}
+ * 1. {@link json}
+ * 1. {@link yaml}
+ * 1. {@link styles}
+ * 1. {@link html}
+ * 1. {@link test}
+ * 1. {@link spelling}
+ * 1. {@link prettier}
+ */
 export const recommended = defineConfig([
   ...ignores,
   ...javascript,

package/lib/configs/spelling.mjs

@@ -1,4 +1,10 @@
 import cspell from "@cspell/eslint-plugin/recommended";
 import { defineConfig } from "eslint/config";
 
+/**
+ * Adds linting for spelling.
+ *
+ * This assumes you have a cspell.json dictionary in your
+ * root or .config folder.
+ */
 export const spelling = defineConfig([cspell]);

package/lib/configs/styles.mjs

@@ -3,6 +3,9 @@ import { defineConfig } from "eslint/config";
 
 import { ExtCss, files } from "../files/files.mjs";
 
+/**
+ * Adds linting for css.
+ */
 export const styles = defineConfig([
   {
     ...css.configs.recommended,

package/lib/configs/test.mjs

@@ -3,6 +3,9 @@ import { defineConfig } from "eslint/config";
 
 import { ExtEs, filesTest } from "../files/files.mjs";
 
+/**
+ * Adds linting for vitest.
+ */
 export const test = defineConfig([
   {
     ...vitest.configs.recommended,

package/lib/configs/typescript.mjs

@@ -14,6 +14,9 @@ const name = "typescript-eslint/recommended-type-checked";
 const recommended = recommendedTypeChecked.find((x) => x.name === name) || {};
 const { rules } = recommended;
 
+/**
+ * Adds typescript linting to your project.
+ */
 export const typescript = defineConfig([
   {
     ...base,

package/lib/configs/yaml.mjs

@@ -1,4 +1,7 @@
 import { defineConfig } from "eslint/config";
 import { configs } from "eslint-plugin-yml";
 
+/**
+ * Adds support to lint yaml files.
+ */
 export const yaml = defineConfig([configs.recommended]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zthun/janitor-eslint-config",
-  "version": "21.2.4",
+  "version": "21.2.5",
   "description": "A shared configuration for eslint for @zthun scoped projects.",
   "keywords": [
     "eslint",
@@ -24,28 +24,27 @@
   ],
   "dependencies": {
     "@cspell/eslint-plugin": "^10.3.6",
-    "@eslint-react/eslint-plugin": "^5.23.3",
+    "@eslint-react/eslint-plugin": "^5.26.5",
     "@eslint/css": "^2.0.0",
     "@eslint/js": "^10.0.1",
-    "@eslint/json": "^2.1.0",
+    "@eslint/json": "^2.1.1",
     "@eslint/markdown": "^8.0.3",
     "@html-eslint/eslint-plugin": "^0.66.1",
     "@vitest/eslint-plugin": "^1.6.27",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-import-x": "^4.17.1",
-    "eslint-plugin-prettier": "^5.5.6",
+    "eslint-plugin-prettier": "^5.5.7",
     "eslint-plugin-simple-import-sort": "^14.0.0",
     "eslint-plugin-unused-imports": "^4.4.1",
-    "eslint-plugin-yml": "^3.8.1",
-    "globals": "^17.12.0",
-    "typescript-eslint": "^8.71.0"
+    "eslint-plugin-yml": "^3.9.0",
+    "globals": "^17.13.0",
+    "typescript-eslint": "^8.71.2"
   },
   "devDependencies": {
-    "@zthun/janitor-build-config": "^21.2.4",
-    "eslint": "^10.11.0",
-    "prettier": "^3.9.9",
+    "eslint": "^10.12.0",
+    "prettier": "^3.9.10",
     "typescript": "^6.0.3",
-    "vite": "^8.3.1"
+    "vite": "^8.3.4"
   },
   "peerDependencies": {
     "eslint": "^10",
@@ -54,13 +53,19 @@
     "typescript": ">=5 <7"
   },
   "peerDependenciesMeta": {
+    "prettier": {
+      "optional": true
+    },
     "react": {
       "optional": true
+    },
+    "typescript": {
+      "optional": true
     }
   },
   "publishConfig": {
     "access": "public"
   },
   "author": "Anthony Bonta",
-  "gitHead": "1202551e1e0ddb0faa154a92ddfa2ee4fe5c2268"
+  "gitHead": "f390a3b8968c3d156a9f5ed4b6227ef0d9d963e2"
 }