refactor: organize types, errors, and imports (#275)

* refactor: re-organize types and errors

* style: remove extra empty line

* chore(deps): update dependencies

* style: sort imports via @trivago/prettier-plugin-sort-imports

* docs: fix undesired automatic formatting [skip ci]

* style: ignore files

Co-authored-by: Lucie <[email protected]>

.eslintignore

@@ -1,3 +1,5 @@
+CHANGELOG.md
+
 # .gitignore copy
 
 # custom

.prettierignore

@@ -1,3 +1,5 @@
+CHANGELOG.md
+
 # .gitignore copy
 
 # custom

.prettierrc

@@ -1,9 +1,29 @@
 {
-	"plugins": ["prettier-plugin-jsdoc"],
+	"plugins": ["prettier-plugin-jsdoc", "@trivago/prettier-plugin-sort-imports"],
 	"jsdocCapitalizeDescription": false,
 	"jsdocSeparateReturnsFromParam": true,
 	"jsdocSingleLineComment": false,
 	"tsdoc": true,
+	"importOrder": [
+		"^node:(.*)$",
+		"<THIRD_PARTY_MODULES>",
+		"^(?!.*/src(?:/|$)).*/__testutils__(?:/|$)",
+		"^(?!.*/src(?:/|$)).*/__fixtures__(?:/|$)",
+		"^(?!.*/src(?:/|$)).*/lib(?:/|$)",
+		"^(?!.*/src(?:/|$)).*/types(?:/|$)",
+		"^(?!.*/src(?:/|$)).*/errors(?:/|$)",
+		"^(?!.*/src(?:/|$))../../../../../",
+		"^(?!.*/src(?:/|$))../../../../",
+		"^(?!.*/src(?:/|$))../../../",
+		"^(?!.*/src(?:/|$))../../",
+		"^(?!.*/src(?:/|$))../",
+		"^(?!.*/src(?:/|$))./(.*/)+",
+		"^(?!.*/src(?:/|$))./",
+		"/src(?:/|$)"
+	],
+	"importOrderSeparation": true,
+	"importOrderSortSpecifiers": true,
+	"importOrderGroupNamespaceSpecifiers": true,
 	"printWidth": 80,
 	"useTabs": true,
 	"semi": true,

.size-limit.cjs

@@ -1,3 +1,21 @@
 const pkg = require("./package.json");
 
-module.exports = [pkg.module, pkg.main].filter(Boolean).map(path => ({ path }));
+module.exports = [
+	...new Set([
+		pkg.main,
+		pkg.module,
+		...Object.values(pkg.exports).flatMap((exportTypes) => {
+			if (typeof exportTypes === "string") {
+				return exportTypes;
+			} else {
+				return Object.values(exportTypes);
+			}
+		}),
+	]),
+]
+	.filter((path) => {
+		return path && path !== "./package.json";
+	})
+	.map((path) => {
+		return { path };
+	});

CONTRIBUTING.md

@@ -170,6 +170,7 @@ Anyone can, and is welcome to, contribute to the project by opening bug reports
 **🚨  Bug reports**
 
 > **Note**: An automated reply is posted when a bug report is opened to explain our maintenance schedule.
+
 Every Wednesday is _bug squashing day_. During this day, we respond to and/or fix bug reports.
 
 At the end of each Wednesday (assuming there were issues to fix), or later during the week if reviews are required, a _patch_ version is [released](#publishing) containing any fixes that were needed. Releasing multiple patches during the same week should be avoided.
@@ -179,6 +180,7 @@ Ideally, all opened bug reports are addressed each Wednesday. If a particular bu
 **🙋‍♀️  Feature requests**
 
 > **Note**: An automated message gets sent to people creating feature requests about this process.
+
 Every last week of a month is _feature week_. During this week, we implement new features. Discussing and coming up with implementation proposals can happen before that week, but implementations are targeted for the last week.
 
 At the end of the week (assuming there were features to implement), a _minor_ version is [released](#publishing) containing the new features. Releasing multiple minors during the same week should be avoided.

examples/custom-query-timeout/index.js

@@ -1,9 +1,8 @@
 import * as prismic from "@prismicio/client";
-import fetch, { AbortError } from "node-fetch";
-
 // AbortController was added in node v14.17.0 globally. If you are using a node
 // version >=14.17.0, or are not in a node environment, remove this line.
 import { AbortController } from "abort-controller";
+import fetch, { AbortError } from "node-fetch";
 
 // A global timeout can be implemented like the following. This timeout will
 // apply to all network requests made by the client.

examples/with-express/index.js

@@ -1,6 +1,6 @@
 import * as prismic from "@prismicio/client";
-import fetch from "node-fetch";
 import express from "express";
+import fetch from "node-fetch";
 import QuickLRU from "quick-lru";
 
 const cache = new QuickLRU({