@t4h.framework/eslint-config 0.0.0-stage → 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# @t4h.framework/eslint-config
+
+## 0.2.1
+
+### Patch Changes
+
+- [#276](https://github.com/tech4humans-brasil/framework/pull/276) [`7b38934`](https://github.com/tech4humans-brasil/framework/commit/7b38934e8f9207c98c33afcd76e3a7a4da7e8b14) Thanks [@gusteycamargo](https://github.com/gusteycamargo)! - The docs give all the rules of the base config, the import order, the 14 Prettier options and the version ranges of the peers. The Portuguese docs are new.
+
+## 0.2.0
+
+### Minor Changes
+
+- [#274](https://github.com/tech4humans-brasil/framework/pull/274) [`7d7d4ec`](https://github.com/tech4humans-brasil/framework/commit/7d7d4ec27e55262f3f0353a7253a95e12d24de9b) Thanks [@gusteycamargo](https://github.com/gusteycamargo)! - Replaces `defineConfig()` with `framework(options, ...configs)`. The configs of the user come last, so their rules win over the base config and the package configs. The `jsx` option turns the React rules on or off. When it is not set, the JSX config applies only if an installed package declares `requires: { jsx: true }` in its `eslint` entry. The fixed list with `@t4h.framework/pdf` is gone, so JSX turns on only with a `pdf` version that has the `./eslint` entry, or with `jsx: true`. The packages are found with `local-pkg`, so Yarn PnP and pnpm work. A `@t4h.framework/*` package that is in `package.json` but not installed now causes an error, and so does an `eslint` entry that is declared but does not load. `framework()` uses the nearest `package.json` at or above `cwd`. `cspell/spellchecker` is now a warning. `no-comments` has a docs URL and no longer accepts a comment that only starts with the word `eslint`.
+
+## 0.1.0
+
+### Minor Changes
+
+- [#238](https://github.com/tech4humans-brasil/framework/pull/238) [`8567806`](https://github.com/tech4humans-brasil/framework/commit/8567806ec537288076c3a18a4816f26d58a67905) Thanks [@gusteycamargo](https://github.com/gusteycamargo)! - Adds the ESLint and Prettier configuration of the T4H Framework. The default export is the base config, `./jsx` adds the React rules and `./prettier-config` has the Prettier options. `defineConfig()` starts from the base config and adds the `recommended` config of each installed `@t4h.framework/*` package that has an `eslint` entry. The base config includes the `no-comments` rule: a comment needs a disable directive with a reason.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tech for humans
+
+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 the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,46 @@
-# Temporary Holding Version
+# @t4h.framework/eslint-config
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+ESLint and Prettier configuration for the T4H Framework. It also turns on the
+rules of each `@t4h.framework/*` package that the project uses.
+
+## Installation
+
+```bash
+yarn add --dev @t4h.framework/eslint-config eslint prettier typescript
+```
+
+## Usage
+
+```javascript
+// eslint.config.mjs
+import { framework } from '@t4h.framework/eslint-config'
+
+export default framework()
+```
+
+To add or change rules, put your configs after the options. They come last,
+so they win:
+
+```javascript
+export default framework({}, { rules: { 'max-depth': ['error', 3] } })
+```
+
+```json
+{
+  "prettier": "@t4h.framework/eslint-config/prettier-config"
+}
+```
+
+| Entry                                          | What it has                                               |
+| ---------------------------------------------- | --------------------------------------------------------- |
+| `@t4h.framework/eslint-config`                 | The base config (default export) and `framework()`        |
+| `@t4h.framework/eslint-config/jsx`             | The base config and the React rules for `.jsx` and `.tsx` |
+| `@t4h.framework/eslint-config/prettier-config` | The Prettier options                                      |
+
+Peer dependencies: `eslint` `>=10`, `prettier` `>=3` and `typescript`
+`>=5.0.0 <6.0.0`. The package needs Node.js >= 22.
+
+To see the rules that apply to each file, run `npx @eslint/config-inspector`.
+
+Read the full documentation on the
+[docs site](https://tech4humans-brasil.github.io/framework/eslint-config/).

package/dist/configs/base.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from 'eslint';
+export declare const base: Linter.Config[];
+//# sourceMappingURL=base.d.ts.map

package/dist/configs/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/configs/base.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AA6BpC,eAAO,MAAM,IAAI,EAAE,MAAM,CAAC,MAAM,EAiG/B,CAAA"}

package/dist/configs/base.js

@@ -0,0 +1,125 @@
+import cspell from '@cspell/eslint-plugin';
+import js from '@eslint/js';
+import comments from '@eslint-community/eslint-plugin-eslint-comments/configs';
+import vitest from '@vitest/eslint-plugin';
+import { createTypeScriptImportResolver } from 'eslint-import-resolver-typescript';
+import { importX } from 'eslint-plugin-import-x';
+import n from 'eslint-plugin-n';
+import prettier from 'eslint-plugin-prettier/recommended';
+import sonarjs from 'eslint-plugin-sonarjs';
+import globals from 'globals';
+import ts from 'typescript-eslint';
+import { noComments } from '../rules/no-comments.js';
+const TYPED_FILES = ['**/*.{ts,tsx,mts,cts}'];
+const TEST_FILES = [
+    '**/__tests__/**',
+    '**/*.spec.{js,jsx,ts,tsx}',
+    '**/*.test.{js,jsx,ts,tsx}',
+];
+const plugin = {
+    meta: { name: '@t4h.framework/eslint-config' },
+    rules: { 'no-comments': noComments },
+};
+const typed = ts.configs.strictTypeChecked.map(entry => ({
+    ...entry,
+    files: TYPED_FILES,
+}));
+export const base = [
+    { files: ['**/*.{js,mjs,cjs,jsx,ts,tsx,mts,cts}'] },
+    { ignores: ['**/dist/**'] },
+    js.configs.recommended,
+    importX.flatConfigs.recommended,
+    ...ts.configs.recommended,
+    comments.recommended,
+    prettier,
+    {
+        linterOptions: { reportUnusedDisableDirectives: 'error' },
+        plugins: {
+            cspell,
+            n,
+            sonarjs,
+            '@t4h.framework/eslint-config': plugin,
+        },
+        settings: {
+            'import-x/resolver-next': [createTypeScriptImportResolver({})],
+        },
+        languageOptions: {
+            ecmaVersion: 'latest',
+            sourceType: 'module',
+            globals: globals.node,
+        },
+        rules: {
+            '@t4h.framework/eslint-config/no-comments': 'error',
+            '@eslint-community/eslint-comments/require-description': 'error',
+            '@eslint-community/eslint-comments/no-unlimited-disable': 'error',
+            '@eslint-community/eslint-comments/disable-enable-pair': [
+                'error',
+                { allowWholeFile: true },
+            ],
+            'n/prefer-node-protocol': 'error',
+            'import-x/order': [
+                'error',
+                {
+                    groups: [
+                        ['builtin'],
+                        ['external'],
+                        ['internal'],
+                        ['parent', 'sibling', 'index'],
+                    ],
+                    pathGroups: [
+                        {
+                            pattern: '@t4h.framework/**',
+                            group: 'external',
+                            position: 'before',
+                        },
+                    ],
+                    pathGroupsExcludedImportTypes: ['builtin'],
+                    alphabetize: { order: 'asc', caseInsensitive: true },
+                    'newlines-between': 'always',
+                },
+            ],
+            'max-depth': ['error', 2],
+            'no-nested-ternary': 'error',
+            'no-lonely-if': 'error',
+            'no-else-return': ['error', { allowElseIf: false }],
+            'sonarjs/cognitive-complexity': ['error', 15],
+            'cspell/spellchecker': 'warn',
+        },
+    },
+    ...typed,
+    {
+        files: TYPED_FILES,
+        languageOptions: {
+            parserOptions: { projectService: true },
+        },
+        rules: {
+            '@typescript-eslint/no-deprecated': 'off',
+            '@typescript-eslint/no-namespace': 'off',
+            '@typescript-eslint/no-unsafe-declaration-merging': 'off',
+            '@typescript-eslint/switch-exhaustiveness-check': 'error',
+            '@typescript-eslint/ban-ts-comment': [
+                'error',
+                { 'ts-expect-error': 'allow-with-description' },
+            ],
+        },
+    },
+    {
+        files: TEST_FILES,
+        plugins: { vitest },
+        rules: {
+            'vitest/no-focused-tests': 'error',
+            'vitest/no-disabled-tests': 'error',
+            'vitest/expect-expect': [
+                'error',
+                { assertFunctionNames: ['expect', 'expectTypeOf', 'assertType'] },
+            ],
+            'vitest/no-identical-title': 'error',
+            'vitest/valid-expect': 'error',
+        },
+    },
+    {
+        files: ['**/migrations/*.ts'],
+        rules: { 'cspell/spellchecker': 'off' },
+    },
+];
+//# sourceMappingURL=base.js.map

package/dist/configs/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/configs/base.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,uBAAuB,CAAA;AAC1C,OAAO,EAAE,MAAM,YAAY,CAAA;AAC3B,OAAO,QAAQ,MAAM,yDAAyD,CAAA;AAC9E,OAAO,MAAM,MAAM,uBAAuB,CAAA;AAE1C,OAAO,EAAE,8BAA8B,EAAE,MAAM,mCAAmC,CAAA;AAClF,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,CAAC,MAAM,iBAAiB,CAAA;AAC/B,OAAO,QAAQ,MAAM,oCAAoC,CAAA;AACzD,OAAO,OAAO,MAAM,uBAAuB,CAAA;AAC3C,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEpD,MAAM,WAAW,GAAG,CAAC,uBAAuB,CAAC,CAAA;AAE7C,MAAM,UAAU,GAAG;IACjB,iBAAiB;IACjB,2BAA2B;IAC3B,2BAA2B;CAC5B,CAAA;AAED,MAAM,MAAM,GAAG;IACb,IAAI,EAAE,EAAE,IAAI,EAAE,8BAA8B,EAAE;IAC9C,KAAK,EAAE,EAAE,aAAa,EAAE,UAAU,EAAE;CACrC,CAAA;AAED,MAAM,KAAK,GAAG,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACvD,GAAG,KAAK;IACR,KAAK,EAAE,WAAW;CACnB,CAAC,CAAoB,CAAA;AAEtB,MAAM,CAAC,MAAM,IAAI,GAAoB;IACnC,EAAE,KAAK,EAAE,CAAC,sCAAsC,CAAC,EAAE;IACnD,EAAE,OAAO,EAAE,CAAC,YAAY,CAAC,EAAE;IAC3B,EAAE,CAAC,OAAO,CAAC,WAAW;IACtB,OAAO,CAAC,WAAW,CAAC,WAA4B;IAChD,GAAI,EAAE,CAAC,OAAO,CAAC,WAA+B;IAC9C,QAAQ,CAAC,WAA4B;IACrC,QAAQ;IACR;QACE,aAAa,EAAE,EAAE,6BAA6B,EAAE,OAAO,EAAE;QACzD,OAAO,EAAE;YACP,MAAM;YACN,CAAC;YACD,OAAO;YACP,8BAA8B,EAAE,MAAM;SACvC;QACD,QAAQ,EAAE;YACR,wBAAwB,EAAE,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;SAC/D;QACD,eAAe,EAAE;YACf,WAAW,EAAE,QAAQ;YACrB,UAAU,EAAE,QAAQ;YACpB,OAAO,EAAE,OAAO,CAAC,IAAI;SACtB;QACD,KAAK,EAAE;YACL,0CAA0C,EAAE,OAAO;YACnD,uDAAuD,EAAE,OAAO;YAChE,wDAAwD,EAAE,OAAO;YACjE,uDAAuD,EAAE;gBACvD,OAAO;gBACP,EAAE,cAAc,EAAE,IAAI,EAAE;aACzB;YACD,wBAAwB,EAAE,OAAO;YACjC,gBAAgB,EAAE;gBAChB,OAAO;gBACP;oBACE,MAAM,EAAE;wBACN,CAAC,SAAS,CAAC;wBACX,CAAC,UAAU,CAAC;wBACZ,CAAC,UAAU,CAAC;wBACZ,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC;qBAC/B;oBACD,UAAU,EAAE;wBACV;4BACE,OAAO,EAAE,mBAAmB;4BAC5B,KAAK,EAAE,UAAU;4BACjB,QAAQ,EAAE,QAAQ;yBACnB;qBACF;oBACD,6BAA6B,EAAE,CAAC,SAAS,CAAC;oBAC1C,WAAW,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE;oBACpD,kBAAkB,EAAE,QAAQ;iBAC7B;aACF;YACD,WAAW,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YACzB,mBAAmB,EAAE,OAAO;YAC5B,cAAc,EAAE,OAAO;YACvB,gBAAgB,EAAE,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;YACnD,8BAA8B,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC;YAC7C,qBAAqB,EAAE,MAAM;SAC9B;KACF;IACD,GAAG,KAAK;IACR;QACE,KAAK,EAAE,WAAW;QAClB,eAAe,EAAE;YACf,aAAa,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE;SACxC;QACD,KAAK,EAAE;YACL,kCAAkC,EAAE,KAAK;YACzC,iCAAiC,EAAE,KAAK;YACxC,kDAAkD,EAAE,KAAK;YACzD,gDAAgD,EAAE,OAAO;YACzD,mCAAmC,EAAE;gBACnC,OAAO;gBACP,EAAE,iBAAiB,EAAE,wBAAwB,EAAE;aAChD;SACF;KACF;IACD;QACE,KAAK,EAAE,UAAU;QACjB,OAAO,EAAE,EAAE,MAAM,EAAE;QACnB,KAAK,EAAE;YACL,yBAAyB,EAAE,OAAO;YAClC,0BAA0B,EAAE,OAAO;YACnC,sBAAsB,EAAE;gBACtB,OAAO;gBACP,EAAE,mBAAmB,EAAE,CAAC,QAAQ,EAAE,cAAc,EAAE,YAAY,CAAC,EAAE;aAClE;YACD,2BAA2B,EAAE,OAAO;YACpC,qBAAqB,EAAE,OAAO;SAC/B;KACF;IACD;QACE,KAAK,EAAE,CAAC,oBAAoB,CAAC;QAC7B,KAAK,EAAE,EAAE,qBAAqB,EAAE,KAAK,EAAE;KACxC;CACF,CAAA"}

package/dist/configs/jsx.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from 'eslint';
+export declare const jsx: Linter.Config[];
+//# sourceMappingURL=jsx.d.ts.map

package/dist/configs/jsx.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsx.d.ts","sourceRoot":"","sources":["../../src/configs/jsx.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAOpC,eAAO,MAAM,GAAG,EAAE,MAAM,CAAC,MAAM,EAiB9B,CAAA"}

package/dist/configs/jsx.js

@@ -0,0 +1,22 @@
+import react from 'eslint-plugin-react';
+import { base } from './base.js';
+const JSX_FILES = ['**/*.{jsx,tsx}'];
+export const jsx = [
+    ...base,
+    {
+        ...react.configs.flat.recommended,
+        files: JSX_FILES,
+    },
+    {
+        ...react.configs.flat['jsx-runtime'],
+        files: JSX_FILES,
+    },
+    {
+        files: JSX_FILES,
+        languageOptions: {
+            parserOptions: { ecmaFeatures: { jsx: true } },
+        },
+        settings: { react: { version: 'detect' } },
+    },
+];
+//# sourceMappingURL=jsx.js.map

package/dist/configs/jsx.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsx.js","sourceRoot":"","sources":["../../src/configs/jsx.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,qBAAqB,CAAA;AAEvC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAEhC,MAAM,SAAS,GAAG,CAAC,gBAAgB,CAAC,CAAA;AAEpC,MAAM,CAAC,MAAM,GAAG,GAAoB;IAClC,GAAG,IAAI;IACP;QACE,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW;QACjC,KAAK,EAAE,SAAS;KACjB;IACD;QACE,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC;QACpC,KAAK,EAAE,SAAS;KACjB;IACD;QACE,KAAK,EAAE,SAAS;QAChB,eAAe,EAAE;YACf,aAAa,EAAE,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;SAC/C;QACD,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE;KAC3C;CACF,CAAA"}

package/dist/eslint-config.d.ts

@@ -0,0 +1,4 @@
+import { base } from './configs/base.js';
+export * from './tools/framework.js';
+export default base;
+//# sourceMappingURL=eslint-config.d.ts.map

package/dist/eslint-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eslint-config.d.ts","sourceRoot":"","sources":["../src/eslint-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAExC,cAAc,sBAAsB,CAAA;AAEpC,eAAe,IAAI,CAAA"}

package/dist/eslint-config.js

@@ -0,0 +1,4 @@
+import { base } from './configs/base.js';
+export * from './tools/framework.js';
+export default base;
+//# sourceMappingURL=eslint-config.js.map

package/dist/eslint-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eslint-config.js","sourceRoot":"","sources":["../src/eslint-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAExC,cAAc,sBAAsB,CAAA;AAEpC,eAAe,IAAI,CAAA"}

package/dist/jsx.d.ts

@@ -0,0 +1,3 @@
+import { jsx } from './configs/jsx.js';
+export default jsx;
+//# sourceMappingURL=jsx.d.ts.map

package/dist/jsx.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsx.d.ts","sourceRoot":"","sources":["../src/jsx.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAEtC,eAAe,GAAG,CAAA"}

package/dist/jsx.js

@@ -0,0 +1,3 @@
+import { jsx } from './configs/jsx.js';
+export default jsx;
+//# sourceMappingURL=jsx.js.map

package/dist/jsx.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsx.js","sourceRoot":"","sources":["../src/jsx.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAEtC,eAAe,GAAG,CAAA"}

package/dist/prettier-config.d.ts

@@ -0,0 +1,4 @@
+import type { Config } from 'prettier';
+declare const config: Config;
+export default config;
+//# sourceMappingURL=prettier-config.d.ts.map

package/dist/prettier-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prettier-config.d.ts","sourceRoot":"","sources":["../src/prettier-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC,QAAA,MAAM,MAAM,EAAE,MAeb,CAAA;AAED,eAAe,MAAM,CAAA"}

package/dist/prettier-config.js

@@ -0,0 +1,18 @@
+const config = {
+    experimentalTernaries: false,
+    printWidth: 80,
+    tabWidth: 2,
+    useTabs: false,
+    semi: false,
+    singleQuote: true,
+    quoteProps: 'as-needed',
+    jsxSingleQuote: true,
+    trailingComma: 'all',
+    bracketSpacing: true,
+    bracketSameLine: false,
+    arrowParens: 'avoid',
+    endOfLine: 'lf',
+    singleAttributePerLine: false,
+};
+export default config;
+//# sourceMappingURL=prettier-config.js.map

package/dist/prettier-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prettier-config.js","sourceRoot":"","sources":["../src/prettier-config.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,GAAW;IACrB,qBAAqB,EAAE,KAAK;IAC5B,UAAU,EAAE,EAAE;IACd,QAAQ,EAAE,CAAC;IACX,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,KAAK;IACX,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,WAAW;IACvB,cAAc,EAAE,IAAI;IACpB,aAAa,EAAE,KAAK;IACpB,cAAc,EAAE,IAAI;IACpB,eAAe,EAAE,KAAK;IACtB,WAAW,EAAE,OAAO;IACpB,SAAS,EAAE,IAAI;IACf,sBAAsB,EAAE,KAAK;CAC9B,CAAA;AAED,eAAe,MAAM,CAAA"}

package/dist/rules/no-comments.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+export declare const noComments: Rule.RuleModule;
+//# sourceMappingURL=no-comments.d.ts.map

package/dist/rules/no-comments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-comments.d.ts","sourceRoot":"","sources":["../../src/rules/no-comments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAO,IAAI,EAAc,MAAM,QAAQ,CAAA;AAoDnD,eAAO,MAAM,UAAU,EAAE,IAAI,CAAC,UA8B7B,CAAA"}

package/dist/rules/no-comments.js

@@ -0,0 +1,66 @@
+const DIRECTIVE = /^\s*(eslint-(disable|enable)\b|eslint\s+[\w@/-]+\s*:|global\s|@ts-|prettier-ignore|cspell:|v8 ignore|istanbul ignore)/;
+const DOCS_URL = 'https://tech4humans-brasil.github.io/framework/eslint-config/rules/no-comments';
+const EXPORT_TYPES = new Set([
+    'ExportNamedDeclaration',
+    'ExportDefaultDeclaration',
+]);
+const BODY_TYPES = new Set([
+    'BlockStatement',
+    'StaticBlock',
+    'ArrowFunctionExpression',
+    'FunctionExpression',
+]);
+function isDirective(comment) {
+    if (comment.type === 'Shebang')
+        return true;
+    if (comment.type === 'Line' && comment.value.startsWith('/ <reference'))
+        return true;
+    return DIRECTIVE.test(comment.value);
+}
+function isInsideExport(node) {
+    for (let current = node; current; current = current.parent) {
+        if (EXPORT_TYPES.has(current.type))
+            return true;
+        if (BODY_TYPES.has(current.type))
+            return false;
+    }
+    return false;
+}
+function documentsExport(sourceCode, comment) {
+    if (comment.type !== 'Block' || !comment.value.startsWith('*'))
+        return false;
+    const token = sourceCode.getTokenAfter(comment);
+    if (!token)
+        return false;
+    const node = sourceCode.getNodeByRangeIndex(token.range[0]);
+    return isInsideExport(node);
+}
+export const noComments = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Allows only directives and JSDoc on exported declarations',
+            url: DOCS_URL,
+        },
+        messages: {
+            comment: 'Comments are not allowed. Make the code explain itself, or use JSDoc on an exported declaration. If a comment is really necessary, disable this rule on that line and give the reason after "--".',
+        },
+        schema: [],
+    },
+    create(context) {
+        const { sourceCode } = context;
+        return {
+            Program() {
+                for (const comment of sourceCode.getAllComments()) {
+                    if (isDirective(comment) || documentsExport(sourceCode, comment))
+                        continue;
+                    context.report({
+                        loc: comment.loc ?? sourceCode.ast.loc,
+                        messageId: 'comment',
+                    });
+                }
+            },
+        };
+    },
+};
+//# sourceMappingURL=no-comments.js.map

package/dist/rules/no-comments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-comments.js","sourceRoot":"","sources":["../../src/rules/no-comments.ts"],"names":[],"mappings":"AAIA,MAAM,SAAS,GACb,uHAAuH,CAAA;AAEzH,MAAM,QAAQ,GACZ,gFAAgF,CAAA;AAElF,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC;IAC3B,wBAAwB;IACxB,0BAA0B;CAC3B,CAAC,CAAA;AAEF,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC;IACzB,gBAAgB;IAChB,aAAa;IACb,yBAAyB;IACzB,oBAAoB;CACrB,CAAC,CAAA;AAEF,SAAS,WAAW,CAAC,OAAgB;IACnC,IAAK,OAAO,CAAC,IAAe,KAAK,SAAS;QAAE,OAAO,IAAI,CAAA;IACvD,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC;QACrE,OAAO,IAAI,CAAA;IAEb,OAAO,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AACtC,CAAC;AAED,SAAS,cAAc,CAAC,IAAsB;IAC5C,KAAK,IAAI,OAAO,GAAG,IAAI,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QAC3D,IAAI,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAA;QAC/C,IAAI,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;YAAE,OAAO,KAAK,CAAA;IAChD,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,eAAe,CAAC,UAAsB,EAAE,OAAgB;IAC/D,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IAE5E,MAAM,KAAK,GAAqB,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;IACjE,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAA;IAExB,MAAM,IAAI,GAAG,UAAU,CAAC,mBAAmB,CACzC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CACK,CAAA;IAErB,OAAO,cAAc,CAAC,IAAI,CAAC,CAAA;AAC7B,CAAC;AAED,MAAM,CAAC,MAAM,UAAU,GAAoB;IACzC,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EAAE,2DAA2D;YACxE,GAAG,EAAE,QAAQ;SACd;QACD,QAAQ,EAAE;YACR,OAAO,EACL,mMAAmM;SACtM;QACD,MAAM,EAAE,EAAE;KACX;IACD,MAAM,CAAC,OAAO;QACZ,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAA;QAE9B,OAAO;YACL,OAAO;gBACL,KAAK,MAAM,OAAO,IAAI,UAAU,CAAC,cAAc,EAAE,EAAE,CAAC;oBAClD,IAAI,WAAW,CAAC,OAAO,CAAC,IAAI,eAAe,CAAC,UAAU,EAAE,OAAO,CAAC;wBAC9D,SAAQ;oBAEV,OAAO,CAAC,MAAM,CAAC;wBACb,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG;wBACtC,SAAS,EAAE,SAAS;qBACrB,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;SACF,CAAA;IACH,CAAC;CACF,CAAA"}

package/dist/tools/framework.d.ts

@@ -0,0 +1,24 @@
+import type { Linter } from 'eslint';
+/**
+ * Options of {@link framework}.
+ */
+export interface FrameworkOptions {
+    /**
+     * The folder where the search for the project `package.json` starts. The
+     * nearest `package.json` at or above it is used. Defaults to `process.cwd()`.
+     */
+    cwd?: string;
+    /**
+     * Turns the React rules for `.jsx` and `.tsx` on or off. Defaults to `true`
+     * when an installed `@t4h.framework/*` package requires JSX.
+     */
+    jsx?: boolean;
+}
+/**
+ * Builds the ESLint config of a project. It starts from the base config, or
+ * the JSX config when JSX is on, then appends the `recommended` config of each
+ * installed `@t4h.framework/*` package that has an `eslint` entry, and then the
+ * configs of the user.
+ */
+export declare function framework(options?: FrameworkOptions, ...userConfigs: (Linter.Config | Linter.Config[])[]): Promise<Linter.Config[]>;
+//# sourceMappingURL=framework.d.ts.map

package/dist/tools/framework.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"framework.d.ts","sourceRoot":"","sources":["../../src/tools/framework.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAoBpC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;CACd;AA6CD;;;;;GAKG;AACH,wBAAsB,SAAS,CAC7B,OAAO,GAAE,gBAAqB,EAC9B,GAAG,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,GAClD,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAgB1B"}

package/dist/tools/framework.js

@@ -0,0 +1,60 @@
+import { pathToFileURL } from 'node:url';
+import { getPackageInfo, importModule, loadPackageJSON, resolveModule, } from 'local-pkg';
+import { base } from '../configs/base.js';
+import { jsx } from '../configs/jsx.js';
+const SCOPE = '@t4h.framework/';
+const ESLINT_ENTRY = './eslint';
+async function readFrameworkDependencies(cwd) {
+    const packageJson = await loadPackageJSON(cwd);
+    const names = Object.keys({
+        ...packageJson?.dependencies,
+        ...packageJson?.devDependencies,
+    });
+    return names.filter(name => name.startsWith(SCOPE)).sort();
+}
+function isPackageEslintEntry(value) {
+    if (typeof value !== 'object' || value === null)
+        return false;
+    if (!('configs' in value))
+        return false;
+    const { configs } = value;
+    if (typeof configs !== 'object' || configs === null)
+        return false;
+    return Array.isArray(configs.recommended);
+}
+async function loadPackageEntry(cwd, name) {
+    const paths = [cwd];
+    const info = await getPackageInfo(name, { paths });
+    if (!info)
+        throw new Error(`${name} is in package.json but is not installed. Install the dependencies of the project.`);
+    const exports = info.packageJson.exports;
+    if (!exports?.[ESLINT_ENTRY])
+        return undefined;
+    const file = resolveModule(`${name}/eslint`, { paths });
+    if (!file)
+        throw new Error(`${name}/eslint is declared but does not resolve`);
+    const entry = await importModule(pathToFileURL(file).href);
+    if (!isPackageEslintEntry(entry))
+        throw new Error(`${name}/eslint does not export configs.recommended`);
+    return entry;
+}
+/**
+ * Builds the ESLint config of a project. It starts from the base config, or
+ * the JSX config when JSX is on, then appends the `recommended` config of each
+ * installed `@t4h.framework/*` package that has an `eslint` entry, and then the
+ * configs of the user.
+ */
+export async function framework(options = {}, ...userConfigs) {
+    const cwd = options.cwd ?? process.cwd();
+    const names = await readFrameworkDependencies(cwd);
+    const results = await Promise.all(names.map(name => loadPackageEntry(cwd, name)));
+    const eslintEntries = results.filter(entry => entry !== undefined);
+    const isJsx = options.jsx ?? eslintEntries.some(entry => entry.requires?.jsx === true);
+    return [
+        ...(isJsx ? jsx : base),
+        { languageOptions: { parserOptions: { tsconfigRootDir: cwd } } },
+        ...eslintEntries.flatMap(entry => entry.configs.recommended),
+        ...userConfigs.flat(),
+    ];
+}
+//# sourceMappingURL=framework.js.map

package/dist/tools/framework.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"framework.js","sourceRoot":"","sources":["../../src/tools/framework.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAGxC,OAAO,EACL,cAAc,EACd,YAAY,EACZ,eAAe,EACf,aAAa,GACd,MAAM,WAAW,CAAA;AAElB,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAA;AACzC,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAEvC,MAAM,KAAK,GAAG,iBAAiB,CAAA;AAE/B,MAAM,YAAY,GAAG,UAAU,CAAA;AAuB/B,KAAK,UAAU,yBAAyB,CAAC,GAAW;IAClD,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC,GAAG,CAAC,CAAA;IAC9C,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,GAAG,WAAW,EAAE,YAAY;QAC5B,GAAG,WAAW,EAAE,eAAe;KAChC,CAAC,CAAA;IAEF,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;AAC5D,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAc;IAC1C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAA;IAC7D,IAAI,CAAC,CAAC,SAAS,IAAI,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IAEvC,MAAM,EAAE,OAAO,EAAE,GAAG,KAA6B,CAAA;IACjD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,KAAK,CAAA;IAEjE,OAAO,KAAK,CAAC,OAAO,CAAE,OAAqC,CAAC,WAAW,CAAC,CAAA;AAC1E,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,GAAW,EAAE,IAAY;IACvD,MAAM,KAAK,GAAG,CAAC,GAAG,CAAC,CAAA;IACnB,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;IAClD,IAAI,CAAC,IAAI;QACP,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,oFAAoF,CAC5F,CAAA;IAEH,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,OAEpB,CAAA;IACb,IAAI,CAAC,OAAO,EAAE,CAAC,YAAY,CAAC;QAAE,OAAO,SAAS,CAAA;IAE9C,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,IAAI,SAAS,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;IACvD,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,0CAA0C,CAAC,CAAA;IAE7E,MAAM,KAAK,GAAY,MAAM,YAAY,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAA;IACnE,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,6CAA6C,CAAC,CAAA;IAEvE,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,UAA4B,EAAE,EAC9B,GAAG,WAAgD;IAEnD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAA;IACxC,MAAM,KAAK,GAAG,MAAM,yBAAyB,CAAC,GAAG,CAAC,CAAA;IAClD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAC/C,CAAA;IACD,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,CAAA;IAClE,MAAM,KAAK,GACT,OAAO,CAAC,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,KAAK,IAAI,CAAC,CAAA;IAE1E,OAAO;QACL,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;QACvB,EAAE,eAAe,EAAE,EAAE,aAAa,EAAE,EAAE,eAAe,EAAE,GAAG,EAAE,EAAE,EAAE;QAChE,GAAG,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC;QAC5D,GAAG,WAAW,CAAC,IAAI,EAAE;KACtB,CAAA;AACH,CAAC"}

package/package.json

@@ -1,6 +1,75 @@
 {
   "name": "@t4h.framework/eslint-config",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.1",
+  "description": "ESLint and Prettier configuration for the T4H Framework",
+  "homepage": "https://github.com/tech4humans-brasil/framework/tree/main/packages/eslint-config",
+  "bugs": "https://github.com/tech4humans-brasil/framework/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tech4humans-brasil/framework.git",
+    "directory": "packages/eslint-config"
+  },
+  "license": "MIT",
+  "author": "Tech4Humans <contact@tech4h.com.br> (https://tech4h.com.br)",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/eslint-config.d.ts",
+      "import": "./dist/eslint-config.js"
+    },
+    "./jsx": {
+      "types": "./dist/jsx.d.ts",
+      "import": "./dist/jsx.js"
+    },
+    "./prettier-config": {
+      "types": "./dist/prettier-config.d.ts",
+      "import": "./dist/prettier-config.js"
+    }
+  },
+  "module": "./dist/eslint-config.js",
+  "types": "./dist/eslint-config.d.ts",
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "check-types": "tsc --noEmit",
+    "check-package": "publint --strict && attw --pack . --profile esm-only",
+    "lint": "eslint . --max-warnings 0",
+    "prepublishOnly": "yarn build",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@cspell/eslint-plugin": "^9.7.0",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.8.1",
+    "@eslint/js": "^10.0.1",
+    "@vitest/eslint-plugin": "^1.6.27",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import-x": "^4.16.1",
+    "eslint-plugin-n": "^17.23.2",
+    "eslint-plugin-prettier": "^5.5.5",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-sonarjs": "^4.2.2",
+    "globals": "^15.15.0",
+    "local-pkg": "^1.2.1",
+    "typescript-eslint": "^8.55.0"
+  },
+  "devDependencies": {
+    "eslint": "^10.0.2",
+    "prettier": "^3.8.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  },
+  "peerDependencies": {
+    "eslint": ">=10.0.0",
+    "prettier": ">=3.0.0",
+    "typescript": ">=5.0.0 <6.0.0"
+  },
+  "packageManager": "yarn@4.12.0",
+  "engines": {
+    "node": ">=22"
+  }
 }