From 990cb02f5f04bce9626804b401e40d91975fa350 Mon Sep 17 00:00:00 2001 From: Leonardo de Jesus Diz Conde Date: Wed, 4 Oct 2023 11:38:32 -0300 Subject: [PATCH] CU-86a0uwqwy - For neon-dappkit and wcsdk: Folders /dist and /docs shouldn't be commited --- .github/workflows/npm-publish.yml | 4 +- .gitignore | 1 + common/autoinstallers/rush-docs/package.json | 13 +++ .../autoinstallers/rush-docs/pnpm-lock.yaml | 89 +++++++++++++++++++ .../CU-86a0uwqwy_2023-10-04-18-35.json | 10 +++ .../CU-86a0uwqwy_2023-10-04-18-35.json | 10 +++ .../CU-86a0uwqwy_2023-10-04-18-35.json | 10 +++ .../CU-86a0uwqwy_2023-10-04-18-35.json | 10 +++ common/config/rush/command-line.json | 12 +++ .../package.json | 2 +- typedoc.json | 17 ++++ 11 files changed, 176 insertions(+), 2 deletions(-) create mode 100644 common/autoinstallers/rush-docs/package.json create mode 100644 common/autoinstallers/rush-docs/pnpm-lock.yaml create mode 100644 common/changes/@cityofzion/wallet-connect-sdk-core/CU-86a0uwqwy_2023-10-04-18-35.json create mode 100644 common/changes/@cityofzion/wallet-connect-sdk-react/CU-86a0uwqwy_2023-10-04-18-35.json create mode 100644 common/changes/@cityofzion/wallet-connect-sdk-wallet-core/CU-86a0uwqwy_2023-10-04-18-35.json create mode 100644 common/changes/@cityofzion/wallet-connect-sdk-wallet-react/CU-86a0uwqwy_2023-10-04-18-35.json create mode 100644 common/config/rush/command-line.json create mode 100644 typedoc.json diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml index ebc64cb..c85d2ab 100644 --- a/.github/workflows/npm-publish.yml +++ b/.github/workflows/npm-publish.yml @@ -38,10 +38,12 @@ jobs: run: rush rebuild - name: Publish Projects run: rush publish --apply --target-branch main --publish --npm-auth-token ${{ secrets.NPM_TOKEN }} --add-commit-details --include-all + - name: Merge Docs + run: rush docs - name: Publish Docs uses: actions/upload-pages-artifact@v2 with: - path: './packages/wallet-connect-sdk-core/docs' + path: './docs' - name: Deploy GitHub Pages uses: actions/deploy-pages@v2 - name: Commit and Push package.json version update diff --git a/.gitignore b/.gitignore index d4f47e0..84d99b8 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ yarn-error.log* # build files packages/*/dist/ packages/*/docs/ +/docs/ # Runtime data *.pid diff --git a/common/autoinstallers/rush-docs/package.json b/common/autoinstallers/rush-docs/package.json new file mode 100644 index 0000000..9c2cbcb --- /dev/null +++ b/common/autoinstallers/rush-docs/package.json @@ -0,0 +1,13 @@ +{ + "name": "rush-docs", + "version": "1.0.0", + "private": true, + "scripts": { + "update-script": "rush update-autoinstaller --name rush-docs" + }, + "dependencies": { + "@types/node": "^20.8.2", + "typescript": "^4.3.2", + "typedoc": "^0.25.1" + } +} diff --git a/common/autoinstallers/rush-docs/pnpm-lock.yaml b/common/autoinstallers/rush-docs/pnpm-lock.yaml new file mode 100644 index 0000000..0b1aaca --- /dev/null +++ b/common/autoinstallers/rush-docs/pnpm-lock.yaml @@ -0,0 +1,89 @@ +lockfileVersion: 5.4 + +specifiers: + '@types/node': ^20.8.2 + typedoc: ^0.25.1 + typescript: ^4.3.2 + +dependencies: + '@types/node': 20.8.2 + typedoc: 0.25.1_typescript@4.9.5 + typescript: 4.9.5 + +packages: + + /@types/node/20.8.2: + resolution: {integrity: sha512-Vvycsc9FQdwhxE3y3DzeIxuEJbWGDsnrxvMADzTDF/lcdR9/K+AQIeAghTQsHtotg/q0j3WEOYS/jQgSdWue3w==} + dev: false + + /ansi-sequence-parser/1.1.1: + resolution: {integrity: sha512-vJXt3yiaUL4UU546s3rPXlsry/RnM730G1+HkpKE012AN0sx1eOrxSu95oKDIonskeLTijMgqWZ3uDEe3NFvyg==} + dev: false + + /balanced-match/1.0.2: + resolution: {integrity: sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==} + dev: false + + /brace-expansion/2.0.1: + resolution: {integrity: sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==} + dependencies: + balanced-match: 1.0.2 + dev: false + + /jsonc-parser/3.2.0: + resolution: {integrity: sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==} + dev: false + + /lunr/2.3.9: + resolution: {integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==} + dev: false + + /marked/4.3.0: + resolution: {integrity: sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==} + engines: {node: '>= 12'} + hasBin: true + dev: false + + /minimatch/9.0.3: + resolution: {integrity: sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==} + engines: {node: '>=16 || 14 >=14.17'} + dependencies: + brace-expansion: 2.0.1 + dev: false + + /shiki/0.14.4: + resolution: {integrity: sha512-IXCRip2IQzKwxArNNq1S+On4KPML3Yyn8Zzs/xRgcgOWIr8ntIK3IKzjFPfjy/7kt9ZMjc+FItfqHRBg8b6tNQ==} + dependencies: + ansi-sequence-parser: 1.1.1 + jsonc-parser: 3.2.0 + vscode-oniguruma: 1.7.0 + vscode-textmate: 8.0.0 + dev: false + + /typedoc/0.25.1_typescript@4.9.5: + resolution: {integrity: sha512-c2ye3YUtGIadxN2O6YwPEXgrZcvhlZ6HlhWZ8jQRNzwLPn2ylhdGqdR8HbyDRyALP8J6lmSANILCkkIdNPFxqA==} + engines: {node: '>= 16'} + hasBin: true + peerDependencies: + typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x + dependencies: + lunr: 2.3.9 + marked: 4.3.0 + minimatch: 9.0.3 + shiki: 0.14.4 + typescript: 4.9.5 + dev: false + + /typescript/4.9.5: + resolution: {integrity: sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==} + engines: {node: '>=4.2.0'} + hasBin: true + dev: false + + /vscode-oniguruma/1.7.0: + resolution: {integrity: sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==} + dev: false + + /vscode-textmate/8.0.0: + resolution: {integrity: sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==} + dev: false diff --git a/common/changes/@cityofzion/wallet-connect-sdk-core/CU-86a0uwqwy_2023-10-04-18-35.json b/common/changes/@cityofzion/wallet-connect-sdk-core/CU-86a0uwqwy_2023-10-04-18-35.json new file mode 100644 index 0000000..a8c0776 --- /dev/null +++ b/common/changes/@cityofzion/wallet-connect-sdk-core/CU-86a0uwqwy_2023-10-04-18-35.json @@ -0,0 +1,10 @@ +{ + "changes": [ + { + "packageName": "@cityofzion/wallet-connect-sdk-core", + "comment": "", + "type": "none" + } + ], + "packageName": "@cityofzion/wallet-connect-sdk-core" +} \ No newline at end of file diff --git a/common/changes/@cityofzion/wallet-connect-sdk-react/CU-86a0uwqwy_2023-10-04-18-35.json b/common/changes/@cityofzion/wallet-connect-sdk-react/CU-86a0uwqwy_2023-10-04-18-35.json new file mode 100644 index 0000000..f149897 --- /dev/null +++ b/common/changes/@cityofzion/wallet-connect-sdk-react/CU-86a0uwqwy_2023-10-04-18-35.json @@ -0,0 +1,10 @@ +{ + "changes": [ + { + "packageName": "@cityofzion/wallet-connect-sdk-react", + "comment": "", + "type": "none" + } + ], + "packageName": "@cityofzion/wallet-connect-sdk-react" +} \ No newline at end of file diff --git a/common/changes/@cityofzion/wallet-connect-sdk-wallet-core/CU-86a0uwqwy_2023-10-04-18-35.json b/common/changes/@cityofzion/wallet-connect-sdk-wallet-core/CU-86a0uwqwy_2023-10-04-18-35.json new file mode 100644 index 0000000..d8ae074 --- /dev/null +++ b/common/changes/@cityofzion/wallet-connect-sdk-wallet-core/CU-86a0uwqwy_2023-10-04-18-35.json @@ -0,0 +1,10 @@ +{ + "changes": [ + { + "packageName": "@cityofzion/wallet-connect-sdk-wallet-core", + "comment": "", + "type": "none" + } + ], + "packageName": "@cityofzion/wallet-connect-sdk-wallet-core" +} \ No newline at end of file diff --git a/common/changes/@cityofzion/wallet-connect-sdk-wallet-react/CU-86a0uwqwy_2023-10-04-18-35.json b/common/changes/@cityofzion/wallet-connect-sdk-wallet-react/CU-86a0uwqwy_2023-10-04-18-35.json new file mode 100644 index 0000000..67a2c5f --- /dev/null +++ b/common/changes/@cityofzion/wallet-connect-sdk-wallet-react/CU-86a0uwqwy_2023-10-04-18-35.json @@ -0,0 +1,10 @@ +{ + "changes": [ + { + "packageName": "@cityofzion/wallet-connect-sdk-wallet-react", + "comment": "", + "type": "none" + } + ], + "packageName": "@cityofzion/wallet-connect-sdk-wallet-react" +} \ No newline at end of file diff --git a/common/config/rush/command-line.json b/common/config/rush/command-line.json new file mode 100644 index 0000000..6d49cc2 --- /dev/null +++ b/common/config/rush/command-line.json @@ -0,0 +1,12 @@ +{ + "commands": [ + { + "name": "docs", + "commandKind": "global", + "summary": "Used to generate documentation of each package", + "safeForSimultaneousRushProcesses": true, + "autoinstallerName": "rush-docs", + "shellCommand": "for /d %i in (./packages/*) do (npm run docs --prefix packages/%i/) && typedoc --options typedoc.json" + } + ] +} diff --git a/packages/wallet-connect-sdk-wallet-react/package.json b/packages/wallet-connect-sdk-wallet-react/package.json index afec4a6..0e4ad24 100644 --- a/packages/wallet-connect-sdk-wallet-react/package.json +++ b/packages/wallet-connect-sdk-wallet-react/package.json @@ -27,7 +27,7 @@ "scripts": { "build": "microbundle-crl --no-compress --format modern,cjs", "start": "microbundle-crl watch --no-compress --format modern,cjs", - "docs": "typedoc", + "docs": "typedoc src/index.ts", "fmt": "eslint .", "publishDocs:develop": "aws s3 sync ./docs s3://marketing-neon-wallet/dev/wksdk/react --acl public-read", "publishDocs:prod": "aws s3 sync ./docs s3://marketing-neon-wallet/prod/wksdk/react --acl public-read" diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 0000000..7c4e19c --- /dev/null +++ b/typedoc.json @@ -0,0 +1,17 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "tsconfig": "tsconfig.json", + "entryPoints": [ + "packages/wallet-connect-sdk-core/", + "packages/wallet-connect-sdk-react/", + "packages/wallet-connect-sdk-wallet-core/", + "packages/wallet-connect-sdk-wallet-react/src/index.tsx" + ], + "includeVersion": true, + "entryPointStrategy": "packages", + "out": "docs", + "exclude": ["**/dist/**"], + "compilerOptions": { + "jsx": "react" + } +}