@sister.software/oxfmt-config 12.1.3 → 13.0.1

package/out/index.d.ts

@@ -11,9 +11,8 @@ export type OxfmtConfig = Record<string, unknown>;
 /**
  * Sister Software's oxfmt configuration.
  *
- * Ported from the prior Prettier config. oxfmt natively covers what used to require Prettier plugins: `jsdoc` (JSDoc
- * comment formatting), `sortPackageJson` (package.json key ordering), and `sortImports` (import organization).
- * Consumers spread it into their own `oxfmt.config.ts`:
+ * Covers JSDoc formatting, package.json key ordering, and import organization. Consumers spread it into their own
+ * `oxfmt.config.ts`:
  *
  * ```ts
  * import { sisterSoftwareOxfmtConfig } from "@sister.software/oxfmt-config"

package/out/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEjD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,yBAAyB,EAAE,WAoBvC,CAAA;eAEc,yBAAyB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEjD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,yBAAyB,EAAE,WAiBvC,CAAA;eAEc,yBAAyB"}

package/out/index.js

@@ -7,9 +7,8 @@
 /**
  * Sister Software's oxfmt configuration.
  *
- * Ported from the prior Prettier config. oxfmt natively covers what used to require Prettier plugins: `jsdoc` (JSDoc
- * comment formatting), `sortPackageJson` (package.json key ordering), and `sortImports` (import organization).
- * Consumers spread it into their own `oxfmt.config.ts`:
+ * Covers JSDoc formatting, package.json key ordering, and import organization. Consumers spread it into their own
+ * `oxfmt.config.ts`:
  *
  * ```ts
  * import { sisterSoftwareOxfmtConfig } from "@sister.software/oxfmt-config"
@@ -23,18 +22,15 @@ export const sisterSoftwareOxfmtConfig = {
     semi: false,
     trailingComma: "es5",
     bracketSpacing: true,
-    // JSDoc comment formatting (replaces prettier-plugin-jsdoc). `commentLineStrategy: "keep"`
-    // preserves the author's single- vs multi-line choice (the prior jsdocCommentLineStrategy: "keep"),
-    // rather than oxfmt's default of collapsing short comments to one line.
+    // Preserve the author's single- vs multi-line JSDoc choice rather than collapsing short comments.
     jsdoc: {
         commentLineStrategy: "keep",
         // Blank line between the last @param and @returns.
         separateReturnsFromParam: true,
     },
-    // package.json key ordering (replaces prettier-plugin-packagejson).
+    // package.json key ordering.
     sortPackageJson: true,
-    // Import organization (replaces prettier-plugin-organize-imports). Pass an object instead of
-    // `true` to customize groups — see oxfmt's SortImportsUserConfig.
+    // Pass an object instead of `true` to customize import groups; see oxfmt's SortImportsUserConfig.
     sortImports: true,
 };
 export default sisterSoftwareOxfmtConfig;

package/out/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAOH;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAgB;IACrD,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,CAAC;IACX,UAAU,EAAE,GAAG;IACf,IAAI,EAAE,KAAK;IACX,aAAa,EAAE,KAAK;IACpB,cAAc,EAAE,IAAI;IACpB,2FAA2F;IAC3F,oGAAoG;IACpG,wEAAwE;IACxE,KAAK,EAAE;QACN,mBAAmB,EAAE,MAAM;QAC3B,mDAAmD;QACnD,wBAAwB,EAAE,IAAI;KAC9B;IACD,oEAAoE;IACpE,eAAe,EAAE,IAAI;IACrB,6FAA6F;IAC7F,kEAAkE;IAClE,WAAW,EAAE,IAAI;CACjB,CAAA;AAED,eAAe,yBAAyB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAOH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAgB;IACrD,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,CAAC;IACX,UAAU,EAAE,GAAG;IACf,IAAI,EAAE,KAAK;IACX,aAAa,EAAE,KAAK;IACpB,cAAc,EAAE,IAAI;IACpB,kGAAkG;IAClG,KAAK,EAAE;QACN,mBAAmB,EAAE,MAAM;QAC3B,mDAAmD;QACnD,wBAAwB,EAAE,IAAI;KAC9B;IACD,6BAA6B;IAC7B,eAAe,EAAE,IAAI;IACrB,kGAAkG;IAClG,WAAW,EAAE,IAAI;CACjB,CAAA;AAED,eAAe,yBAAyB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sister.software/oxfmt-config",
-	"version": "12.1.3",
+	"version": "13.0.1",
 	"description": "Sister Software's oxfmt config",
 	"license": "AGPL-3.0",
 	"author": "teffen@sister.software",

package/src/index.ts

@@ -13,9 +13,8 @@ export type OxfmtConfig = Record<string, unknown>
 /**
  * Sister Software's oxfmt configuration.
  *
- * Ported from the prior Prettier config. oxfmt natively covers what used to require Prettier plugins: `jsdoc` (JSDoc
- * comment formatting), `sortPackageJson` (package.json key ordering), and `sortImports` (import organization).
- * Consumers spread it into their own `oxfmt.config.ts`:
+ * Covers JSDoc formatting, package.json key ordering, and import organization. Consumers spread it into their own
+ * `oxfmt.config.ts`:
  *
  * ```ts
  * import { sisterSoftwareOxfmtConfig } from "@sister.software/oxfmt-config"
@@ -29,18 +28,15 @@ export const sisterSoftwareOxfmtConfig: OxfmtConfig = {
 	semi: false,
 	trailingComma: "es5",
 	bracketSpacing: true,
-	// JSDoc comment formatting (replaces prettier-plugin-jsdoc). `commentLineStrategy: "keep"`
-	// preserves the author's single- vs multi-line choice (the prior jsdocCommentLineStrategy: "keep"),
-	// rather than oxfmt's default of collapsing short comments to one line.
+	// Preserve the author's single- vs multi-line JSDoc choice rather than collapsing short comments.
 	jsdoc: {
 		commentLineStrategy: "keep",
 		// Blank line between the last @param and @returns.
 		separateReturnsFromParam: true,
 	},
-	// package.json key ordering (replaces prettier-plugin-packagejson).
+	// package.json key ordering.
 	sortPackageJson: true,
-	// Import organization (replaces prettier-plugin-organize-imports). Pass an object instead of
-	// `true` to customize groups — see oxfmt's SortImportsUserConfig.
+	// Pass an object instead of `true` to customize import groups; see oxfmt's SortImportsUserConfig.
 	sortImports: true,
 }