feat: crawl pages

Author: egoist

.github/workflows/shipjs-manual-prepare.yml

@@ -0,0 +1,54 @@
+name: Ship js Manual Prepare
+on:
+  issue_comment:
+    types: [created]
+jobs:
+  manual_prepare:
+    if: |
+      github.event_name == 'issue_comment' &&
+      (github.event.comment.author_association == 'member' || github.event.comment.author_association == 'owner') &&
+      startsWith(github.event.comment.body, '@shipjs prepare')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          ref: master
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12'
+      - run: |
+          if [ -f "yarn.lock" ]; then
+            yarn install
+          else
+            npm install
+          fi
+      - run: |
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "github-actions[bot]"
+      - run: npm run release -- --yes --no-browse
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SLACK_INCOMING_HOOK: ${{ secrets.SLACK_INCOMING_HOOK }}
+
+  create_done_comment:
+    if: success()
+    needs: manual_prepare
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/github@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          args: comment "@${{ github.actor }} `shipjs prepare` done"
+
+  create_fail_comment:
+    if: cancelled() || failure()
+    needs: manual_prepare
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/github@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          args: comment "@${{ github.actor }} `shipjs prepare` fail"

.github/workflows/shipjs-schedule-prepare.yml

@@ -0,0 +1,29 @@
+name: Ship js Schedule Prepare
+on:
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    - cron: '0 3 * * 2'
+jobs:
+  schedule_prepare:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          ref: master
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12'
+      - run: |
+          if [ -f "yarn.lock" ]; then
+            yarn install
+          else
+            npm install
+          fi
+      - run: |
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "github-actions[bot]"
+      - run: npm run release -- --yes --no-browse
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SLACK_INCOMING_HOOK: ${{ secrets.SLACK_INCOMING_HOOK }}

.github/workflows/shipjs-trigger.yml

@@ -0,0 +1,30 @@
+name: Ship js trigger
+on:
+  pull_request:
+    types:
+      - closed
+jobs:
+  build:
+    name: Release
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true && startsWith(github.head_ref, 'releases/v')
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          ref: master
+      - uses: actions/setup-node@v1
+        with:
+          registry-url: 'https://registry.npmjs.org'
+          node-version: '12'
+      - run: |
+          if [ -f "yarn.lock" ]; then
+            yarn install
+          else
+            npm install
+          fi
+      - run: npx shipjs trigger
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+          SLACK_INCOMING_HOOK: ${{ secrets.SLACK_INCOMING_HOOK }}

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 .presite
+dist

README.md

@@ -2,11 +2,9 @@
 
 [![NPM version](https://img.shields.io/npm/v/presite.svg?style=flat)](https://npmjs.com/package/presite) [![NPM downloads](https://img.shields.io/npm/dm/presite.svg?style=flat)](https://npmjs.com/package/presite) [![CircleCI](https://circleci.com/gh/egoist/presite/tree/master.svg?style=shield)](https://circleci.com/gh/egoist/presite/tree/master) [![donate](https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&style=flat)](https://github.com/egoist/donate)
 
-## Why (not) prerender?
+## Why Presite?
 
-- It works for every single-page website
-- It requires no modification on your app code
-- But it does **not** suit a large website which depends heavily on async data - SSR would be preferred for that.
+Presite is an alternative to static site generators like Gatsby, Next.js and Nuxt.js etc, the difference is that it uses [Puppeteer](https://pptr.dev) to prerender websites instead of relying on server-side rendering.
 
 ## Install
 
@@ -68,14 +66,22 @@ Then the generated website can be found at `.presite` folder.
 </details>
 <br>
 
-By default it only prerenders path: `/`, you can configure `routes` option for more, see below:
+That's it, Presite prerender all pages of your website without any configuration!
+
+Run `presite --help` for all CLI flags.
 
 ## Configure in presite.config.js
 
+Many CLI flags can be stored in a configuration file, that's totaly optional but if you need one, read on.
+
 Note: You can also configuration it in `presite.config.json` or the `presite` key in `package.json`.
 
 #### Set routes that needs prerender
 
+**Note that in most cases you won't need this option, Presite automatically find all same-site `<a>` elements on the pages and prerender all of them.**
+
+If some of your pages are not referenced by other pages, you can manually specify them here:
+
 ```js
 module.exports = {
   routes: ['/', '/about']
@@ -121,8 +127,20 @@ Then you can call `window.snapshot` in your app when its contents are ready:
 window.snapshot && window.snapshot()
 ```
 
+To use a custom global variable name, set it to a string instead:
+
+```js
+module.exports = {
+  manually: `__my_snapshot__`
+}
+```
+
+Now you should call `window.__my_snapshot__()` instead.
+
 ### Source directory
 
+This is the same as using CLI `presite ./path/to/your/spa`:
+
 ```js
 module.exports = {
   baseDir: './path/to/your/spa'

bin/cli.js

@@ -11,14 +11,14 @@ jobs:
     steps:
       - checkout
       - restore_cache:
-          key: dependency-cache-{{ checksum "package-lock.json" }}
+          key: dependency-cache-{{ checksum "yarn.lock" }}
       - run:
           name: install dependences
-          command: npm i
+          command: yarn
       - save_cache:
-          key: dependency-cache-{{ checksum "package-lock.json" }}
+          key: dependency-cache-{{ checksum "yarn.lock" }}
           paths:
             - ./node_modules
       - run:
           name: test
-          command: npm test
+          command: yarn test

circle.yml

@@ -4,7 +4,7 @@
     <title>SPA</title>
   </head>
   <body>
-    <div id= "app"></div>
+    <div id="app"></div>
 
     <script src="/script.js"></script>
   </body>

example/index.html

@@ -1 +1,9 @@
-document.getElementById('app').innerHTML = 'text'
+if (location.pathname === '/') {
+  document.getElementById('app').innerHTML = `
+  <h1>home</h1>
+
+  <a href="/other">other page</a>
+  `
+} else {
+  document.getElementById('app').innerHTML = 'other page'
+}