Merge pull request #68 from PlexusJS/feat/internal-overhaul

Feat/internal overhaul

Author: Pckool

.github/workflows/build.yml

@@ -21,7 +21,6 @@ jobs:
           path: |
             ~/.cache/yarn
             node_modules
-
           key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
             ${{ runner.os }}-build-${{ env.cache-name }}-

.github/workflows/npm-publish-canary.yml

@@ -21,7 +21,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
           registry-url: https://npm.pkg.github.com/
       - name: Cache node modules
         id: cache-yarn

.github/workflows/npm-publish-stable.yml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
       - run: yarn test
 
   publish-gpr:
@@ -28,7 +28,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
           registry-url: https://npm.pkg.github.com/
 
       - name: Cache node modules
@@ -37,7 +37,9 @@ jobs:
         env:
           cache-name: cache-node-module
         with:
-          path: ~/.cache/yarn
+          path: |
+            ~/.cache/yarn
+            node_modules
           key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
             ${{ runner.os }}-build-${{ env.cache-name }}-

.github/workflows/tests.yml

@@ -13,27 +13,22 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
       - name: Cache node modules
         id: cache-yarn
-        uses: actions/cache@v3
+        uses: actions/cache@v2
         env:
           cache-name: cache-node-module
         with:
-          path: ~/.cache/yarn
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
+          path: |
+            ~/.cache/yarn
+            node_modules
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock', '**/package.json') }}
           restore-keys: |
-            ${{ runner.os }}-build-${{ env.cache-name }}-
-            ${{ runner.os }}-build-
-            ${{ runner.os }}-
-
-      - if: ${{ steps.cache-yarn.outputs.cache-hit != 'true' }}
-        name: List the state of node modules
-        continue-on-error: true
-        run: yarn list
+            ${{ runner.os }}-yarn-
 
       - name: Install Dependencies
-        run: yarn install
+        run: yarn install --frozen-lockfile
 
       - name: Yarn Build
         run: yarn build

.github/workflows/trunk-nightly.yml

@@ -23,7 +23,9 @@ jobs:
         env:
           cache-name: cache-node-module
         with:
-          path: ~/.npm
+          path: |
+            ~/.cache/yarn
+            node_modules
           key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
             ${{ runner.os }}-build-${{ env.cache-name }}-

.github/workflows/trunk-pr.yml

@@ -18,7 +18,9 @@ jobs:
         env:
           cache-name: cache-node-module
         with:
-          path: ~/.npm
+          path: |
+            ~/.cache/yarn
+            node_modules
           key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
             ${{ runner.os }}-build-${{ env.cache-name }}-

docs/docs/api-reference/PlexusActionHelpers.mdx

@@ -12,7 +12,6 @@ The action helpers for a defined plexus action
   - [.onCatch(handler, useGlobal)](#PlexusActionHelpers+onCatch)
   - [.runErrorHandlers()](#PlexusActionHelpers+runErrorHandlers)
   - [.ignoreInit()](#PlexusActionHelpers+ignoreInit)
-  - [.batch(fn)](#PlexusActionHelpers+batch)
 
 <a name='PlexusActionHelpers+catchError'></a>
 
@@ -51,16 +50,3 @@ The action helpers for a defined plexus action
 ### .ignoreInit()
 
 <p>Ignore the default halt for preActions</p>
-
-<a name='PlexusActionHelpers+batch'></a>
-
-### .batch(fn)
-
-<p>
-	Run a function. During that function's execution, any state changes will be
-	batched and only applied once the function has finished.
-</p>
-
-| Param | Description                           |
-| ----- | ------------------------------------- |
-| fn    | <p>The function to run in a batch</p> |

docs/docs/api-reference/Scope.mdx

@@ -11,8 +11,6 @@ Create a new PlexusJS plugin
   - [.computed(item)](#Scope+computed) ⇒
   - [.event()](#Scope+event) ⇒
   - [.collection(config)](#Scope+collection) ⇒
-  - [.action(fn)](#Scope+action) ⇒
-  - [.batchAction(fn)](#Scope+batchAction) ⇒
   - [.batch(fn)](#Scope+batch)
   - [.preaction(fn)](#Scope+preaction) ⇒
 
@@ -60,30 +58,6 @@ Create a new PlexusJS plugin
 | ------ | ------------------------------------------- |
 | config | <p>The configuration for the collection</p> |
 
-<a name='Scope+action'></a>
-
-### .action(fn) ⇒
-
-<p>Generate a Plexus Action</p>
-
-**Returns**: <p>The intended return value of fn, or null if an error is caught</p>
-
-| Param | Description                              |
-| ----- | ---------------------------------------- |
-| fn    | <p>The Plexus action function to run</p> |
-
-<a name='Scope+batchAction'></a>
-
-### .batchAction(fn) ⇒
-
-<p>Generate a Plexus Action</p>
-
-**Returns**: <p>The intended return value of fn, or null if an error is caught</p>
-
-| Param | Description                              |
-| ----- | ---------------------------------------- |
-| fn    | <p>The Plexus action function to run</p> |
-
 <a name='Scope+batch'></a>
 
 ### .batch(fn)

docs/docs/api-reference/action.mdx

@@ -17,15 +17,3 @@ Generate a Plexus Action
 | Param | Description                              |
 | ----- | ---------------------------------------- |
 | fn    | <p>The Plexus action function to run</p> |
-
-<a name='Scope+action'></a>
-
-## .action(fn) ⇒
-
-<p>Generate a Plexus Action</p>
-
-**Returns**: <p>The intended return value of fn, or null if an error is caught</p>
-
-| Param | Description                              |
-| ----- | ---------------------------------------- |
-| fn    | <p>The Plexus action function to run</p> |

docs/docs/api-reference/batch.mdx

@@ -19,9 +19,9 @@ Run a function. During that function's execution, any state changes will be batc
 | ----- | ------------------------------------- |
 | fn    | <p>The function to run in a batch</p> |
 
-<a name='PlexusActionHelpers+batch'></a>
+<a name='batch'></a>
 
-## .batch(fn)
+## batch(fn)
 
 <p>
 	Run a function. During that function's execution, any state changes will be
@@ -36,6 +36,11 @@ Run a function. During that function's execution, any state changes will be batc
 
 ## .batch(fn)
 
+<p>
+	The batch function allows you to run a series of reactive actions in a single
+	transaction
+</p>
+
 <p>
 	The batch function allows you to run a series of actions in a single
 	transaction