@totto2727/oxlint 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 totto2727
+
+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,86 @@
-# Temporary Holding Version
+# @totto2727/oxlint
 
-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.
+[Oxlint](https://oxc.rs/docs/guide/usage/linter.html) rules and presets for TypeScript and Effect.
+
+## Usage
+
+Check your source files with the configured preset:
+
+```sh
+npx oxlint --config .oxlintrc.mjs src
+```
+
+Replace `src` with your source directory.
+The preset reports policy violations, such as `rules/no-let` for a `let` declaration.
+Tests use the same rules as application files.
+
+## Key features
+
+- Separate TypeScript and Effect presets, plus a combined preset.
+- Required import extensions and configurable TypeScript or JavaScript output extensions.
+- Shared native Ultracite settings and incorporated Effect rule implementations.
+- ESM exports with TypeScript declarations.
+
+## Prerequisites
+
+- Node.js 24 or later.
+- An ESM configuration.
+
+## Setup
+
+Install the plugin and Oxlint as development dependencies:
+
+```sh
+npm install --save-dev @totto2727/oxlint oxlint
+```
+
+Enable both rule groups in `.oxlintrc.mjs`:
+
+```js
+import preset from '@totto2727/oxlint/preset'
+import { defineConfig } from 'oxlint'
+
+export default defineConfig({ extends: [preset] })
+```
+
+Use `/typescript` or `/effect` instead of `/preset` to select one group.
+See [Getting started](https://oxlint.totto2727.dev/en/guide/getting-started) for individual-rule configuration.
+
+## API
+
+The default package export is the plugin: 29 local rules and five Effect rule implementations.
+All plugin rule IDs use the `rules/` prefix.
+The `/typescript`, `/effect` and `/preset` exports are Oxlint configurations.
+Named exports `typescriptRuleNames`, `effectRuleNames` and `compatibilityRuleNames` list the rules in each group.
+The four compatibility rules are available but not enabled by presets.
+
+- [TypeScript preset](https://oxlint.totto2727.dev/en/presets/typescript)
+- [Effect preset](https://oxlint.totto2727.dev/en/presets/effect), including external rules and disabled-rule reasons
+- [Local rules](https://oxlint.totto2727.dev/en)
+
+### Import extensions
+
+`require-import-extension` reports missing extensions without adding a guessed extension.
+`consistent-import-extension` converts known extensions and keeps ESM and CommonJS module families separate.
+The default mode is `ts`.
+
+| Input          | `ts` mode | `js` mode |
+| -------------- | --------- | --------- |
+| `.js`, `.ts`   | `.ts`     | `.js`     |
+| `.jsx`, `.tsx` | `.tsx`    | `.js`     |
+| `.mjs`, `.mts` | `.mts`    | `.mjs`    |
+| `.cjs`, `.cts` | `.cts`    | `.cjs`    |
+
+Set `'rules/consistent-import-extension': ['error', { mode: 'js' }]` in your configuration's `rules` object for JavaScript output.
+These rules check relative paths and slash-containing `#` paths, such as `#@/utils`, in imports, re-exports and literal dynamic imports.
+They ignore slashless aliases such as `#utils`.
+They preserve query strings and fragments and ignore bare package imports and non-code assets.
+
+## Development
+
+For repository maintenance instructions, see [AGENTS.md](./AGENTS.md).
+
+## License
+
+[MIT](./LICENSE).
+See [third-party notices](./THIRD-PARTY-NOTICES.md) for incorporated source licenses.

package/THIRD-PARTY-NOTICES.md

@@ -0,0 +1,48 @@
+# Third-party notices
+
+## Effect Oxlint rules
+
+This package contains code derived from Effect-TS/effect, packages/tools/oxc/src/oxlint/rules, at revision b1d200c40a1dad69def51ebdbf0a1a612a12b8ac.
+Source: https://github.com/Effect-TS/effect/tree/b1d200c40a1dad69def51ebdbf0a1a612a12b8ac/packages/tools/oxc/src/oxlint/rules
+Local files: src/upstream/effect/*.ts and their bundled output.
+Local acceptance cases also adapt examples from packages/tools/oxc/test at that revision.
+
+MIT License
+
+Copyright (c) 2023 Effectful Technologies Inc
+
+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.
+
+## Ultracite native Oxlint configuration
+
+The native core configuration and shared ignores are derived from Ultracite 7.12.3 at revision `48156546701badf2c6e60f25cf1e8511f7dc44c7`.
+Local files: `src/upstream/ultracite/core.ts`, `src/upstream/ultracite/ignores.ts`, and their bundled output.
+Source: <https://github.com/haydenbleasel/ultracite/blob/48156546701badf2c6e60f25cf1e8511f7dc44c7/packages/cli/config/oxlint/core/index.mjs>.
+License source: <https://github.com/haydenbleasel/ultracite/blob/48156546701badf2c6e60f25cf1e8511f7dc44c7/license.md>.
+The original MIT notice follows verbatim.
+
+```text
+Copyright (c) 2022 — Present Hayden Bleasel
+
+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/dist/effect.d.ts

@@ -0,0 +1,4 @@
+//#region src/effect.d.ts
+declare const _default: import("oxlint").OxlintConfig;
+//#endregion
+export { _default as default };

package/dist/effect.js

@@ -0,0 +1,6 @@
+import { n as effectRuleNames } from "./rule-groups-jUlABfyW.js";
+import { t as createPreset } from "./preset-builder-Qxb4CeX1.js";
+//#region src/effect.ts
+var effect_default = createPreset(effectRuleNames);
+//#endregion
+export { effect_default as default };

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+//#region src/rule-groups.d.ts
+export declare const typescriptRuleNames: readonly ['consistent-import-extension', 'no-eslint-disable-comments', 'no-jsx-script-tag', 'no-let', 'no-redundant-alias', 'no-string-style', 'require-disable-reason', 'require-import-extension'];
+export declare const effectRuleNames: readonly ['force-array-empty', 'force-iterable-empty', 'force-predicate', 'force-string-empty', 'no-effect-runtime-run', 'no-bigint-literals', 'no-import-from-barrel-package', 'no-opaque-instance-fields', 'no-unused-internal', 'no-error-cause-option', 'no-error-property-access', 'no-fetch', 'no-instanceof-error', 'no-js-date', 'no-node-imports', 'no-option-tag-comparison', 'no-raw-hono-create-middleware', 'no-sync-decode', 'no-type-predicate', 'prefer-is-nullish', 'prefer-non-unknown-decode', 'require-top-level-decoder'];
+export declare const compatibilityRuleNames: readonly ['force-ts-extension', 'no-effect-import-as', 'no-effect-subpath-import', 'no-js-extension-imports'];
+//#endregion
+//#region src/index.d.ts
+declare const plugin: {
+  meta: {
+    name: string;
+  };
+  rules: {
+    'no-bigint-literals': import("@oxlint/plugins").CreateRule;
+    'no-import-from-barrel-package': import("@oxlint/plugins").CreateRule;
+    'no-js-extension-imports': import("@oxlint/plugins").CreateRule;
+    'no-opaque-instance-fields': import("@oxlint/plugins").CreateRule;
+    'no-unused-internal': import("@oxlint/plugins").CreateRule;
+    'consistent-import-extension': import("@oxlint/plugins").Rule;
+    'require-import-extension': import("@oxlint/plugins").Rule;
+    'force-array-empty': import("@oxlint/plugins").Rule;
+    'force-iterable-empty': import("@oxlint/plugins").Rule;
+    'force-predicate': import("@oxlint/plugins").Rule;
+    'force-string-empty': import("@oxlint/plugins").Rule;
+    'force-ts-extension': import("@oxlint/plugins").Rule;
+    'no-effect-import-as': import("@oxlint/plugins").Rule;
+    'no-effect-runtime-run': import("@oxlint/plugins").Rule;
+    'no-effect-subpath-import': import("@oxlint/plugins").Rule;
+    'no-error-cause-option': import("@oxlint/plugins").Rule;
+    'no-error-property-access': import("@oxlint/plugins").Rule;
+    'no-eslint-disable-comments': import("@oxlint/plugins").Rule;
+    'no-fetch': import("@oxlint/plugins").Rule;
+    'no-instanceof-error': import("@oxlint/plugins").Rule;
+    'no-js-date': import("@oxlint/plugins").Rule;
+    'no-jsx-script-tag': import("@oxlint/plugins").Rule;
+    'no-let': import("@oxlint/plugins").Rule;
+    'no-node-imports': import("@oxlint/plugins").Rule;
+    'no-option-tag-comparison': import("@oxlint/plugins").Rule;
+    'no-raw-hono-create-middleware': import("@oxlint/plugins").Rule;
+    'no-redundant-alias': import("@oxlint/plugins").Rule;
+    'no-string-style': import("@oxlint/plugins").Rule;
+    'no-sync-decode': import("@oxlint/plugins").Rule;
+    'no-type-predicate': import("@oxlint/plugins").Rule;
+    'prefer-is-nullish': import("@oxlint/plugins").Rule;
+    'prefer-non-unknown-decode': import("@oxlint/plugins").Rule;
+    'require-disable-reason': import("@oxlint/plugins").Rule;
+    'require-top-level-decoder': import("@oxlint/plugins").Rule;
+  };
+};
+//#endregion
+export { plugin as default };