chore: migrate to monorepo

Author: hornta

.github/workflows/docs.yml

@@ -2,6 +2,8 @@ name: Documentation
 on:
   push:
     branches: [master]
+  pull_request:
+    types: [opened, synchronize]
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -11,12 +13,13 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 20
-      - run: npm ci
-      - run: npm run doc
+      - uses: pnpm/action-setup@v4
+      - run: pnpm i
+      - run: pnpm doc
       - name: Upload GitHub Pages artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: docs/
+          path: packages/melonjs/docs/
   deploy:
     runs-on: ubuntu-latest
     needs: build

.github/workflows/main.yml

@@ -1,7 +1,9 @@
 name: Test
 on:
   push:
+    branches: [master]
   pull_request:
+    types: [opened, synchronize]
 jobs:
   test:
     strategy:
@@ -16,7 +18,8 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
-      - run: npm ci
-      - run: npm run lint
-      - run: npx biome check
-      - run: npm run build
+      - uses: pnpm/action-setup@v4
+      - run: pnpm i
+      - run: pnpm lint
+      - run: pnpm biome check
+      - run: pnpm build

.github/workflows/test.yml

@@ -1,17 +1,20 @@
 name: Test
 on:
   push:
+    branches: [master]
   pull_request:
+    types: [opened, synchronize]
 jobs:
   test:
     runs-on: ubuntu-latest
     container:
-      image: mcr.microsoft.com/playwright:v1.44.1-jammy
+      image: mcr.microsoft.com/playwright:v1.45.1-jammy
     steps:
       - uses: actions/checkout@v4
       - name: Setup node
         uses: actions/setup-node@v4
         with:
           node-version: 20
-      - run: npm ci
-      - run: npm test
+      - uses: pnpm/action-setup@v4
+      - run: pnpm i
+      - run: pnpm test

.gitignore

@@ -1,6 +1,3 @@
-# Custom
-/tests/browser/public/lib/
-
 # Eclipse files
 .project
 .settings
@@ -10,7 +7,6 @@
 .DS_Store
 Thumbs.db
 Desktop.ini
-npm-debug.log
 
 # Vim swap files
 *.sw*
@@ -22,9 +18,10 @@ npm-debug.log
 # Project specific ignore
 add-on/
 node_modules/
-build/*
+**/build/
 dist/*
 !.placeholder
 /_SpecRunner.html
 package-lock.json
 docs/
+.turbo

.vscode/settings.json

@@ -6,6 +6,9 @@
 	"[typescript]": {
 		"editor.defaultFormatter": "biomejs.biome"
 	},
+	"[typescriptreact]": {
+		"editor.defaultFormatter": "biomejs.biome"
+	},
 	"files.eol": "\n",
 	"editor.codeActionsOnSave": {
 		"source.fixAll": "explicit",

CONTRIBUTING.md

@@ -7,28 +7,25 @@ Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community ap
 
 If this is your first time contributing to an open source project on GitHub, please have a look at [this free tutorial](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
 
-## Building melonJS
-
-To build your own version of melonJS you will need to install :
-
-- The [Node.js](http://nodejs.org/) JavaScript runtime and the [NPM](https://npmjs.org/) package manager
+## Developing melonJS
+The only things you need to start developing melonJS is [Node.js](http://nodejs.org/) and [pnpm](https://pnpm.io/installation). melonJS uses [Corepack](https://nodejs.org/api/corepack.html) to manage the package manager version. Follow the instructions to [install pnpm using Corepack](https://pnpm.io/installation#using-corepack). Run `pnpm install` to install third party dependencies.
 
-Once Node.js and NPM have been installed, you need to install build dependencies,
-by executing the following in the folder where you cloned the repository :
+You can start development mode by running `pnpm dev` which will build melonJS and the docs on every file change and start a Vite dev server with the examples so you can test out your changes in real time.
 
-    $ [sudo] npm install
-
-Then build the melonJS source by running:
+## Building melonJS
+Build the melonJS source by running:
 
-    $ npm run build
+    pnpm build
 
-The generated files will be available under the `build` directory :
-- `index.js` : a tree-shakeable ES6 Module Directory
-- `index.d.ts` : typescript declaration files
+The generated files will be available under the `build` directory:
+- `index.js`: melonJS ESM bundle
+- `index.js.map`: source map of the bundle
+- `*.d.ts`: TS declaration files
+- `*.d.ts.map`: TS declaration source maps
 
-To run the melonJS test suite simply use the following:
+To run the melonJS test suite use the following:
 
-    $ npm run test
+    pnpm test
 
 Last but not least, if you really want to contribute, but not sure how, you can
 always check our [discussions](https://github.com/melonjs/melonJS/discussions/categories/ideas) list to get some idea on where to start.
@@ -37,7 +34,7 @@ always check our [discussions](https://github.com/melonjs/melonJS/discussions/ca
 
 Similarly, you can build your own copy of the docs locally by running :
 
-    $ npm run doc
+    $ pnpm doc
 
 The documentation will be generated under the `docs` directory, and can be accessed by opening index.html in your web browser.
 

biome.json

@@ -4,8 +4,15 @@
 		"enabled": false
 	},
 	"files": {
-		"ignore": ["docs/", "build/"]
+		"ignore": ["docs/", "build/", ".turbo"]
 	},
 	"formatter": { "enabled": true },
-	"linter": { "enabled": false }
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true,
+			"nursery": { "recommended": true }
+		},
+		"include": ["packages/examples"]
+	}
 }

eslint.config.mjs

@@ -11,7 +11,7 @@ export default tseslint.config(
 	{
 		name: "eslint/global-ignores",
 		// globally ignore below directories and files
-		ignores: ["build", "docs/**/*", "rollup.config.mjs", "scripts/build.js"],
+		ignores: ["**/build", "**/docs/**/*", "**/node_modules", "**/examples"],
 	},
 	{
 		name: "eslint/global-rules",
@@ -22,7 +22,7 @@ export default tseslint.config(
 				...globals.browser,
 			},
 		},
-		files: ["src/**/*.js", "src/**/*.ts", "tests/**/*.js"],
+		files: ["**/src/**/*.js", "**/tests/**/*.js"],
 		plugins: {
 			jsdoc,
 		},