@tenjuu99/blog 0.1.4 → 0.1.7

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Amashige Seiji
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,21 +1,18 @@
 # blog template
 
-## プレビュー
-
-以下のコマンドでプレビューできます。
+## setup
 
 ```
-npm run watch
+npm i @tenjuu99/blog
 ```
 
-`http://localhost:8000/`
-
-デフォルトでは8000ポートを利用しますが、環境変数を使ってポート番号を上書きできます。
-
 ```
-PORT=8001 npm run watch
+npx create-blog
+npx server
 ```
 
+`http://localhost:8000` にアクセスできます
+
 ## 記事を書く
 
 `./data/` 以下にマークダウンファイルを入稿します。
@@ -122,24 +119,7 @@ This is else content.
 ### SCRIPT
 
 ```markdown
-{script}
-// write javascript and return value
-{/script}
+<script type="ssg">
+return 'これはスクリプトが実行された結果出力されました。'
+</script>
 ```
-
-## デプロイ
-
-AWS S3 にデプロイするには、 `.github/workflow/deploy.yml.sample` を `.github/workflow/deploy.yml` にコピーします。  
-また、 `.env.prod` を作成して、以下の値を登録します。
-
-```
-SITE_NAME: テストサイト
-URL_BASE: https://example.com
-GTAG_ID: G-xxxx
-```
-
-GitHub のリポジトリで、`settings > Secrets and variables > Actions` から、以下の変数を登録します。
-
-* `AWS_ACCESS_KEY_ID`
-* `AWS_SECRET_ACCESS_KEY_ID`
-* `S3_URL`

package/bin/new

@@ -10,7 +10,7 @@ mkdir -p "$(pwd)/src/image"
 echo "create src/image"
 
 mkdir "$(pwd)/.cache"
-echo "{}" > "$(pwd)/.cache/index.json"
+echo "[]" > "$(pwd)/.cache/index.json"
 
 echo 'dist/*
 node_modules/
@@ -23,6 +23,9 @@ echo '{
   "url_base": "http://localhost:8000",
   "src_dir": "src",
   "dist_dir": "dist",
-  "distribute_raw": "image"
+  "distribute_raw": "image",
+  "helper": "helper/index.js"
 }' > "$(pwd)/blog.json"
 echo "create blog.json"
+
+cp -R "$(pwd)/node_modules/@tenjuu99/blog/src-sample/" "$(pwd)/src"

package/lib/filter.js

@@ -1,8 +1,7 @@
-import * as helper from '../helper/index.js'
+import helper from '../lib/helper.js'
 import includeFilter from './includeFilter.js'
 import { srcDir } from './dir.js'
 import config from './config.js'
-console.log(config)
 
 /**
  * @param {string} text
@@ -10,19 +9,23 @@ console.log(config)
  * @return {text}
  */
 const replaceVariablesFilter = (text, variables) => {
-  const matched = [...text.matchAll(/{{\s?([\w\d-_\(\)]+)\s?}}/g)]
-  const replace = Object.fromEntries(matched.map(match => [match[1].toLowerCase(), match[0]]))
+  const matched = [...text.matchAll(/(\\)?{{\s?([\w\d\s,-_\(\)]+)\s?}}/g)]
+  const replace = Object.fromEntries(matched.map(match => [match[2].toLowerCase(), {replace: match[0], backslash: match[1]}]))
   let replaced = text
   for (const elm in replace) {
-    const toBeReplace = replace[elm]
-    const toBeReplaceScript = toBeReplace.match(/([\w\d_-]+)\((.+)\)/)
-    if (toBeReplaceScript) {
+    const toBeReplace = replace[elm].replace
+    const toBeReplaceScript = toBeReplace.match(/([\w\d_]+)\((.*)\)/)
+   
+    if (replace[elm].backslash) { // escape variable syntax
+      const removeBackslash = replace[elm].replace.replace(/\\/, '')
+      replaced = replaced.replaceAll(toBeReplace, removeBackslash)
+    } else if (toBeReplaceScript) { // execute helper
       const func = toBeReplaceScript[1]
-      const variable = toBeReplaceScript[2]
+      const args = toBeReplaceScript[2].split(',').map(v => variables[v.trim()] ?? undefined)
       if (!helper[func]) {
-        throw new Exception('helper function is missing. function name: ' + func);
+        throw new Error('helper function is missing. function name: ' + func);
       }
-      const replaceText = helper[func](variables[variable.toLowerCase()])
+      const replaceText = helper[func].call(null, ...args)
       replaced = replaced.replaceAll(toBeReplace, replaceText)
     } else {
       replaced = replaced.replaceAll(toBeReplace, variables[elm])
@@ -129,13 +132,7 @@ const replaceScriptFilter = async (text, variables) => {
     }
   })
   for (const script of scripts) {
-    let helperMerged = {...helper}
-    // env.HELPER が定義されていれば追加ヘルパーとして扱う
-    if (config.helper) {
-      const additional = await import(`${srcDir}/${config.helper}`)
-      helperMerged = Object.assign(helperMerged, additional)
-    }
-    let result = new Function('helper', 'variables', script.script)(helperMerged, variables)
+    let result = new Function('helper', 'variables', script.script)(helper, variables)
     if (result instanceof Promise) {
       result = await result
     }

package/lib/helper.js

@@ -0,0 +1,12 @@
+import * as helperDefault from '../helper/index.js'
+import config from './config.js'
+import { srcDir } from './dir.js'
+
+let helper = {...helperDefault}
+
+if (config['helper']) {
+  const helperAdditional = await import(`${srcDir}/${config.helper}`)
+  helper = Object.assign(helper, helperAdditional)
+}
+
+export default helper

package/lib/render.js

@@ -16,6 +16,7 @@ const render = async (templateName, data) => {
   markdown = await includeFilter(markdown)
   markdown = await replaceIfFilter(markdown, data)
   markdown = await replaceScriptFilter(markdown, data)
+  markdown = replaceVariablesFilter(markdown, data)
   data.markdown = data.__filetype === 'md' ? marked.parse(markdown) : markdown
 
   return replaceVariablesFilter(template, data)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tenjuu99/blog",
-  "version": "0.1.4",
+  "version": "0.1.7",
   "description": "blog template",
   "main": "index.js",
   "scripts": {
@@ -11,7 +11,7 @@
   "bin": {
     "generate": "bin/generate",
     "server": "bin/server",
-    "new": "bin/new"
+    "create-blog": "bin/new"
   },
   "author": "AmashigeSeiji",
   "repository": {
@@ -26,5 +26,14 @@
   "type": "module",
   "engines": {
     "node": ">=21.7"
+  },
+  "files": [
+    "lib",
+    "bin",
+    "helper",
+    "src-sample"
+  ],
+  "publishConfig": {
+    "access": "public"
   }
 }

package/src-sample/pages/sample.md

@@ -113,7 +113,7 @@ return variables.someVariable
 {/script}
 ```
 
-## 追加ヘルパー
+## ヘルパー
 
 ヘルパー関数を作成します。
 ```
@@ -132,14 +132,10 @@ HELPER=helper/index.js
 追加したヘルパーを利用できます。
 <pre>
 // src-sample/pages/sample.md
-&lt;script type="ssg">
-return helper.additionalHelper()
-&lt;/script>
+\{{ additionalHelper() }}
 </pre>
 
 実際に出力させると次の行のとおりです。
 ```
-<script type="ssg">
-return helper.additionalHelper()
-</script>
+{{additionalHelper()}}
 ```

package/.env.prod.sample

@@ -1,8 +0,0 @@
-SITE_NAME=test_blog
-GTAG_ID=
-URL_BASE=https://amashigeseiji.github.io/blog_template
-RELATIVE_PATH=/tenjuu99-blog
-SRC_DIR=src-sample
-DIST_DIR=dist
-DISTRIBUTE_RAW=image
-HELPER=helper/index.js

package/.env.sample

@@ -1,8 +0,0 @@
-SITE_NAME=test_blog
-GTAG_ID=
-URL_BASE=http://localhost:8000
-RELATIVE_PATH=
-SRC_DIR=src-sample
-DIST_DIR=dist
-DISTRIBUTE_RAW=image
-HELPER=helper/index.js

package/.github/workflows/deploy.yml.sample

@@ -1,51 +0,0 @@
-name: Build html and deploy to S3
-on:
-  push:
-      branches:
-        - main
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@master
-
-      - name: npm install
-        run: npm install --production
-
-      - name: Build
-        run: npm run generate:prod
-
-      - name: Deploy
-        env:
-          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-        run: |
-          aws s3 sync \
-          --region ap-northeast-1 \
-          --exact-timestamps \
-          --exclude .gitignore \
-          --exclude '*.css' \
-          --exclude 'image/' \
-          --delete \
-          --metadata-directive REPLACE \
-          --cache-control "max-age=86400, no-cache, public" \
-          dist/ s3://${{ secrets.S3_URL }}/
-
-          aws s3 sync \
-          --region ap-northeast-1 \
-          --exact-timestamps \
-          --exclude .gitignore \
-          --delete \
-          --metadata-directive REPLACE \
-          --cache-control "max-age=31536000, public" \
-          dist/css/ s3://${{ secrets.S3_URL }}/css/
-
-          aws s3 sync \
-          --region ap-northeast-1 \
-          --exact-timestamps \
-          --exclude .gitignore \
-          --delete \
-          --metadata-directive REPLACE \
-          --cache-control "max-age=86400, public" \
-          dist/image/ s3://${{ secrets.S3_URL }}/image/

package/.github/workflows/github-page.yml

@@ -1,52 +0,0 @@
-# Simple workflow for deploying static content to GitHub Pages
-name: Deploy static content to Pages
-
-on:
-  push:
-      branches:
-        - main
-  workflow_dispatch:
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
-jobs:
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@master
-
-      - name: Use nodejs
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22.x'
-
-      - name: npm install
-        run: npm install --omit=dev
-
-      - name: Build
-        run: cp blog.json.prod blog.json && npm run generate
-
-      - name: Setup Pages
-        uses: actions/configure-pages@v4
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          # Upload dist
-          path: './dist/'
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4

package/.gitignore

@@ -1,9 +0,0 @@
-node_modules/
-dist/*
-!.gitignore
-!favicon.ico
-data/index.json
-.DS_Store
-
-.env
-.cache/

package/.node-version

@@ -1 +0,0 @@
-22.7.0

package/blog.json

@@ -1,8 +0,0 @@
-{
-  "site_name": "test",
-  "url_base": "http://localhost:8000",
-  "src_dir": "src-sample",
-  "dist_dir": "dist",
-  "distribute_raw": "image",
-  "helper": "helper/index.js"
-}

package/blog.json.prod

@@ -1,9 +0,0 @@
-{
-  "site_name": "blog/sample",
-  "url_base": "https://amashigeseiji.github.io/tenjuu99-blog",
-  "relative_path": "/tenjuu99-blog",
-  "src_dir": "src-sample",
-  "dist_dir": "dist",
-  "distribute_raw": "image",
-  "helper": "helper/index.js"
-}

package/helper/add.js

@@ -1,3 +0,0 @@
-export function hogehoge() {
-  return 'hogehoge'
-}

package/lib/replaceIfFilter.js

@@ -1,67 +0,0 @@
-/**
- * @param {string} condition
- * @params {object} variables
- * @return {bool}
- */
-const ifConditionEvaluator = (condition, variables) => {
-  if (condition.includes('=')) {
-    const segmented = condition.match(/(?<left>[\S]+)\s(?<operator>!=|==)\s(?<right>[\S]+)/)
-    let {left, operator, right} = segmented.groups
-    if (variables.hasOwnProperty(left)) {
-      left = variables[left]
-    } else {
-      try {
-        left = eval(left)
-      } catch (e) {
-        left = undefined
-      }
-    }
-    if (variables.hasOwnProperty(right)) {
-      right = variables[right]
-    } else {
-      try {
-        right = eval(right)
-      } catch (e) {
-        right = undefined
-      }
-    }
-    switch (operator) {
-      case '==':
-        return left == right
-      case '!=':
-        return left != right
-    }
-  } else {
-    if (variables.hasOwnProperty(condition)) {
-      return !!variables[condition]
-    }
-    return false
-  }
-}
-
-const ifRegexp =
-  new RegExp(/(\{|<)if\s(?<condition>[\s\S]+?)(}|>)(?<content>[\s\S]*?)((\{|<)else(\}|>)(?<elsecontent>[\s\S]*?))?(\{<)\/if(>|})/g)
-
-/**
- * @param {string} text
- * @param {object} variables
- * @returns {string}
- */
-const replaceIfFilter = (text, variables) => {
-  const matched = [...text.matchAll(ifRegexp)]
-  for (const item of matched) {
-    const target = item[0]
-    const content = item.groups.content
-    const elseContent = item.groups.elsecontent
-    if (ifConditionEvaluator(item.groups.condition, variables)) {
-      text = text.replace(target, content)
-    } else if (elseContent) {
-      text = text.replace(target, elseContent)
-    } else {
-      text = text.replace(target, '')
-    }
-  }
-  return text
-}
-
-export default replaceIfFilter

package/lib/replaceScriptFilter.js

@@ -1,71 +0,0 @@
-import * as helper from '../helper/index.js'
-import vm from 'vm'
-
-/**
- * 配列を再帰的に順不同リストに変換する
- * @param {Array|string} arrayOrText
- * @returns {mixed}
- */
-const arrayToList = (arrayOrText) => {
-  if (typeof arrayOrText === 'string') {
-    return `<li>${arrayOrText}</li>`
-  }
-  if (Array.isArray(arrayOrText)) {
-    let resultListText = '<ul>'
-    for (const item of arrayOrText) {
-      if (Array.isArray(item)) {
-        resultListText += `<li>${arrayToList(item)}</li>`
-      } else {
-        resultListText += `<li>${item}</li>`
-      }
-    }
-    resultListText += '</ul>'
-    arrayOrText = resultListText
-  }
-  return arrayOrText
-}
-
-const replaceScriptFilter = async (text, variables) => {
-  let replaced = text
-  const scriptRegexp = new RegExp(/({script}|\<script\s.*type="ssg".*>)(?<script>[\s\S]*?)(\{\/script}|\<\/script>)/g)
-  const scripts = [...text.matchAll(scriptRegexp)].map((matched) => {
-    return {
-      replace: matched[0],
-      script: matched.groups.script.trim("\n"),
-    }
-  })
-  const context = vm.createContext({
-    helper,
-    variables,
-  })
-  for (const script of scripts) {
-    const s = new vm.Script(script.script)
-    console.log(script.script)
-    console.log(s)
-    console.log('------------------------------------------------')
-    const func = vm.runInContext(script, context)
-    console.log(func)
-    let result = await func(variables, helper)
-    if (result instanceof Promise) {
-      result = await result
-    }
-    if (Array.isArray(result)) {
-      result = arrayToList(result)
-    } else if (typeof result === 'object') {
-      const resultText = []
-      for (const key in result) {
-        resultText.push(`<h3>${key}</h3>`)
-        if (Array.isArray(result[key])) {
-          resultText.push(arrayToList(result[key]))
-        } else {
-          resultText.push(`<p>${result[key]}</p>`)
-        }
-      }
-      result = resultText.join('\n')
-    }
-    replaced = replaced.replace(script.replace, result)
-  }
-  return replaced
-}
-
-export default replaceScriptFilter

package/performance.js

@@ -1,22 +0,0 @@
-"use strict"
-import distribute from './lib/distribute.js'
-import { indexing, allData, deleted } from './lib/indexer.js'
-import { srcDir, distDir } from './lib/dir.js'
-
-process.env.FORCE_BUILD = true
-const doBuild = async () => {
-  const start = performance.now()
-  await indexing()
-  await distribute(allData, deleted, srcDir, distDir)
-  const end = performance.now()
-  return end - start
-}
-const times = 100
-let executed = 0
-for (let i = 0; i < times; i++) {
-  // console.log(await executed())
-  const buildTime = await doBuild()
-  executed += (buildTime)
-  console.log(buildTime)
-}
-console.log('build average: 100 times: ' + (executed/times) + "ms")

package/src-sample/pages/abc.md

@@ -1,11 +0,0 @@
----
-title: abc
-url: /abc
-published: 2024-08-31
----
-hoge
-hoge
-
-
-abc
-dc

package/src-sample/pages/fuga.md

@@ -1,3 +0,0 @@
-## fuga
-
-これは変数がないです

package/src-sample/pages/hogehoge.md

@@ -1,8 +0,0 @@
----
-title: hoge
-url: /hoge
-published: 2024/03/19 00:00
-ifTrueVariable: true
----
-
-hoge

package/src-sample/pages/post/2.md

@@ -1 +0,0 @@
-これは [post](/post) 配下にあります