@cratis/eslint-config 0.0.1

package/README.md

@@ -0,0 +1,60 @@
+# @cratis/eslint-config
+
+Shared [ESLint flat-config](https://eslint.org/docs/latest/use/configure/configuration-files) presets for Cratis projects.
+
+Two audiences, deliberately separated:
+
+| Preset | For | Adds |
+|---|---|---|
+| `consumer` | Projects that **build on** Cratis (other products, apps) | House TypeScript/React hygiene + `for_*` BDD spec relaxations |
+| `internal` | The Cratis **product repos** (Arc, Components, Fundamentals, …) | Everything in `consumer` **plus** the Cratis MIT license-header rule |
+
+The license header is a Cratis *authoring* concern, so it lives only in `internal` — consumers never inherit it.
+
+## Install
+
+```sh
+yarn add -D @cratis/eslint-config eslint
+```
+
+`eslint` is a peer dependency; everything else (typescript-eslint, eslint-plugin-react, …) ships transitively.
+
+## Use — a project built on Cratis
+
+```js
+// eslint.config.mjs
+import cratis from '@cratis/eslint-config';
+
+export default [
+    ...cratis.configs.consumer,
+    // …your project-specific rules layered on top
+];
+```
+
+If you consume Cratis Arc proxies or Cratis Components, also compose the product rule packages:
+
+```js
+import cratis from '@cratis/eslint-config';
+import arc from '@cratis/eslint-plugin-arc';
+import components from '@cratis/eslint-plugin-components';
+
+export default [
+    ...cratis.configs.consumer,
+    ...arc.configs.recommended,         // skips generated proxies, MVVM view-model discipline
+    ...components.configs.recommended,  // no raw primereact dialogs, subpath-only imports
+    // …your project rules
+];
+```
+
+## Use — inside a Cratis product repo
+
+```js
+// eslint.config.mjs
+import cratis from '@cratis/eslint-config';
+
+export default cratis.configs.internal;
+```
+
+## Building blocks
+
+`configs.base` (hygiene + ignores) and `configs.specs` (`for_*` relaxations) are exported too, so you can compose your own preset. Named exports `base`, `specs`, `consumer`, `internal`, and `ignores` are also available.

package/base.js

@@ -0,0 +1,49 @@
+import tseslintPlugin from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import noNull from 'eslint-plugin-no-null';
+import react from 'eslint-plugin-react';
+import globals from 'globals';
+import { coreRules } from './lib/coreRules.js';
+
+// Default ignore globs shared across Cratis projects: build output, generated proxy
+// `Api/` folders, scaffolding templates, declaration files, and plain JS tooling.
+// A consumer can append its own ignores in a later config object.
+export const ignores = [
+    '**/*.d.ts',
+    '**/*.scss.d.ts',
+    '**/tsconfig.*',
+    '**/wallaby.js',
+    '**/*.js',
+    '**/dist/**',
+    '**/node_modules/**',
+    '**/wwwroot/**',
+    '**/templates/**',
+    '**/Api/**',
+    '**/rollup.config.mjs',
+];
+
+// Product-agnostic Cratis hygiene for TypeScript/React. No license-header rule here —
+// see `internal` for the Cratis-authoring layer.
+const base = [
+    { name: '@cratis/eslint-config/ignores', ignores },
+    {
+        name: '@cratis/eslint-config/base',
+        files: ['**/*.ts', '**/*.tsx'],
+        plugins: {
+            '@typescript-eslint': tseslintPlugin,
+            react,
+            'no-null': noNull,
+        },
+        languageOptions: {
+            globals: { ...globals.browser },
+            parser: tsParser,
+            sourceType: 'module',
+        },
+        settings: {
+            react: { version: 'detect' },
+        },
+        rules: coreRules,
+    },
+];
+
+export default base;

package/consumer.js

@@ -0,0 +1,12 @@
+import base from './base.js';
+import specs from './specs.js';
+
+// What a project consuming Cratis packages should lint with: the Cratis house
+// TypeScript/React hygiene plus the BDD spec relaxations — WITHOUT the Cratis-internal
+// MIT license header. Spread it first in your eslint.config, then layer project rules:
+//
+//   import cratis from '@cratis/eslint-config';
+//   export default [...cratis.configs.consumer, ...yourProjectConfig];
+const consumer = [...base, ...specs];
+
+export default consumer;

package/index.js

@@ -0,0 +1,16 @@
+import base, { ignores } from './base.js';
+import consumer from './consumer.js';
+import internal from './internal.js';
+import specs from './specs.js';
+
+// Composable Cratis ESLint flat-config presets.
+//
+//   base      product-agnostic TypeScript/React hygiene + default ignores
+//   specs     `for_*` BDD spec relaxations
+//   consumer  base + specs — for projects built ON Cratis (no license header)
+//   internal  consumer + the Cratis MIT license header — for Cratis product repos
+export const configs = { base, specs, consumer, internal };
+
+export { base, specs, consumer, internal, ignores };
+
+export default { configs };

package/internal.js

@@ -0,0 +1,32 @@
+import header from '@tony.ganchev/eslint-plugin-header';
+import base from './base.js';
+import specs from './specs.js';
+
+// The Cratis MIT license header, enforced on every Cratis-authored `.ts`/`.tsx`.
+// This is an internal authoring rule: it belongs in the Cratis product repos
+// (Arc, Components, Fundamentals, …), and consumers must NOT inherit it.
+const licenseHeader = {
+    name: '@cratis/eslint-config/license-header',
+    files: ['**/*.ts', '**/*.tsx'],
+    plugins: { '@tony.ganchev': header },
+    rules: {
+        '@tony.ganchev/header': ['error', {
+            header: {
+                commentType: 'line',
+                lines: [
+                    ' Copyright (c) Cratis. All rights reserved.',
+                    ' Licensed under the MIT license. See LICENSE file in the project root for full license information.',
+                ],
+            },
+        }],
+    },
+};
+
+// What the Cratis product repos lint their own source with: the consumer preset plus
+// the Cratis-authoring layer.
+//
+//   import cratis from '@cratis/eslint-config';
+//   export default cratis.configs.internal;
+const internal = [...base, ...specs, licenseHeader];
+
+export default internal;

package/lib/coreRules.js

@@ -0,0 +1,34 @@
+import eslintJs from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+// Flatten the `rules` maps from one or more flat-config objects into a single map.
+// typescript-eslint and @eslint/js ship their recommended sets as flat-config arrays;
+// we merge them down so the whole house rule set can live on one config block.
+export const collectRules = configOrArray => {
+    const items = Array.isArray(configOrArray) ? configOrArray : [configOrArray];
+    return items.reduce((accumulated, item) => (item && item.rules ? { ...accumulated, ...item.rules } : accumulated), {});
+};
+
+// The Cratis house TypeScript/React rule set, product-agnostic. This is the rule body
+// the Cratis product repos historically copy-pasted into each repo's eslint.config.mjs.
+// It deliberately does NOT include the MIT license-header rule — that is an internal
+// authoring concern layered on by the `internal` preset, never inherited by consumers.
+export const coreRules = {
+    ...collectRules(eslintJs.configs.recommended),
+    ...collectRules(tseslint.configs.recommended),
+
+    'no-irregular-whitespace': 0,
+    semi: [2, 'always'],
+    'react/display-name': 0,
+    'react/react-in-jsx-scope': 0,
+    'no-prototype-builtins': 0,
+
+    '@typescript-eslint/no-unused-vars': ['error', { ignoreRestSiblings: true }],
+    '@typescript-eslint/no-explicit-any': 'error',
+    '@typescript-eslint/explicit-module-boundary-types': 0,
+    '@typescript-eslint/no-non-null-assertion': 0,
+    '@typescript-eslint/no-empty-function': 'error',
+    '@typescript-eslint/no-var-requires': 'error',
+    '@typescript-eslint/ban-ts-comment': 0,
+    '@typescript-eslint/no-empty-interface': 0,
+};

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@cratis/eslint-config",
+  "version": "0.0.1",
+  "description": "Shared Cratis ESLint flat-config presets. `consumer` is for projects that build on Cratis; `internal` adds the Cratis-authoring rules (MIT license header) used inside the Cratis product repos.",
+  "author": "Cratis",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Cratis/Fundamentals.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "eslint",
+    "eslintconfig",
+    "eslint-config",
+    "cratis"
+  ],
+  "files": [
+    "index.js",
+    "base.js",
+    "specs.js",
+    "consumer.js",
+    "internal.js",
+    "lib",
+    "README.md"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./index.js"
+  },
+  "scripts": {
+    "test": "yarn g:test",
+    "ci": "yarn g:test"
+  },
+  "dependencies": {
+    "@eslint/js": "^10.0.1",
+    "@tony.ganchev/eslint-plugin-header": "^3.4.4",
+    "@typescript-eslint/eslint-plugin": "^8.60.1",
+    "@typescript-eslint/parser": "^8.60.1",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-react": "^7.37.5",
+    "globals": "^17.6.0",
+    "typescript-eslint": "^8.60.1"
+  },
+  "peerDependencies": {
+    "eslint": ">=9",
+    "typescript": ">=4.8.4"
+  }
+}

package/specs.js

@@ -0,0 +1,17 @@
+// Cratis BDD specifications live in `for_*` folders and read as scenario sentences.
+// They intentionally relax a handful of rules: expression-statement assertions, free
+// naming for `when_…`/`and_…` describers, and empty setup bodies.
+const specs = [
+    {
+        name: '@cratis/eslint-config/specs',
+        files: ['**/for_*/**/*.ts', '**/for_*/**/*.tsx'],
+        rules: {
+            '@typescript-eslint/naming-convention': 0,
+            '@typescript-eslint/no-unused-expressions': 0,
+            '@typescript-eslint/no-empty-function': 'off',
+            'no-restricted-globals': 0,
+        },
+    },
+];
+
+export default specs;