refactoring utils project to use barrel output

pixiebrix · Nov 14, 2024 · 72b5f4b · 72b5f4b
1 parent f0cb378
commit 72b5f4b
Show file tree

Hide file tree

Showing 17 changed files with 37 additions and 17 deletions.
diff --git a/applications/browser-extension/package.json b/applications/browser-extension/package.json
@@ -40,7 +40,7 @@
     "@fortawesome/react-fontawesome": "^0.2.2",
     "@mozilla/readability": "^0.5.0",
     "@pixiebrix/jq-web": "^0.5.1",
-    "@pixiebrix/utils": "*",
+    "@pixiebrix/util-debug": "*",
     "@reduxjs/toolkit": "^1.9.7",
     "@rjsf/bootstrap-4": "^5.22.3",
     "@rjsf/core": "^5.22.3",

diff --git a/applications/browser-extension/src/pageEditor/store/editor/editorSlice.ts b/applications/browser-extension/src/pageEditor/store/editor/editorSlice.ts
@@ -34,7 +34,7 @@ import { uuidv4 } from "@/types/helpers";
 import { cloneDeep, compact, get, pull, uniq } from "lodash";
 import { DataPanelTabKey } from "@/pageEditor/tabs/editTab/dataPanel/dataPanelTypes";
 import { type TreeExpandedState } from "@/components/jsonTree/JsonTree";
-import { getInvalidPath } from "@pixiebrix/utils/src/debugUtils";
+import { getInvalidPath } from "@pixiebrix/util-debug";
 import {
   selectActiveBrickConfigurationUIState,
   selectActiveBrickPipelineUIState,

diff --git a/applications/browser-extension/tsconfig.json b/applications/browser-extension/tsconfig.json
@@ -17,7 +17,7 @@
     // All project dependencies
     // TODO: add @nx/js plugin which will automatically update these paths
     {
-      "path": "../../libraries/utils"
+      "path": "../../libraries/util-debug"
     }
   ],
   "exclude": ["venv", "dist", "node_modules"]

diff --git a/knip.mjs b/knip.mjs
@@ -36,8 +36,9 @@ const knipConfig = {
       ],
     },
     "libraries/*": {
-      entry: "src/*.ts!",
-      project: "**/*.ts",
+      // ! suffix files are included in production mode
+      entry: "src/index.ts!",
+      project: ["src/**/*.ts!", "!src/**/*.d.ts!"],
     },
     "applications/browser-extension": {
       entry: [

diff --git a/libraries/utils/.eslintrc.js → libraries/util-debug/.eslintrc.js b/libraries/utils/.eslintrc.js → libraries/util-debug/.eslintrc.js
diff --git a/libraries/utils/jest.config.js → libraries/util-debug/jest.config.js b/libraries/utils/jest.config.js → libraries/util-debug/jest.config.js
diff --git a/libraries/utils/package.json → libraries/util-debug/package.json b/libraries/utils/package.json → libraries/util-debug/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@pixiebrix/utils",
+  "name": "@pixiebrix/util-debug",
   "version": "1.0.0",
   "description": "PixieBrix Utility Library",
   "scripts": {
@@ -9,8 +9,9 @@
     "build": "tsc --build",
     "build:typecheck": "tsc --build"
   },
-  "license": "AGPL-3.0",
-  "repository": "https://github.com/pixiebrix/pixiebrix-extension",
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "sideEffects": false,
   "dependencies": {
     "formik": "^2.4.6"
   },

diff --git a/libraries/util-debug/src/index.ts b/libraries/util-debug/src/index.ts
@@ -0,0 +1,19 @@
+/*
+ * Copyright (C) 2024 PixieBrix, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+export * as debugUtils from "./lib/debugUtils";
+export * from "./lib/debugUtils";
diff --git a/libraries/utils/src/debugUtils.test.ts → ...ies/util-debug/src/lib/debugUtils.test.ts b/libraries/utils/src/debugUtils.test.ts → ...ies/util-debug/src/lib/debugUtils.test.ts
diff --git a/libraries/utils/src/debugUtils.ts → libraries/util-debug/src/lib/debugUtils.ts b/libraries/utils/src/debugUtils.ts → libraries/util-debug/src/lib/debugUtils.ts
diff --git a/libraries/utils/src/globals.d.ts → libraries/util-debug/src/lib/globals.d.ts b/libraries/utils/src/globals.d.ts → libraries/util-debug/src/lib/globals.d.ts
diff --git a/libraries/utils/tsconfig.json → libraries/util-debug/tsconfig.json b/libraries/utils/tsconfig.json → libraries/util-debug/tsconfig.json
diff --git a/libraries/utils/tsconfig.lib.json → libraries/util-debug/tsconfig.lib.json b/libraries/utils/tsconfig.lib.json → libraries/util-debug/tsconfig.lib.json
diff --git a/libraries/utils/tsconfig.test.json → libraries/util-debug/tsconfig.test.json b/libraries/utils/tsconfig.test.json → libraries/util-debug/tsconfig.test.json
@@ -1,7 +1,7 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "outDir": "../../dist/out-tsc/libraries/utils",
+    "outDir": "../../dist/out-tsc/libraries/util-debug",
     "types": ["jest", "node"]
   },
   "include": [

diff --git a/package-lock.json b/package-lock.json
diff --git a/pixiebrix-extension.iml b/pixiebrix-extension.iml
@@ -11,8 +11,8 @@
       <excludeFolder url="file://$MODULE_DIR$/.playwright-report" />
       <excludeFolder url="file://$MODULE_DIR$/applications/browser-extension/dist" />
       <excludeFolder url="file://$MODULE_DIR$/applications/browser-extension/node_modules" />
-      <excludeFolder url="file://$MODULE_DIR$/libraries/utils/coverage" />
       <excludeFolder url="file://$MODULE_DIR$/.nx" />
+      <excludeFolder url="file://$MODULE_DIR$/libraries/util-debug/coverage" />
       <excludePattern pattern="applications/browser-extension/report.html" />
     </content>
     <orderEntry type="inheritedJdk" />

diff --git a/tsconfig.json b/tsconfig.json
@@ -9,7 +9,7 @@
       "path": "./applications/browser-extension"
     },
     {
-      "path": "./libraries/utils"
+      "path": "./libraries/util-debug"
     }
   ]
 }