@hiddenability/opinionated-defaults 0.1.49 → 0.1.50

package/README.md

@@ -25,9 +25,7 @@ A collection of opinionated web-dev tooling configurations.
 > 
 > **Currently, the only supported package managers are bun and npm**.
 
-This package contains a CLI that can be used to generate both eslint.config.ts and prettier.config.mjs files.
-
-You can use it by running one of the following commands.
+This package contains a CLI that generates config files for your project. It will prompt you to choose between ESLint + Prettier or Oxlint + Oxfmt.
 
 ```sh
 bunx @hiddenability/opinionated-defaults
@@ -37,6 +35,13 @@ bunx @hiddenability/opinionated-defaults
 npx @hiddenability/opinionated-defaults
 ```
 
+You can skip the prompt with flags:
+
+```sh
+bunx @hiddenability/opinionated-defaults -es  # ESLint + Prettier
+bunx @hiddenability/opinionated-defaults -ox  # Oxlint + Oxfmt
+```
+
 ## Supported Framework Configurations:
 
 ### Eslint:
@@ -75,7 +80,11 @@ npx @hiddenability/opinionated-defaults
 - [eslint-plugin-perfectionist](https://github.com/azat-io/eslint-plugin-perfectionist)
 - [eslint-stylistic](https://github.com/eslint-stylistic/eslint-stylistic)
 
-### Oxlint:
+### Oxlint (ESLint replacement):
+
+#### Exports:
+
+- oxlintConfig (Config object for `oxlint.config.ts`)
 
 #### Enabled plugins:
 
@@ -90,7 +99,13 @@ npx @hiddenability/opinionated-defaults
 - node
 - jsx-a11y
 
-### Oxfmt:
+### Oxfmt (Prettier replacement):
+
+#### Exports:
+
+- oxfmtConfig (Config object for `oxfmt.config.ts`)
+
+#### Built-in features:
 
 - Import sorting (with newlines between groups)
 - Tailwind CSS class sorting (supports `cva`, `clsx`, `cn`)
@@ -131,20 +146,23 @@ npm i @hiddenability/opinionated-defaults -D
 
 ### Oxlint:
 
-Extend the config in your `.oxlintrc.json`:
+```ts
+// oxlint.config.ts
+import { defineConfig } from 'oxlint';
+import { oxlintConfig } from '@hiddenability/opinionated-defaults/oxlint';
 
-```json
-{
-  "extends": [
-    "./node_modules/@hiddenability/opinionated-defaults/dist/oxlintrc.json"
-  ]
-}
+export default defineConfig(oxlintConfig);
 ```
 
 ### Oxfmt:
 
-> [!NOTE]
-> Oxfmt does not yet support an `extends` field ([see here](https://github.com/oxc-project/oxc/issues/16394)), so the config must be copied into the project config location.
+```ts
+// oxfmt.config.ts
+import { defineConfig } from 'oxfmt';
+import { oxfmtConfig } from '@hiddenability/opinionated-defaults/oxfmt';
+
+export default defineConfig(oxfmtConfig);
+```
 
 ### Eslint:
 
@@ -207,7 +225,7 @@ For example, given the following css file:
 @import 'tailwindcss';
 ```
 
-This should be a minimal version of your Prettier config:
+This could be a minimal version of your Prettier config:
 
 ```ts
 // prettier.config.mjs

package/dist/oxfmt/index.d.ts

@@ -0,0 +1 @@
+export { default as oxfmtConfig } from "../oxfmtrc.json";

package/dist/oxfmt/index.mjs

@@ -0,0 +1 @@
+var t={arrowParens:"always",bracketSameLine:!1,bracketSpacing:!0,jsxSingleQuote:!0,semi:!0,singleQuote:!0,tabWidth:2,trailingComma:"all",useTabs:!1,sortImports:{newlinesBetween:!0},sortTailwindcss:{functions:["cva","clsx","cn"]}};export{t as oxfmtConfig};

package/dist/oxlint/index.d.ts

@@ -0,0 +1 @@
+export { default as oxlintConfig } from "../oxlintrc.json";

package/dist/oxlint/index.mjs

@@ -0,0 +1 @@
+var e={$schema:"./node_modules/oxlint/configuration_schema.json",categories:{correctness:"error",suspicious:"warn"},plugins:["typescript","unicorn","oxc","import","react","react-perf","nextjs","promise","node","jsx-a11y"],env:{es6:!0,browser:!0,node:!0},ignorePatterns:["**/dist/","**/node_modules/","**/.git/"],options:{typeAware:!0,typeCheck:!0},rules:{"typescript/no-misused-promises":["error",{checksVoidReturn:!1}],"no-unused-vars":["error",{args:"all",argsIgnorePattern:"^_",caughtErrors:"all",caughtErrorsIgnorePattern:"^_",destructuredArrayIgnorePattern:"^_",ignoreRestSiblings:!0,varsIgnorePattern:"^_"}],"typescript/prefer-nullish-coalescing":"error","unicorn/filename-case":["error",{cases:{kebabCase:!0}}],"unicorn/no-array-for-each":"off","unicorn/no-array-reduce":"off"}};export{e as oxlintConfig};

package/dist/oxlintrc.json

@@ -23,7 +23,8 @@
   },
   "ignorePatterns": ["**/dist/", "**/node_modules/", "**/.git/"],
   "options": {
-    "typeAware": true
+    "typeAware": true,
+    "typeCheck": true
   },
   "rules": {
     "typescript/no-misused-promises": ["error", { "checksVoidReturn": false }],

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hiddenability/opinionated-defaults",
   "description": "Opinionated default configurations for webdev tools.",
-  "version": "0.1.49",
+  "version": "0.1.50",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -29,6 +29,18 @@
         "types": "./dist/prettier/index.d.ts"
       }
     },
+    "./oxlint": {
+      "import": {
+        "default": "./dist/oxlint/index.mjs",
+        "types": "./dist/oxlint/index.d.ts"
+      }
+    },
+    "./oxfmt": {
+      "import": {
+        "default": "./dist/oxfmt/index.mjs",
+        "types": "./dist/oxfmt/index.d.ts"
+      }
+    },
     "./oxlintrc": {
       "import": {
         "default": "./dist/oxlintrc.json"