Replace papi-components with two new libraries (#704)

paranext · Jan 16, 2024 · c2dd689 · c2dd689
2 parents ff2fcc9 + 82c5d29
commit c2dd689
Show file tree

Hide file tree

Showing 193 changed files with 8,325 additions and 52,006 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -42,7 +42,8 @@ dist
 storybook-static
 
 # directories that have separate eslint project
-lib/papi-components
+lib/platform-bible-react
+lib/platform-bible-utils
 lib/papi-dts
 extensions
 

diff --git a/.github/assets/github-pages-index.html b/.github/assets/github-pages-index.html
@@ -40,7 +40,8 @@
   </head>
   <body>
     <h1>Platform.Bible API</h1>
-    <a href="papi-components/index.html">Go to papi-components</a>
+    <a href="platform-bible-react/index.html">Go to platform-bible-react</a>
+    <a href="platform-bible-utils/index.html">Go to platform-bible-utils</a>
     <a href="papi-dts/index.html">Go to papi-dts</a>
   </body>
 </html>
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -32,13 +32,16 @@ jobs:
 
       - name: Build documentation
         run: | # need to specify --out so pages links at /{their name} instead of at /docs
-          cd lib/papi-components
-          npm run build:docs -- --out papi-components
+          cd lib/platform-bible-react
+          npm run build:docs -- --out platform-bible-react
+          cd ../platform-bible-utils
+          npm run build:docs -- --out platform-bible-utils
           cd ../papi-dts
           npm run build:docs -- --out papi-dts
           cd ../../
           mkdir docs-for-pages
-          mv lib/papi-components/papi-components docs-for-pages
+          mv lib/platform-bible-react/platform-bible-react docs-for-pages
+          mv lib/platform-bible-utils/platform-bible-utils docs-for-pages
           mv lib/papi-dts/papi-dts docs-for-pages
 
       - name: Add nojekyll # needed so that HTML pages that start with _ do not cause 404

diff --git a/.prettierignore b/.prettierignore
@@ -42,7 +42,8 @@ dist
 storybook-static
 
 # directories that have separate eslint project
-lib/papi-components
+lib/platform-bible-react
+lib/platform-bible-utils
 lib/papi-dts
 extensions
 

diff --git a/.stylelintignore b/.stylelintignore
@@ -42,7 +42,8 @@ dist
 storybook-static
 
 # directories that have separate eslint project
-lib/papi-components
+lib/platform-bible-react
+lib/platform-bible-utils
 lib/papi-dts
 extensions
 

diff --git a/README.md b/README.md
@@ -86,9 +86,13 @@ Paranext Core extensions are found in the `extensions` folder. Please follow the
 
 - Explore the declarations of types available on the PAPI.
 
-**[Platform.Bible Components Documentation](https://paranext.github.io/paranext-core/papi-components)**
+**[Platform.Bible React Components and Hooks Documentation](https://paranext.github.io/paranext-core/platform-bible-react)**
 
-- Check out the React components available on the PAPI.
+- Check out the React components and hooks available to use.
+
+**[Platform.Bible Utilities Documentation](https://paranext.github.io/paranext-core/platform-bible-utils)**
+
+- Check out the utility functions, types, and classes available to use.
 
 ## JavaScript Tool Manager
 

diff --git a/extensions/package-lock.json b/extensions/package-lock.json
diff --git a/extensions/package.json b/extensions/package.json
@@ -51,7 +51,8 @@
     "css-loader": "^6.8.1",
     "escape-string-regexp": "^5.0.0",
     "glob": "^10.3.3",
-    "papi-components": "file:../lib/papi-components",
+    "platform-bible-react": "file:../lib/platform-bible-react",
+    "platform-bible-utils": "file:../lib/platform-bible-utils",
     "papi-dts": "file:../lib/papi-dts",
     "prettier": "^2.8.8",
     "prettier-plugin-jsdoc": "^0.4.2",