@elnop/lint-utils 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 elnop
+
+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,14 @@
-# Temporary Holding Version
+# @elnop/lint-utils
 
-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.
+Helpers shared by the `@elnop` lint plugins and configs. You probably want one of those instead:
+
+- [@elnop/eslint-plugin-file-named-after-export](https://www.npmjs.com/package/@elnop/eslint-plugin-file-named-after-export)
+- [@elnop/eslint-plugin-store-layout](https://www.npmjs.com/package/@elnop/eslint-plugin-store-layout)
+- [@elnop/oxlint-config-typescript](https://www.npmjs.com/package/@elnop/oxlint-config-typescript)
+
+It exports:
+
+- `baseName(filename)`: the file name without folder and extension
+- `exportsOf(program)`: the named exports of a module, with their declaration node
+- `ruleTester`: an oxlint `RuleTester` wired to `node:test`
+- `lintFixture(directory)`: runs oxlint in a folder with its own `oxlint.config.ts` and returns one `file:line rule` entry per diagnostic

package/dist/ExportTypes.d.ts

@@ -0,0 +1,5 @@
+import type { ESTree } from '@oxlint/plugins';
+export type ExportEntry = {
+    name: string;
+    node: ESTree.ExportNamedDeclaration;
+};

package/dist/ExportTypes.js

@@ -0,0 +1 @@
+export {};

package/dist/OxlintReportTypes.d.ts

@@ -0,0 +1,12 @@
+export type OxlintDiagnostic = {
+    code: string;
+    filename: string;
+    labels: {
+        span: {
+            line: number;
+        };
+    }[];
+};
+export type OxlintReport = {
+    diagnostics: OxlintDiagnostic[];
+};

package/dist/OxlintReportTypes.js

@@ -0,0 +1 @@
+export {};

package/dist/baseName.d.ts

@@ -0,0 +1 @@
+export declare function baseName(filename: string): string;

package/dist/baseName.js

@@ -0,0 +1,3 @@
+export function baseName(filename) {
+    return (filename.split('/').pop() ?? '').replace(/\.[^.]+$/, '');
+}

package/dist/exportsOf.d.ts

@@ -0,0 +1,3 @@
+import type { ESTree } from '@oxlint/plugins';
+import type { ExportEntry } from './ExportTypes.ts';
+export declare function exportsOf(program: ESTree.Program): ExportEntry[];

package/dist/exportsOf.js

@@ -0,0 +1,15 @@
+function declaredNames(declaration) {
+    if (declaration.type === 'VariableDeclaration')
+        return declaration.declarations.flatMap((declarator) => (declarator.id.type === 'Identifier' ? [declarator.id.name] : []));
+    return 'id' in declaration && declaration.id && 'name' in declaration.id ? [declaration.id.name] : [];
+}
+export function exportsOf(program) {
+    return program.body.flatMap((node) => {
+        if (node.type !== 'ExportNamedDeclaration')
+            return [];
+        const names = node.declaration
+            ? declaredNames(node.declaration)
+            : node.specifiers.map((specifier) => (specifier.exported.type === 'Identifier' ? specifier.exported.name : specifier.exported.value));
+        return names.map((name) => ({ name, node }));
+    });
+}

package/dist/lintFixture.d.ts

@@ -0,0 +1 @@
+export declare function lintFixture(directory: string): string[];

package/dist/lintFixture.js

@@ -0,0 +1,13 @@
+import { spawnSync } from 'node:child_process';
+import { fileURLToPath } from 'node:url';
+const OXLINT_BIN = fileURLToPath(new URL('bin/oxlint', import.meta.resolve('oxlint/package.json')));
+export function lintFixture(directory) {
+    const run = spawnSync(process.execPath, [OXLINT_BIN, '-c', 'oxlint.config.ts', '--format', 'json', '.'], { cwd: directory, encoding: 'utf8' });
+    if (run.error)
+        throw run.error;
+    const report = JSON.parse(run.stdout);
+    return report.diagnostics
+        .map((diagnostic) => ({ file: diagnostic.filename, line: diagnostic.labels[0]?.span.line ?? 0, code: diagnostic.code }))
+        .toSorted((left, right) => left.file.localeCompare(right.file) || left.line - right.line || left.code.localeCompare(right.code))
+        .map(({ file, line, code }) => `${file}:${line} ${code}`);
+}

package/dist/ruleTester.d.ts

@@ -0,0 +1,2 @@
+import { RuleTester } from 'oxlint/plugins-dev';
+export declare const ruleTester: RuleTester;

package/dist/ruleTester.js

@@ -0,0 +1,9 @@
+import { describe, it } from 'node:test';
+import { RuleTester } from 'oxlint/plugins-dev';
+RuleTester.describe = (text, fn) => {
+    void describe(text, fn);
+};
+RuleTester.it = (text, fn) => {
+    void it(text, fn);
+};
+export const ruleTester = new RuleTester();

package/package.json

@@ -1,6 +1,41 @@
 {
   "name": "@elnop/lint-utils",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Helpers shared by the @elnop lint plugins: export listing, file base name, oxlint rule and fixture testers.",
+  "keywords": [
+    "oxlint",
+    "eslint",
+    "lint"
+  ],
+  "homepage": "https://github.com/Elnop/eslint-plugins/tree/main/packages/utils/lint-utils#readme",
+  "bugs": "https://github.com/Elnop/eslint-plugins/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Elnop/eslint-plugins.git",
+    "directory": "packages/utils/lint-utils"
+  },
+  "license": "MIT",
+  "author": "elnop",
+  "type": "module",
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo"
+  ],
+  "exports": {
+    "./baseName": "./dist/baseName.js",
+    "./exportsOf": "./dist/exportsOf.js",
+    "./ExportTypes": "./dist/ExportTypes.js",
+    "./ruleTester": "./dist/ruleTester.js",
+    "./lintFixture": "./dist/lintFixture.js",
+    "./OxlintReportTypes": "./dist/OxlintReportTypes.js"
+  },
+  "dependencies": {
+    "@oxlint/plugins": "^1.91.0"
+  },
+  "peerDependencies": {
+    "oxlint": "^1.91.0"
+  },
+  "devDependencies": {
+    "oxlint": "^1.91.0"
+  }
+}