@hiddenability/opinionated-defaults 0.0.9 → 0.0.11

package/README.md

@@ -7,6 +7,18 @@ A collection of opinionated tooling configurations.
 - Elysia.js
 - Next.js
 
+####  Exports:
+- eslintConfigAstro (Astro)
+- eslintConfigElysia (Elysia.js)
+- eslintConfigNext (Next.js)
+- eslintConfigTurbo (Turborepo)
+- eslintConfigBase (General rules for every project)
+- eslintConfigFunctional (Enforces functional style)
+- eslintConfigPrettier (Runs prettier as ESLint rules)
+- eslintConfigReact (General rules for React)
+- eslintConfigRelative (Enforces the use of absolute import paths using path aliases)
+- eslintConfigStylistic (Enforces code-style through ESLint rules)
+
 #### Included plugins:
 - [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier)
 - [eslint-plugin-no-relative-import-paths](https://github.com/MelvinVermeer/eslint-plugin-no-relative-import-paths)
@@ -24,11 +36,18 @@ A collection of opinionated tooling configurations.
 - Next.js
 - +Opinionated defaults
 
+#### Exports:
+- prettierConfigAstro (Astro prettier rules with Tailwind class ordering)
+- prettierConfigNext (Rules for Next.js with Tailwind class ordering)
+- prettierConfigBase (General rules for every project)
+- configMerge (used to merge configurations)
+
 #### Included plugins:
 - [prettier-plugin-astro](https://github.com/withastro/prettier-plugin-astro)
 - [prettier-plugin-tailwindcss](https://github.com/tailwindlabs/prettier-plugin-tailwindcss)
 
 ## Installation:
+
 ```
 bun add @hiddenability/opinionated-defaults -d
 ```
@@ -38,7 +57,9 @@ npm i @hiddenability/opinionated-defaults -D
 ```
 
 ## Usage:
+
 ### Eslint:
+
 ```ts
 // eslint.config.ts
 import { eslintConfigConfigName } from "@hiddenability/opinionated-defaults/eslint";
@@ -48,19 +69,8 @@ const eslintConfig = [...eslintConfigConfigName];
 export default eslintConfig;
 ```
 
-####  Exports:
-- eslintConfigAstro (Astro)
-- eslintConfigElysia (Elysia.js)
-- eslintConfigNext (Next.js)
-- eslintConfigTurbo (Turborepo)
-- eslintConfigBase (General rules for every project)
-- eslintConfigFunctional (Enforces functional style)
-- eslintConfigPrettier (Runs prettier as ESLint rules)
-- eslintConfigReact (General rules for React)
-- eslintConfigRelative (Enforces the use of absolute import paths using path aliases)
-- eslintConfigStylistic (Enforces code-style through ESLint rules)
-
 ### Prettier:
+
 ```ts
 // prettier.config.mjs
 import { prettierConfigConfigName } from "@hiddenability/opinionated-defaults/prettier";
@@ -69,15 +79,16 @@ const prettierConfig = {...prettierConfigConfigName};
 
 export default prettierConfig;
 ```
+
 #### Extending/Combining Prettier Configs:
-Since prettier uses a configuration object instead of a flat config like ESLint, 
-to extend or combine configurations, you need to use the provided merge function.
+Since prettier uses a configuration object instead of a flat config like ESLint, to extend or combine configurations, you need to use the provided merge function.
+
 ```ts 
 // prettier.config.mjs
 import { 
   prettierConfig1,
   prettierConfig2,
-  configMerge,
+  merge,
 } from "@hiddenability/opinionated-defaults/prettier";
 
 const prettierConfig = merge(prettierConfig1, prettierConfig2, {/* your custom rules */} /*...*/);
@@ -85,11 +96,8 @@ const prettierConfig = merge(prettierConfig1, prettierConfig2, {/* your custom r
 export default prettierConfig;
 ```
 
-#### Exports:
-- prettierConfigAstro (Astro prettier rules with Tailwind class ordering)
-- prettierConfigNext (Rules for Next.js with Tailwind class ordering)
-- prettierConfigBase (General rules for every project)
-- configMerge (used to merge configurations)
+> [!NOTE]  
+> When using prettierConfigTailwind, it needs to come first in the merge function. Read more [here](https://github.com/tailwindlabs/prettier-plugin-tailwindcss#compatibility-with-other-prettier-plugins)
 
 ## TODO:
 - Improve repository structure (How to manage configuration options within eslint dir?).

package/dist/prettier/astro.mjs

@@ -1,5 +1,6 @@
 import baseConfig from "./base.mjs";
-import { merge } from "lodash";
+import lodash from "lodash";
+const { merge } = lodash;
 const astroConfig = merge(
   {
     plugins: ["prettier-plugin-astro"],

package/dist/prettier/index.d.ts

@@ -1,4 +1,4 @@
 export { default as prettierConfigBase } from './base';
 export { default as prettierConfigAstro } from './astro';
 export { default as prettierConfigTailwind } from './tailwind';
-export { default as configMerge } from 'lodash/merge';
+export declare const merge: any;

package/dist/prettier/index.mjs

@@ -1,4 +1,5 @@
+import lodash from "lodash";
 export { default as prettierConfigBase } from "./base.mjs";
 export { default as prettierConfigAstro } from "./astro.mjs";
 export { default as prettierConfigTailwind } from "./tailwind.mjs";
-export { default as configMerge } from "lodash/merge";
+export const { merge } = lodash;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hiddenability/opinionated-defaults",
   "description": "Opinionated default configurations for dev tools.",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -51,7 +51,7 @@
     "typescript-eslint": "^8.34.0"
   },
   "devDependencies": {
-    "@hiddenability/opinionated-defaults": "^0.0.8",
+    "@hiddenability/opinionated-defaults": "^0.0.10",
     "jiti": "^2.4.2",
     "typescript": "^5.8.3",
     "unbuild": "^3.5.0"