refactor: migrate to workspace monorepo

Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>

Author: neilime

.eslintignore

@@ -16,7 +16,7 @@ jobs:
     uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@b4883995e100e291a1fed68678d47a560328ed08 # 0.24.0
     with:
       linter-env: |
-        FILTER_REGEX_EXCLUDE=lib/**/*,docs/build/**/*
+        FILTER_REGEX_EXCLUDE=packages/theme/lib/**/*,packages/docs/build/**/*
         VALIDATE_JSCPD=false
         VALIDATE_TYPESCRIPT_ES=false
         VALIDATE_TYPESCRIPT_PRETTIER=false
@@ -29,7 +29,7 @@ jobs:
     with:
       build: |
         {
-          "artifact": ["lib", "docs/build"]
+          "artifact": ["packages/theme/lib", "packages/docs/build"]
         }
 
   package-theme:
@@ -46,6 +46,7 @@ jobs:
           path: .
 
       - name: Create package tarball
+        working-directory: packages/theme
         run: |
           npm pack --pack-destination ${{ runner.temp }}/
 

.eslintrc.json

@@ -46,9 +46,10 @@ jobs:
         with:
           name: package-tarball
           path: .
+
       - name: Publish CLI to npm
         run: |
-          npm publish hoverkraft-docusaurus-theme-*.tgz --provenance --access public --dry-run
+          npm publish hoverkraft-docusaurus-theme-*.tgz --provenance --access public --dry-run --latest
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
@@ -67,5 +68,5 @@ jobs:
       - id: deployment
         uses: hoverkraft-tech/ci-github-publish/actions/deploy/github-pages@6d9e5d48da1a80c085e8ed867d680a5e99b28217 # 0.8.0
         with:
-          build-path: docs/build
+          build-path: packages/docs/build
           build-artifact-name: build

.github/workflows/__shared-ci.yml

@@ -1,16 +1,14 @@
 # Dependencies
 node_modules/
-docs/node_modules/
+packages/*/node_modules/
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
 # Build output
-lib/
-dist/
-build/
-docs/build/
-docs/.docusaurus
+packages/theme/lib/
+packages/docs/build/
+packages/docs/.docusaurus
 
 # IDE
 .vscode/

.github/workflows/main-ci.yml

@@ -9,23 +9,22 @@ help: ## Show help message
 include .env
 
 prepare: ## Prepare stack to run
-	npm install
-	cd docs && npm install
+	pnpm install
 
 start: ## Start application in dev mode
-	cd docs && npm run start
+	pnpm --filter hoverkraft-theme-docs run start
 
 lint: ## Run linters
-	npm run lint -- $(filter-out $@,$(MAKECMDGOALS))
+	pnpm --filter @hoverkraft/docusaurus-theme run lint -- $(filter-out $@,$(MAKECMDGOALS))
 	$(call run_linter,)
 
 lint-fix: ## Run linters
-	npm run lint:fix
+	pnpm --filter @hoverkraft/docusaurus-theme run lint:fix
 	$(MAKE) linter-fix
 
 build: ## Build libs and applications
-	npm run build
-	cd docs && npm run build
+	pnpm --filter @hoverkraft/docusaurus-theme run build
+	pnpm --filter hoverkraft-theme-docs run build
 
 ci: ## Run tests in CI mode
 	$(MAKE) prepare

.gitignore

@@ -49,20 +49,20 @@ This theme provides:
 To contribute to this theme:
 
 1. Clone the repository
-2. Install dependencies: `npm install`
-3. Build the theme: `npm run build`
-4. Test your changes in a Docusaurus project
+2. Install dependencies: `pnpm install`
+3. Build the theme: `pnpm --filter @hoverkraft/docusaurus-theme run build`
+4. Test your changes locally (optional): `pnpm --filter hoverkraft-theme-docs run start`
 
 ### Building
 
 ```bash
-npm run build
+pnpm run build
 ```
 
 ### Watch mode for development
 
 ```bash
-npm run build:watch
+pnpm --filter @hoverkraft/docusaurus-theme run build:watch
 ```
 
 ## License