@boringnode/tooling 0.0.0-stage → 0.1.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright 2026 Romain Lanz, contributors
+
+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,97 @@
-# Temporary Holding Version
+# @boringnode/tooling
 
-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.
+Shared OXLint and OXFmt configurations.
+
+## Installation
+
+```sh
+yarn add --dev @boringnode/tooling oxlint oxfmt
+```
+
+## OXLint
+
+```ts
+// oxlint.config.ts
+import { boringnodePreset } from '@boringnode/tooling/oxlint';
+
+export default boringnodePreset();
+```
+
+React and Vue rules are opt-in:
+
+```ts
+export default boringnodePreset({ react: true });
+```
+
+The preset enables these general rules by default:
+
+- `complexity`
+- `curly`
+- `eqeqeq`
+- `max-depth`
+- `no-else-return`
+- `no-nested-ternary`
+- `oxc/no-accumulating-spread`, the native companion of `anti-slop/no-reduce-accumulator-copy`
+- `prefer-const`
+- `typescript/consistent-type-definitions`
+- `typescript/no-explicit-any`
+- `typescript/no-non-null-assertion`
+
+It also enables the BoringNode-specific rules:
+
+- `boringnode/blank-line-after-imports`
+- `boringnode/max-logical-operands` (warning): name an inline `&&`/`||` chain of more than three operands
+- `boringnode/max-params`: at most four parameters, except the constructor of an `@inject()` class
+- `boringnode/no-await-in-call-arguments`: store `await` results before passing them to a call
+- `boringnode/no-await-in-call-targets`: rejects `(await x).method()`
+- `boringnode/no-await-in-conditions`: store `await` results before testing them
+- `boringnode/no-constructor-defaults`: inject a dependency instead of building it in a constructor default
+- `boringnode/no-typescript-private`: use `#private` members; private constructors and readonly constructor
+  dependencies remain allowed
+
+Finally, it enables all 18 generic rules from
+[`dmmulroy/anti-slop`](https://github.com/dmmulroy/anti-slop). They reject low-evidence type assertions,
+unsafe dictionary and `unknown` types, module mocking, reflection, runtime `typeof` narrowing, eager
+`filter().map()` passes, accumulator copies in reducers, and similar patterns. `require-readable-spacing`
+autofixes missing blank lines before control flow and `return`, after blocks, and around multiline
+declarations, while keeping comments attached to their statement. The vendored source tracks upstream commit
+`13909c9e07590f5a85d93c62712259fe14a883f7`; the optional Effect rules are not included.
+
+OXLint options and rules can be overridden in the same object:
+
+```ts
+export default boringnodePreset({
+	ignorePatterns: ['generated/**'],
+	rules: { complexity: 'off' },
+});
+```
+
+## OXFmt
+
+```ts
+// oxfmt.config.ts
+import { boringnodePreset } from '@boringnode/tooling/oxfmt';
+
+export default boringnodePreset();
+```
+
+Every OXFmt option can be overridden:
+
+```ts
+export default boringnodePreset({ printWidth: 100, useTabs: false });
+```
+
+## Scripts
+
+```json
+{
+	"scripts": {
+		"format": "oxfmt --check .",
+		"format:fix": "oxfmt --write .",
+		"lint": "oxlint",
+		"lint:fix": "oxlint --fix"
+	}
+}
+```
+
+New rules and formatting defaults may be added in minor releases. API changes follow semantic versioning.

package/THIRD_PARTY_LICENSES.md

@@ -0,0 +1,58 @@
+# Third-party licenses
+
+## anti-slop
+
+The anti-slop OXLint rules under `src/anti_slop` come from
+[`dmmulroy/anti-slop`](https://github.com/dmmulroy/anti-slop), commit
+`13909c9e07590f5a85d93c62712259fe14a883f7`.
+
+MIT License
+
+Copyright (c) 2026 Dillon Mulroy
+
+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.
+
+## ESLint Stylistic
+
+The padding engine under `src/anti_slop/vendor/eslint-stylistic`, used by `anti-slop/require-readable-spacing`,
+comes from [`eslint-stylistic/eslint-stylistic`](https://github.com/eslint-stylistic/eslint-stylistic), commit
+`435c3ea0fd26a5fef9042c4b36b6e165fbbf8d08`.
+
+MIT License
+
+Copyright OpenJS Foundation and other contributors, <www.openjsf.org>
+Copyright (c) 2023-PRESENT ESLint Stylistic contributors
+
+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/build/anti_slop.d.ts

@@ -0,0 +1,6 @@
+import * as _oxlint_plugins from '@oxlint/plugins';
+
+/** Generic Oxlint rules that reject low-evidence and low-signal implementation patterns. */
+declare const antiSlopPlugin: _oxlint_plugins.Plugin;
+
+export { antiSlopPlugin as default };