@hakula139/eslint-config 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Hakula
+
+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,91 @@
-# Temporary Holding Version
+# @hakula139/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.
+[![CI](https://github.com/hakula139/eslint-config/actions/workflows/ci.yml/badge.svg)](https://github.com/hakula139/eslint-config/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+Shared ESLint flat configs for Hakula's JavaScript and TypeScript repositories. Each preset is a config array to compose with ESLint's `defineConfig`, and Prettier owns formatting, so no preset sets a formatting rule.
+
+## Presets
+
+### `@hakula139/eslint-config`
+
+Lints every file ESLint lints with `@eslint/js` recommended, strict equality, braces on every block, `const`, no `var`, `no-throw-literal`, object shorthand, and sorted, deduplicated imports.
+
+### `@hakula139/eslint-config/typescript`
+
+Lints `**/*.{ts,tsx,mts,cts}` with typescript-eslint's `strictTypeChecked` and `stylisticTypeChecked`, PascalCase type names, separate type imports, exhaustive `switch`, and template literals that interpolate only strings and numbers.
+
+### Exceptions
+
+Both presets ignore an unused binding whose name starts with `_`, and a property destructured beside a rest element. The TypeScript preset turns off `@typescript-eslint/require-await`, so an `async` function can implement an interface without awaiting.
+
+## Installation
+
+Install ESLint 10 and `globals` beside the base preset:
+
+```bash
+pnpm add -D @hakula139/eslint-config eslint globals
+```
+
+The TypeScript preset also needs typescript-eslint 8.56 or later and a TypeScript version that release supports. typescript-eslint does not support TypeScript 7 yet, so the command installs TypeScript 6:
+
+```bash
+pnpm add -D typescript@^6 typescript-eslint
+```
+
+## Usage
+
+List `base`, then `typescript`, then the project's own globals, rules, and ignores in `eslint.config.js`:
+
+```js
+import base from '@hakula139/eslint-config';
+import { defineConfig } from 'eslint/config';
+import globals from 'globals';
+
+export default defineConfig([
+  base,
+  {
+    languageOptions: {
+      globals: globals.node,
+    },
+  },
+]);
+```
+
+The base preset sets no globals, so add the environments the code runs in.
+
+### TypeScript
+
+The TypeScript preset lints with type information through typescript-eslint's project service, which finds each file's nearest `tsconfig.json`. Set `tsconfigRootDir` to the config's directory, since typescript-eslint can infer it only when `eslint.config.js` reads its configs directly:
+
+```js
+import base from '@hakula139/eslint-config';
+import typescript from '@hakula139/eslint-config/typescript';
+import { defineConfig } from 'eslint/config';
+
+export default defineConfig([
+  base,
+  typescript,
+  {
+    languageOptions: {
+      parserOptions: {
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+]);
+```
+
+Each linted TypeScript file must belong to its discovered `tsconfig.json`. For files outside that project, the [project-service troubleshooting guide](https://typescript-eslint.io/troubleshooting/typed-linting/#project-service-issues) covers inclusion, ignores, a small default-project set, and disabling type-aware linting.
+
+## Versioning
+
+Any release that can make a passing project fail its lint is major, so minor and patch updates can merge without review. [RELEASING.md](RELEASING.md) defines the policy.
+
+## Development
+
+[`AGENTS.md`](AGENTS.md) is the contributor entry point for people and coding agents alike.
+
+## License
+
+Copyright (c) 2026 [Hakula](https://hakula.xyz). Licensed under the [MIT License](LICENSE).

package/package.json

@@ -1,6 +1,58 @@
 {
   "name": "@hakula139/eslint-config",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0",
+  "description": "Shared ESLint flat configs for JavaScript and TypeScript",
+  "keywords": [
+    "eslint",
+    "eslintconfig",
+    "eslint-config"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hakula139/eslint-config.git"
+  },
+  "homepage": "https://github.com/hakula139/eslint-config",
+  "bugs": {
+    "url": "https://github.com/hakula139/eslint-config/issues"
+  },
+  "type": "module",
+  "exports": {
+    ".": "./src/index.js",
+    "./typescript": "./src/typescript.js"
+  },
+  "files": [
+    "src"
+  ],
+  "dependencies": {
+    "@eslint/js": "^10.0.1",
+    "eslint-plugin-perfectionist": "^5.13.0"
+  },
+  "peerDependencies": {
+    "eslint": "^10.0.0",
+    "typescript-eslint": "^8.56.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript-eslint": {
+      "optional": true
+    }
+  },
+  "devEngines": {
+    "packageManager": {
+      "name": "pnpm",
+      "version": "^12.0.0",
+      "onFail": "error"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "eslint": "^10.14.0",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.72.1"
+  },
+  "scripts": {
+    "test": "node --test 'test/*.test.js'"
+  }
 }

package/src/index.js

@@ -0,0 +1,37 @@
+import js from '@eslint/js';
+import perfectionist from 'eslint-plugin-perfectionist';
+import { defineConfig } from 'eslint/config';
+
+import { unusedVarsOptions } from './unused-vars.js';
+
+export default defineConfig([
+  js.configs.recommended,
+  {
+    name: 'hakula139/base',
+    plugins: {
+      perfectionist,
+    },
+    rules: {
+      'curly': 'error',
+      'eqeqeq': 'error',
+      'no-duplicate-imports': ['error', { allowSeparateTypeImports: true }],
+      'no-throw-literal': 'error',
+      'no-unused-vars': ['error', unusedVarsOptions],
+      'no-var': 'error',
+      'object-shorthand': 'error',
+      'prefer-const': 'error',
+      'perfectionist/sort-imports': [
+        'error',
+        {
+          groups: [
+            ['type-builtin', 'value-builtin'],
+            ['type-external', 'value-external'],
+            ['type-internal', 'value-internal'],
+            'unknown',
+          ],
+        },
+      ],
+      'perfectionist/sort-named-imports': ['error', { groups: ['value-import', 'type-import'] }],
+    },
+  },
+]);

package/src/typescript.js

@@ -0,0 +1,36 @@
+import { defineConfig } from 'eslint/config';
+import tseslint from 'typescript-eslint';
+
+import { unusedVarsOptions } from './unused-vars.js';
+
+export default defineConfig({
+  name: 'hakula139/typescript',
+  files: ['**/*.{ts,tsx,mts,cts}'],
+  extends: [tseslint.configs.strictTypeChecked, tseslint.configs.stylisticTypeChecked],
+  languageOptions: {
+    parserOptions: {
+      projectService: true,
+    },
+  },
+  rules: {
+    '@typescript-eslint/consistent-type-imports': 'error',
+    '@typescript-eslint/naming-convention': [
+      'error',
+      { selector: 'typeLike', format: ['PascalCase'], leadingUnderscore: 'allow' },
+    ],
+    '@typescript-eslint/no-unused-vars': ['error', unusedVarsOptions],
+    '@typescript-eslint/require-await': 'off',
+    '@typescript-eslint/restrict-template-expressions': [
+      'error',
+      {
+        allow: [],
+        allowAny: false,
+        allowBoolean: false,
+        allowNullish: false,
+        allowNumber: true,
+        allowRegExp: false,
+      },
+    ],
+    '@typescript-eslint/switch-exhaustiveness-check': 'error',
+  },
+});

package/src/unused-vars.js

@@ -0,0 +1,7 @@
+export const unusedVarsOptions = {
+  argsIgnorePattern: '^_',
+  caughtErrorsIgnorePattern: '^_',
+  destructuredArrayIgnorePattern: '^_',
+  ignoreRestSiblings: true,
+  varsIgnorePattern: '^_',
+};