@solana-config/oxc 0.0.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Solana Foundation
+
+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,61 @@
+# `@solana-config/oxc`
+
+Shared [Oxlint](https://oxc.rs/docs/guide/usage/linter) and [Oxfmt](https://oxc.rs/docs/guide/usage/formatter) configurations for Solana projects. Matches the rules and style options from [`@solana-config/eslint`](../eslint) and [`@solana-config/prettier`](../prettier) to the Oxc-based toolchain.
+
+Both configs ship in two formats — a CommonJS factory and a JSON file — so consumers can use either `oxlint.config.ts` / `oxfmt.config.ts` or `.oxlintrc.json` / `.oxfmtrc.json`.
+
+## Install
+
+```sh
+pnpm add -D @solana-config/oxc oxlint oxlint-tsgolint oxfmt
+```
+
+`oxlint-tsgolint` is required for type-aware linting. Drop it if you don't enable `options.typeAware`.
+
+## Oxlint usage
+
+`options.typeAware` and `ignorePatterns` are root-config-only in Oxlint and cannot be inherited via `extends`. The shared config only sets `rules`, so consumers opt into type-aware linting in their own root config.
+
+### TypeScript config (`oxlint.config.ts`)
+
+```ts
+import { defineConfig } from 'oxlint';
+
+import solanaConfig from '@solana-config/oxc/oxlint';
+
+export default defineConfig({
+    extends: [solanaConfig],
+    options: { typeAware: true },
+});
+```
+
+### JSON config (`.oxlintrc.json`)
+
+```json
+{
+    "extends": ["./node_modules/@solana-config/oxc/oxlint.json"],
+    "options": { "typeAware": true }
+}
+```
+
+## Oxfmt usage
+
+Oxfmt has no `extends` mechanism, so consumers spread this config into their own `defineConfig({...})`.
+
+### TypeScript config (`oxfmt.config.ts`)
+
+```ts
+import { defineConfig } from 'oxfmt';
+
+import solanaFmt from '@solana-config/oxc/oxfmt';
+
+export default defineConfig({ ...solanaFmt });
+```
+
+### JSON config (`.oxfmtrc.json`)
+
+Oxfmt JSON configs do not support `extends`, so consumers either copy the contents of `oxfmt.json` or reference it via the `--config` CLI flag:
+
+```sh
+oxfmt --config ./node_modules/@solana-config/oxc/oxfmt.json
+```

package/oxfmt.d.ts

@@ -0,0 +1,4 @@
+import type { OxfmtConfig } from 'oxfmt';
+
+declare const config: OxfmtConfig;
+export default config;

package/oxfmt.js

@@ -0,0 +1,49 @@
+/**
+ * Shared Oxfmt configuration for Solana Kit projects.
+ *
+ * Ports {@link https://npmjs.com/package/@solana/prettier-config-solana | @solana/prettier-config-solana}
+ * to Oxfmt with the Solana code style: 4-space indent, 120-char print width,
+ * single quotes, semicolons, arrow parentheses avoided where possible.
+ *
+ * Adds {@link https://oxc.rs/docs/guide/usage/formatter/sorting | `sortImports`}
+ * (the Oxfmt built-in import sorter, disabled by default) to replace
+ * `eslint-plugin-simple-import-sort/imports` from `@solana/eslint-config-solana`,
+ * which has no native equivalent in Oxlint.
+ *
+ * Oxfmt has no `extends` mechanism, so consumers spread this object into their
+ * own `defineConfig({...})`.
+ *
+ * Authored as CommonJS so it can be imported from both CommonJS and ESM consumers.
+ *
+ * @example
+ * ```ts
+ * // oxfmt.config.ts
+ * import { defineConfig } from 'oxfmt';
+ *
+ * import solanaFmt from '@solana-config/oxc/oxfmt';
+ *
+ * export default defineConfig({ ...solanaFmt });
+ * ```
+ *
+ * @see {@link https://oxc.rs/docs/guide/usage/formatter | Oxfmt documentation}
+ * @type {import('oxfmt').OxfmtConfig}
+ */
+module.exports = {
+    arrowParens: 'avoid',
+    bracketSameLine: false,
+    bracketSpacing: true,
+    jsxSingleQuote: false,
+    overrides: [
+        {
+            files: ['*.yaml', '*.yml'],
+            options: { tabWidth: 2 },
+        },
+    ],
+    printWidth: 120,
+    quoteProps: 'as-needed',
+    semi: true,
+    singleQuote: true,
+    sortImports: true,
+    tabWidth: 4,
+    useTabs: false,
+};

package/oxfmt.json

@@ -0,0 +1,20 @@
+{
+    "$schema": "./node_modules/oxfmt/configuration_schema.json",
+    "arrowParens": "avoid",
+    "bracketSameLine": false,
+    "bracketSpacing": true,
+    "jsxSingleQuote": false,
+    "overrides": [
+        {
+            "files": ["*.yaml", "*.yml"],
+            "options": { "tabWidth": 2 }
+        }
+    ],
+    "printWidth": 120,
+    "quoteProps": "as-needed",
+    "semi": true,
+    "singleQuote": true,
+    "sortImports": true,
+    "tabWidth": 4,
+    "useTabs": false
+}

package/oxlint.d.ts

@@ -0,0 +1,4 @@
+import type { OxlintConfig } from 'oxlint';
+
+declare const config: OxlintConfig;
+export default config;

package/oxlint.js

@@ -0,0 +1,54 @@
+/**
+ * Shared Oxlint configuration for Solana Kit projects.
+ *
+ * Ports {@link https://npmjs.com/package/@solana/eslint-config-solana | @solana/eslint-config-solana}
+ * to Oxlint. The configuration only sets `rules` — Oxlint requires `options.typeAware` and
+ * `ignorePatterns` to live in the root config that consumes this one (see the example).
+ *
+ * Several of the rules below are type-aware. The consumer's root config must set
+ * `options.typeAware: true` (or pass `--type-aware` on the CLI) and have
+ * {@link https://npmjs.com/package/oxlint-tsgolint | oxlint-tsgolint} installed alongside
+ * {@link https://npmjs.com/package/oxlint | oxlint} for those rules to fire.
+ *
+ * Authored as CommonJS so it can be imported from both CommonJS and ESM consumers.
+ *
+ * @example
+ * ```ts
+ * // oxlint.config.ts
+ * import { defineConfig } from 'oxlint';
+ *
+ * import solanaConfig from '@solana-config/oxc/oxlint';
+ *
+ * export default defineConfig({
+ *     extends: [solanaConfig],
+ *     options: { typeAware: true },
+ * });
+ * ```
+ *
+ * @see {@link https://oxc.rs/docs/guide/usage/linter | Oxlint documentation}
+ * @type {import('oxlint').OxlintConfig}
+ */
+module.exports = {
+    rules: {
+        // Mirrors `@typescript-eslint/no-unused-vars` from `@solana/eslint-config-solana`.
+        // Oxlint's `eslint/no-unused-vars` is type-aware and supports the same options.
+        'no-unused-vars': [
+            'error',
+            {
+                argsIgnorePattern: '^_',
+                destructuredArrayIgnorePattern: '^_',
+            },
+        ],
+        // Replaces `eslint-plugin-sort-keys-fix`. Oxlint added autofix for this rule in v1.63.
+        'sort-keys': 'error',
+        // Type-aware rules from the Solana ESLint config. Several of these are already on by
+        // default in Oxlint when `typeAware` is enabled, but are listed here explicitly to
+        // preserve intent and stay stable across Oxlint version bumps.
+        'typescript/no-floating-promises': 'error',
+        'typescript/prefer-promise-reject-errors': 'error',
+        'typescript/require-await': 'error',
+        'typescript/restrict-plus-operands': 'error',
+        'typescript/restrict-template-expressions': 'error',
+        'typescript/return-await': ['error', 'always'],
+    },
+};

package/oxlint.json

@@ -0,0 +1,19 @@
+{
+    "$schema": "./node_modules/oxlint/configuration_schema.json",
+    "rules": {
+        "no-unused-vars": [
+            "error",
+            {
+                "argsIgnorePattern": "^_",
+                "destructuredArrayIgnorePattern": "^_"
+            }
+        ],
+        "sort-keys": "error",
+        "typescript/no-floating-promises": "error",
+        "typescript/prefer-promise-reject-errors": "error",
+        "typescript/require-await": "error",
+        "typescript/restrict-plus-operands": "error",
+        "typescript/restrict-template-expressions": "error",
+        "typescript/return-await": ["error", "always"]
+    }
+}

package/package.json

@@ -1,12 +1,58 @@
 {
   "name": "@solana-config/oxc",
-  "version": "0.0.0",
-  "description": "",
-  "license": "ISC",
-  "author": "",
-  "type": "commonjs",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "version": "0.1.1",
+  "description": "Shared Oxlint and Oxfmt configurations for Solana projects",
+  "license": "MIT",
+  "author": "Solana Maintainers <maintainers@solana.com>",
+  "homepage": "https://github.com/solana-foundation/js-configs/tree/main/packages/oxc#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/solana-foundation/js-configs.git",
+    "directory": "packages/oxc"
+  },
+  "bugs": {
+    "url": "https://github.com/solana-foundation/js-configs/issues"
+  },
+  "keywords": [
+    "config",
+    "oxc",
+    "oxfmt",
+    "oxlint",
+    "solana"
+  ],
+  "files": [
+    "oxfmt.d.ts",
+    "oxfmt.js",
+    "oxfmt.json",
+    "oxlint.d.ts",
+    "oxlint.js",
+    "oxlint.json"
+  ],
+  "exports": {
+    "./oxfmt": {
+      "types": "./oxfmt.d.ts",
+      "default": "./oxfmt.js"
+    },
+    "./oxfmt.json": "./oxfmt.json",
+    "./oxlint": {
+      "types": "./oxlint.d.ts",
+      "default": "./oxlint.js"
+    },
+    "./oxlint.json": "./oxlint.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "oxfmt": ">=0.48.0",
+    "oxlint": ">=1.63.0"
+  },
+  "peerDependenciesMeta": {
+    "oxfmt": {
+      "optional": true
+    },
+    "oxlint": {
+      "optional": true
+    }
   }
-}
+}