oxlint-plugin-utilities 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 HowManySmall
+
+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

@@ -0,0 +1,44 @@
+# oxlint-plugin-utilities
+
+## CI/CD & Branch Protection
+
+### Branch Protection Rules
+
+Configure these rules for `main` branch in GitHub Settings → Branches:
+
+1. **Require status checks to pass before merging**
+   - Required check: `validate` (from CI workflow)
+
+2. **Require branches to be up to date before merging**
+   - Ensures PR tests run on latest main
+
+3. **Require linear history** (optional)
+   - Prevents merge commits, keeps history clean
+
+4. **Require signed commits** (optional)
+   - Enhances security with commit signatures
+
+5. **Do not allow bypassing the above settings**
+   - Enforces rules for everyone (including admins)
+
+### Release Process
+
+1. **Version bump**: Run `bun run release` locally (bumpp)
+   - Interactive version selection
+   - Auto-commits, tags, and pushes
+
+2. **Automated publishing**:
+   - Tag push triggers `release.yaml` workflow
+   - Validates tag matches package.json version
+   - Runs tests
+   - Publishes to NPM with provenance
+   - Creates GitHub release with changelog
+
+3. **NPM Trusted Publishing**:
+   - No NPM_TOKEN secret needed
+   - Uses GitHub OIDC for authentication
+   - Configure at npmjs.com → Package Settings → Trusted Publishers
+   - Add trusted publisher:
+     - Repository: `howmanysmall/oxlint-plugin-utilities`
+     - Workflow: `release.yaml`
+     - Environment: (leave empty)

package/dist/build-metadata.json

@@ -0,0 +1,5 @@
+{
+  "commit": "1e1900ce64172b5efd75bb4102ec934bf2574cbd",
+  "time": "2026-04-04T19:23:06.828Z",
+  "version": "0.1.0"
+}

package/dist/index.d.ts

@@ -0,0 +1,77 @@
+import type { Context as OxlintContext } from "@oxlint/plugins";
+import type { Diagnostic as OxlintDiagnostic } from "@oxlint/plugins";
+import type { Rule as OxlintRule } from "@oxlint/plugins";
+import type { Rule as PluginsOxlintRule } from "@oxlint/plugins";
+import type { RuleMeta as OxlintRuleMeta } from "@oxlint/plugins";
+import type { Visitor } from "@oxlint/plugins";
+import type { VisitorWithHooks } from "@oxlint/plugins";
+import type { Except } from "type-fest";
+
+export type { AfterHook, BeforeHook, BooleanToken, Comment, CountOptions, Definition, DefinitionType, DiagnosticData, Envs, ESTree, FilterFn, FilterFn as FilterFunction, Fix, Fixer, FixFn, FixFn as FixFunction, Globals, IdentifierToken, JSXIdentifierToken, JSXTextToken, KeywordToken, LanguageOptions, Context as LegacyContext, CreateOnceRule as LegacyCreateOnceRule, CreateRule as LegacyCreateRule, Diagnostic as LegacyDiagnostic, Plugin as LegacyPlugin, Rule as LegacyRule, RuleMeta as LegacyRuleMeta, LineColumn, Location, Node, NullToken, NumericToken, Options, PrivateIdentifierToken, PunctuatorToken, Range, Ranged, RangeOptions, Reference, RegularExpressionToken, RuleDeprecatedInfo, RuleDocs, RuleOptionsSchema, RuleReplacedByExternalSpecifier, RuleReplacedByInfo, Scope, ScopeManager, ScopeType, Settings, SkipOptions, SourceCode, Span, StringToken, Suggestion, TemplateToken, Token, Variable, Visitor, VisitorWithHooks, } from "@oxlint/plugins";
+
+type RuleOptions<TRecord = Record<string, never>> = readonly [
+    TRecord
+];
+
+type Diagnostic<TMessageIds extends string = string> = Readonly<Except<OxlintDiagnostic, "messageId">> & {
+    readonly messageId: TMessageIds;
+};
+
+type Context<TOptions, TMessageIds extends string = string> = Except<OxlintContext, "options" | "report"> & {
+    readonly options: RuleOptions<TOptions>;
+    report(this: void, diagnostic: Diagnostic<TMessageIds>): void;
+};
+
+interface RuleMeta<TMessageIds extends string = string> extends Readonly<Except<OxlintRuleMeta, "messages">> {
+    readonly messages?: Record<TMessageIds, string>;
+}
+
+interface CreateOnceRule<TOptions = Record<string, never>, TMessageIds extends string = string> {
+    readonly create?: (context: Context<TOptions, TMessageIds>, optionsWithDefault: TOptions) => Visitor;
+    readonly createOnce: (context: Context<TOptions, TMessageIds>, optionsWithDefault: TOptions) => VisitorWithHooks;
+    readonly meta?: RuleMeta<TMessageIds>;
+}
+
+interface CreateRule<TOptions = Record<string, never>, TMessageIds extends string = string> {
+    readonly create: (context: Context<TOptions, TMessageIds>, optionsWithDefault: TOptions) => Visitor;
+    readonly meta?: RuleMeta<TMessageIds>;
+}
+
+type Rule<TOptions = Record<string, never>, TMessageIds extends string = string> = CreateOnceRule<TOptions, TMessageIds> | CreateRule<TOptions, TMessageIds>;
+
+interface Plugin<TRules extends Record<string, PluginsOxlintRule | Rule>> {
+    readonly meta?: {
+        readonly name?: string;
+    };
+    readonly rules: TRules;
+}
+
+/**
+ * Define a plugin.
+ *
+ * No-op function, just to provide type safety. Input is passed through unchanged. This is a stronger typed version of
+ * the original definePlugin.
+ *
+ * @template TRules - The rules of the plugin
+ * @param plugin - Plugin to define
+ * @returns Same plugin as passed in
+ */
+declare function definePlugin<TRules extends Record<string, OxlintRule | Rule>>(plugin: Plugin<TRules>): Plugin<TRules>;
+
+/**
+ * Define a rule.
+ *
+ * No-op function, just to provide type safety. Input is passed through unchanged. This is a stronger typed version of
+ * the original defineRule.
+ *
+ * @template TOptions - The rule options type
+ * @template TMessageIds - The message IDs type
+ * @param rule - Rule to define
+ * @returns Same rule as passed in
+ */
+declare function defineRule<TOptions, TMessageIds extends string>(rule: CreateRule<TOptions, TMessageIds>): CreateRule<TOptions, TMessageIds>;
+
+type InferContextFromRule<TRule> = TRule extends CreateRule<infer TOptions, infer TMessageIds> ? Context<TOptions, TMessageIds> : TRule extends CreateOnceRule<infer TOptions, infer TMessageIds> ? Context<TOptions, TMessageIds> : never;
+
+export type { Context, CreateOnceRule, CreateRule, Diagnostic, InferContextFromRule, Plugin, Rule, RuleMeta, RuleOptions };
+export { definePlugin, defineRule };

package/dist/index.js

@@ -0,0 +1,23 @@
+/**
+ * Define a plugin.
+ *
+ * No-op function, just to provide type safety. Input is passed through unchanged. This is a stronger typed version of
+ * the original definePlugin.
+ *
+ * @template TRules - The rules of the plugin
+ * @param plugin - Plugin to define
+ * @returns Same plugin as passed in
+ */
+function definePlugin(plugin){return plugin}
+/**
+ * Define a rule.
+ *
+ * No-op function, just to provide type safety. Input is passed through unchanged. This is a stronger typed version of
+ * the original defineRule.
+ *
+ * @template TOptions - The rule options type
+ * @template TMessageIds - The message IDs type
+ * @param rule - Rule to define
+ * @returns Same rule as passed in
+ */
+function defineRule(rule){return rule}export{defineRule,definePlugin};

package/package.json

@@ -0,0 +1,91 @@
+{
+	"name": "oxlint-plugin-utilities",
+	"version": "0.1.0",
+	"description": "A smarter wrapper around Oxlint's JS plugins types.",
+	"keywords": [
+		"lint",
+		"linting",
+		"oxlint",
+		"plugin",
+		"rules",
+		"utilities"
+	],
+	"license": "MIT",
+	"author": {
+		"name": "HowManySmall"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/howmanysmall/oxlint-plugin-utilities.git"
+	},
+	"files": [
+		"dist"
+	],
+	"type": "module",
+	"module": "src/index.ts",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js"
+		}
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"biome:check": "biome check",
+		"biome:ci": "biome ci",
+		"biome:lint": "biome lint",
+		"build": "bun run ./scripts/build.ts",
+		"commitlint": "commitlint --edit",
+		"format": "oxfmt",
+		"knip": "knip-bun",
+		"lint": "bash -c 'a=$(bash scripts/default-src.sh \"$@\"); bun run oxc $a && bun run biome:check $a' _",
+		"oxc": "oxlint",
+		"prepare": "lefthook install",
+		"prepublishOnly": "bun run build",
+		"release": "bumpp",
+		"test": "tsd --files 'src/**/*.test-d.ts'",
+		"type-check": "tsgo --noEmit"
+	},
+	"dependencies": {
+		"@oxlint/plugins": "^1.58.0",
+		"type-fest": "^5.5.0"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "^2.4.10",
+		"@commitlint/config-conventional": "^20.5.0",
+		"@commitlint/types": "^20.5.0",
+		"@jsr/cliffy__command": "^1.0.0",
+		"@total-typescript/ts-reset": "^0.6.1",
+		"@types/bun": "latest",
+		"@types/node": "^25.5.2",
+		"@typescript/native-preview": "^7.0.0-dev.20260403.1",
+		"bumpp": "^11.0.1",
+		"changelogithub": "^13.2.0",
+		"commitlint": "^20.5.0",
+		"consola": "^3.4.2",
+		"knip": "^6.3.0",
+		"oxfmt": "^0.43.0",
+		"oxlint": "^1.58.0",
+		"oxlint-tsgolint": "^0.19.0",
+		"picocolors": "^1.1.1",
+		"pretty-bytes": "^7.1.0",
+		"pretty-ms": "^9.3.0",
+		"temporal-polyfill": "^0.3.2",
+		"tsd": "^0.33.0"
+	},
+	"peerDependencies": {
+		"typescript": "^5"
+	},
+	"tsd": {
+		"files": [
+			"src/**/*.test-d.ts"
+		]
+	},
+	"engines": {
+		"node": ">=18"
+	},
+	"packageManager": "bun@1.3.11"
+}