ci: add sync-docs to sync nextui docs

.github/workflows/sync.yml

@@ -0,0 +1,61 @@
+name: sync docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - README.md
+
+jobs:
+  sync-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v3
+        with:
+          check-latest: true
+          node-version-file: '.nvmrc'
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Set up Git
+        run: |
+          git config --global user.name 'winchesHe'
+          git config --global user.email '329487092@qq.com'
+
+      - name: Clone nextui repository
+        run: |
+          git clone https://github.com/nextui-org/nextui nextui --depth 1
+
+      - name: Run docs sync script
+        run: |
+          pnpm sync:docs
+
+      - name: Get version from package.json
+        id: get_version
+        run: |
+          VERSION=$(jq -r '.version' package.json)
+          echo "::set-output name=version::$VERSION"
+
+      - name: Commit changes to nextui repository
+        run: |
+          cd nextui
+          git add .
+          git commit -m "docs: sync api from nextui-cli v${{ steps.get_version.outputs.version }}"
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.PAT }}
+          path: nextui
+          branch: sync-docs-${{ steps.get_version.outputs.version }}
+          title: "docs: sync api from nextui-cli v${{ steps.get_version.outputs.version }}"
+          body: Sync api from nextui-cli.

README.md

@@ -100,12 +100,12 @@ NextUI CLI v0.2.1
 │
 ◇  Template created successfully!
 │
-◇  Next steps ───────────────────╮
-│                                │
-│  cd next-app-template          │
-│  npm install                   │
-│                                │
-├────────────────────────────────╯
+◇  Next steps ───────╮
+│                    │
+│  cd my-nextui-app  │
+│  npm install       │
+│                    │
+├────────────────────╯
 │
 └  🚀 Get started with npm run dev
 ```

package.json

@@ -46,6 +46,7 @@
     "link:remove": "pnpm uninstall --global nextui-cli",
     "build": "tsup",
     "update:components": "tsx src/scripts/update/update-components.ts",
+    "sync:docs": "tsx src/scripts/sync/sync.ts",
     "clean:cache": "tsx src/scripts/cache/clean.ts",
     "lint": "eslint . --max-warnings=0",
     "lint:fix": "eslint . -max-warnings=0 --fix",

src/index.ts

@@ -148,6 +148,9 @@ nextui.hook('preAction', async (command) => {
   // Init cache
   initCache(noCache);
 
+  // Init cache
+  initCache();
+
   if (args && commandList.includes(args as CommandName)) {
     // Before run the command init the components.json
     const nextUIComponents = (await getComponents()).components;

src/scripts/sync/index.ts

@@ -0,0 +1,36 @@
+import {readFileSync, writeFileSync} from 'node:fs';
+
+import {resolver} from 'src/constants/path';
+
+export function syncDocs() {
+  const docs = readFileSync(resolver('README.md'), 'utf-8');
+  const matchDocs = docs.match(/(?<=Usage: nextui \[command]\n\n)[\W\w]+(?=## Documentation)/)?.[0];
+
+  const targetPath = resolver('nextui/apps/docs/content/docs/api-references/cli-api.mdx');
+  const targetDocs = readFileSync(targetPath, 'utf-8');
+  const replaceTargetDocs = targetDocs.replace(/(?<=Usage: nextui \[command])[\W\w]+/, '');
+  let writeDocs = `${replaceTargetDocs}\n\n${matchDocs?.replace(/\n$/, '')}`;
+
+  writeDocs = writeDocs.replaceAll(/```bash/g, '```codeBlock bash');
+
+  writeFileSync(targetPath, writeDocs, 'utf-8');
+
+  syncApiRoutes();
+}
+
+function syncApiRoutes() {
+  const targetPath = resolver('nextui/apps/docs/config/routes.json');
+  const targetDocs = JSON.parse(readFileSync(targetPath, 'utf-8'));
+
+  targetDocs.routes.forEach((route) => {
+    if (route.key === 'api-references') {
+      route.routes.forEach((apiRoute) => {
+        if (apiRoute.key === 'cli-api') {
+          apiRoute.updated = true;
+        }
+      });
+    }
+  });
+
+  writeFileSync(targetPath, JSON.stringify(targetDocs, null, 2), 'utf-8');
+}

src/scripts/sync/sync.ts

@@ -0,0 +1,3 @@
+import {syncDocs} from '.';
+
+syncDocs();