Merge pull request #238 from vechainfoundation/237-not-working-with-l…

…ast-version-of-yarn

Fix compatibility with node 20

.github/workflows/build-lint.yml

@@ -14,7 +14,7 @@ jobs:
             - name: Setup Node
               uses: actions/setup-node@v4
               with:
-                  node-version-file: .nvmrc
+                  node-version: lts/*
 
             - name: Install & Patch packages
               run: yarn install

.github/workflows/on-pr.yml

@@ -15,16 +15,16 @@ jobs:
             - name: Setup Node
               uses: actions/setup-node@v4
               with:
-                node-version-file: .nvmrc
+                node-version: lts/*
             - name: Build SDK
               run:  |
                 rm -rf ./**/node_modules/
                 yarn install
                 yarn build
-            - name: Test docs
+            - name: Test docs examples
               run: |
                 cd docs
-                yarn test:docs
+                yarn test:examples
 
     install-build:
         uses: ./.github/workflows/build-lint.yml

.github/workflows/typedoc.yml

@@ -32,7 +32,7 @@ jobs:
         - name: Setup Node
           uses: actions/setup-node@v4
           with:
-              node-version-file: .nvmrc
+              node-version: lts/*
 
         - name: Install packages
           run: yarn install

.github/workflows/unit-integration-test.yml

@@ -14,7 +14,7 @@ jobs:
             - name: Setup Node
               uses: actions/setup-node@v4
               with:
-                  node-version-file: .nvmrc
+                  node-version: lts/*
 
             - name: Install & Patch packages
               run: yarn install

.gitignore

@@ -5,6 +5,7 @@ packages/**/node_modules
 apps/**/dist
 apps/**/.turbo
 apps/**/node_modules
+docs/**/dist
 
 yarn-error.log
 # Code coverage folders and files

docs/README.md

@@ -27,7 +27,6 @@ Note: links that are to be expanded must have text \[example]
 
 * To execute the scripts within `/examples` as tests: `yarn test:examples`
 * To build the documentation by expanding examples: `yarn build`
-* To execute code from the built documentation (build check): `yarn test:docs`
 
 
 

docs/package.json

@@ -4,19 +4,15 @@
   "type": "module",
   "version": "1.0.0",
   "scripts": {
-    "test:docs": "npx runme run --all --category example --skip-prompts",
     "test:examples": "ts-node-test examples/",
-    "build": "find . -name \"*.md\" -type f -maxdepth 1 ! -name \"README.md\" -delete && yarn ts-node builddocs.ts"
+    "build": "find . -name \"*.md\" -type f -maxdepth 1 ! -name \"README.md\" -delete && tsup builddocs.ts && node dist/builddocs.cjs"
   },
   "dependencies": {
     "@vechain-sdk/core": "*",
     "typescript": "^5.2.2"
   },
   "devDependencies": {
     "expect": "^29.7.0",
-    "runme": "^3.0.2",
-    "thor-devkit": "^2.0.9",
-    "ts-node": "^10.9.1",
     "ts-node-test": "^0.4.3"
   }
 }

package.json

@@ -13,7 +13,6 @@
         "test:unit": "turbo test:unit",
         "test:integration": "turbo test:integration",
         "format": "turbo format",
-        "test:docs": "turbo test:docs",
         "test:examples": "turbo test:examples",
         "merge-coverage": "ts-node scripts/merge-coverage.ts",
         "generate:apidocs": "typedoc --options typedoc.json --logLevel Verbose"

turbo.json

@@ -21,9 +21,6 @@
             "dependsOn": ["^build"]
         },
         "format": {},
-        "test:docs": {
-            "dependsOn": ["^build"]
-        },
         "test:examples": {
             "dependsOn": ["^build"]
         }