Add Pnpm support (follow-up of #162)

.github/workflows/build.yml

@@ -1,14 +1,26 @@
-name: command:build
-on: push
+name: extension build
+
+on:
+  push:
+
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20]
     steps:
-    - uses: actions/checkout@v2
-    - name: Install modules
-      run: yarn
+    - uses: actions/checkout@v4
+    - name: Install pnpm
+      uses: pnpm/action-setup@v4 # No version specified here
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'pnpm'
+    - name: Install dependencies
+      run: pnpm install
     - name: Run compiler
-      run: yarn compile
-    - name: Run `extenion build` command
-      run: yarn test:build
-
+      run: pnpm compile
+    - name: Run `extension build` command
+      run: pnpm test:build

.github/workflows/ci.yml

@@ -1,19 +1,30 @@
 name: 🛠
 
-on: push
+on:
+  push:
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20]
     steps:
-      - uses: actions/checkout@v2
-      - name: Install modules
-        run: yarn
-      - name: Run compiler
-        run: yarn compile
-      - name: Run tests
-        run: yarn test:coverage
-      - name: Upload results to Codecov
-        uses: codecov/codecov-action@v4
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+    - uses: actions/checkout@v4
+    - name: Install pnpm
+      uses: pnpm/action-setup@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'pnpm'
+    - name: Install dependencies
+      run: pnpm install
+    - name: Run compiler
+      run: pnpm compile
+    - name: Run tests
+      run: pnpm test:coverage
+    - name: Upload results to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/cli.yml

@@ -1,14 +1,26 @@
-name: cli
-on: push
+name: extension
+
+on:
+  push:
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20]
     steps:
-    - uses: actions/checkout@v2
-    - name: Install modules
-      run: yarn
+    - uses: actions/checkout@v4
+    - name: Install pnpm
+      uses: pnpm/action-setup@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'pnpm'
+    - name: Install dependencies
+      run: pnpm install
     - name: Run compiler
-      run: yarn compile
+      run: pnpm compile
     - name: Run `extenion` cli without arguments
-      run: yarn test:cli
+      run: pnpm test:cli

.github/workflows/create.yml

@@ -1,16 +1,27 @@
-name: command:create
-on: push
+name: extension create
+
+on:
+  push:
+
 jobs:
   build:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
+        node-version: [20]
     steps:
-    - uses: actions/checkout@v2
-    - name: Install modules
-      run: yarn
+    - uses: actions/checkout@v4
+    - name: Install pnpm
+      uses: pnpm/action-setup@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'pnpm'
+    - name: Install dependencies
+      run: pnpm install
     - name: Run compiler
-      run: yarn compile
+      run: pnpm compile
     - name: Run `extension create` command
-      run: yarn test:create
+      run: pnpm test:create

.github/workflows/dev.yml

@@ -1,13 +1,26 @@
-name: command:dev
-on: push
+name: extension dev
+
+on:
+  push:
+
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20]
     steps:
-    - uses: actions/checkout@v2
-    - name: Install modules
-      run: yarn
+    - uses: actions/checkout@v4
+    - name: Install pnpm
+      uses: pnpm/action-setup@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'pnpm'
+    - name: Install dependencies
+      run: pnpm install
     - name: Run compiler
-      run: yarn compile
+      run: pnpm compile
     - name: Run `extension dev` command
-      run: yarn test:dev
+      run: pnpm test:dev

.github/workflows/discord-notify-releases.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Github Releases To Discord
         uses: SethCohen/[email protected]
         with:

.github/workflows/preview.yml

@@ -1,13 +1,26 @@
-name: command:preview
-on: push
+name: extension preview
+
+on:
+  push:
+
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20]
     steps:
-    - uses: actions/checkout@v2
-    - name: Install modules
-      run: yarn
+    - uses: actions/checkout@v4
+    - name: Install pnpm
+      uses: pnpm/action-setup@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'pnpm'
+    - name: Install dependencies
+      run: pnpm install
     - name: Run compiler
-      run: yarn compile
+      run: pnpm compile
     # - name: Run `extension preview` command (TODO)
-    #   run: yarn test:preview
+    #   run: pnpm test:preview

.github/workflows/release-preview.yml

@@ -6,17 +6,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - run: corepack enable
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
         with:
-          node-version: 20
-          cache: 'yarn'
-      - name: Install modules
-        run: yarn install
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install
       - name: Run compiler
-        run: yarn compile
+        run: pnpm compile
       - name: Deploy release preview
-        run: pnpx pkg-pr-new publish './programs/*'
+        run: pnpx pkg-pr-new publish './programs/*'

.github/workflows/start.yml

@@ -1,13 +1,26 @@
 name: command:start
-on: push
+
+on:
+  push:
+
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20]
     steps:
-    - uses: actions/checkout@v2
-    - name: Install modules
-      run: yarn
+    - uses: actions/checkout@v4
+    - name: Install pnpm
+      uses: pnpm/action-setup@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'pnpm'
+    - name: Install dependencies
+      run: pnpm install
     - name: Run compiler
-      run: yarn compile
+      run: pnpm compile
     # - name: Run start tests (TODO)
-    #   run: yarn test:start
+    #   run: pnpm test:start

.gitignore

@@ -50,10 +50,14 @@ yarn-error.log*
 # swc
 .swc
 
+# pnpm
+pnpm-lock.yaml
+
 # Extension.js (beta)
 __TEST__
 
 # Examples
 /examples/**/package-lock.json
 /examples/**/yarn.lock
+/examples/**/pnpm-lock.yaml
 /examples/**/extension-env.d.ts

CONTRIBUTING.md

@@ -13,7 +13,7 @@ Extension.js runs on top of webpack using custom plugins. The whole Extension.js
 ## Installation
 
 1. Clone the project `[email protected]:cezaraugusto/extension.git` && `cd extension`.
-2. Install dependencies (will symlink files where appropriate) `yarn install`
+2. Install dependencies (will symlink files where appropriate) `pnpm install`
 3. Create an `.env` file at the project root and add `EXTENSION_ENV=development`
 
 ## Usage
@@ -22,25 +22,25 @@ To watch and apply changes to the project, you will need two or more terminals o
 
 ### Terminal 1: Watch mode
 
-Use it to watch file changes. Under the hood this runs the compiler (`yarn compile`) infinitely.
+Use it to watch file changes. Under the hood this runs the compiler (`pnpm compile`) infinitely.
 
 ```sh
-yarn watch
+pnpm watch
 ```
 
 ### Terminal 2: Mimick `extension` command behavior.
 
-Now that you have the watcher running, running `yarn extension <command> [argument]` will emulate the production `extension <command> [argument]`. Use it to experiment with the multiple Extension.js CLI commands.
+Now that you have the watcher running, running `pnpm extension <command> [argument]` will emulate the production `extension <command> [argument]`. Use it to experiment with the multiple Extension.js CLI commands.
 
 ```sh
-yarn extension <command> [argument]
+pnpm extension <command> [argument]
 ```
 
 That's all!
 
 ## Templates
 
-Extension.js uses its own templates for testing. If you need to test a React extension behavior for example, running `yarn extension dev ./examples/new-react` will open the `new-react` template and use the defaults applied for a React configuration.
+Extension.js uses its own templates for testing. If you need to test a React extension behavior for example, running `pnpm extension dev ./examples/new-react` will open the `new-react` template and use the defaults applied for a React configuration.
 
 ## Useful Commands
 
@@ -52,15 +52,15 @@ and are needed for the project development.
 This is the same command users run when they do `npx extension <command>
 
 ```sh
-yarn extension <command> [args] [flags]
+pnpm extension <command> [args] [flags]
 ```
 
 ### `compile`
 
 Compiles (builds) packages and programns. This npm script generates the `/dist` folder that other packages may consume.
 
 ```sh
-yarn compile
+pnpm compile
 ```
 
 ### `watch`
@@ -70,29 +70,29 @@ Like compile, but listens for code changes, where it compiles again.
 > Note: You want a terminal always running this command during development.
 
 ```sh
-yarn watch
+pnpm watch
 ```
 
 ### `lint`
 
 Iterates over all projects and lint them using ESLint.
 
 ```sh
-yarn lint
+pnpm lint
 ```
 
 ### `test`
 
 Run the test suite of each package and program (where available).
 
 ```sh
-yarn test
+pnpm test
 ```
 
 ### `clean`
 
 Deletes cache, `dist/` and `node_modules/` across packages and programs.
 
 ```sh
-yarn clean
+pnpm clean
 ```