@peaceroad/markdown-imgattr-to-pcaption 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 k_taka
+
+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

@@ -0,0 +1,107 @@
+# markdown-imgattr-to-pcaption
+
+Change img alt attribute to figure caption paragraph for p7d-markdown-it-p-captions.
+
+```
+import setMarkdownImgAttrToPCaption from '@peaceroad/markdown-imgattr-to-pcaption'
+
+setMarkdownImgAttrToPCaption(markdownCont)
+```
+
+```
+[Input]
+段落。段落。段落。
+
+![キャプション](image.jpg)
+
+段落。段落。段落。
+
+
+[Output]
+段落。段落。段落。
+
+図　キャプション
+
+![](image.jpg)
+
+段落。段落。段落。
+
+
+[Input]
+段落。段落。段落。
+
+![図 キャプション](image.jpg)
+
+段落。段落。段落。
+
+[Output]
+段落。段落。段落。
+
+図 キャプション
+
+![](image.jpg)
+
+段落。段落。段落。
+
+
+
+[Input]
+段落。段落。段落。
+
+![図1 キャプション](image.jpg)
+
+段落。段落。段落。
+
+[Output]
+段落。段落。段落。
+
+図1 キャプション
+
+![](image.jpg)
+
+段落。段落。段落。
+```
+
+## Option
+
+### imgTitleCaption: true
+
+```
+[Input]
+段落。段落。段落。
+
+![ALT](image.jpg "キャプション")
+
+段落。段落。段落。
+
+
+[Output]
+段落。段落。段落。
+
+図　キャプション
+
+![ALT](image.jpg)
+
+段落。段落。段落。
+```
+
+### labelLang: 'en'
+
+```
+[Input]
+段落。段落。段落。
+
+![キャプション](image.jpg)
+
+段落。段落。段落。
+
+
+[Output]
+段落。段落。段落。
+
+Figure. キャプション
+
+![](image.jpg)
+
+段落。段落。段落。
+```

package/index.js

@@ -0,0 +1,194 @@
+const setMarkdownImgAttrToPCaption = (markdown, option) => {
+
+  const opt = {
+    imgAltCaption : true,
+    imgTitleCaption: false,
+    labelLang: 'ja',
+    }
+    if (option !== undefined) {
+      if (option.imgTitleCaption) {
+        opt.imgTitleCaption = option.imgTitleCaption
+      }
+      if (option.labelLang) {
+        opt.labelLang = option.labelLang
+      }
+    }
+    if (opt.imgTitleCaption) opt.imgAltCaption = false
+
+    let n = 0
+    let lines = markdown.split(/\r\n|\n/)
+    let lineBreaks = markdown.match(/\r\n|\n/g);
+    let isBackquoteCodeBlock = false
+    let isTildeCodeBlock = false
+    const br = lineBreaks ? lineBreaks[0] : ''
+  
+    if(lines.length === 0) return markdown
+  
+    while (n < lines.length) {
+      let isPrevBreakLine = false
+      let isNextBreakLine = false
+      if (lines[n].match(/^[ \t]*```/)) {
+        if (isBackquoteCodeBlock) {
+          isBackquoteCodeBlock = false
+        } else {
+          isBackquoteCodeBlock = true
+        }
+      }
+      if (lines[n].match(/^[ \t]*~~~/)) {
+        if (isTildeCodeBlock) {
+          isTildeCodeBlock = false
+        } else {
+          isTildeCodeBlock = true
+        }
+      }
+      if (isBackquoteCodeBlock || isTildeCodeBlock) {
+        n++
+        continue
+      }
+  
+      if (n === 0) {
+        isPrevBreakLine = true
+      } else {
+        isPrevBreakLine = /^[ \t]*$/.test(lines[n-1])
+      }
+      if (n === lines.length -1) {
+        isNextBreakLine = true
+      } else {
+        isNextBreakLine = /^[ \t]*$/.test(lines[n+1])
+      }
+      if (isPrevBreakLine && isNextBreakLine) {
+        lines[n] = modLines(n ,lines, br, opt)
+      }
+      n++
+    }
+  
+    n = 0
+    markdown = ''
+    while (n < lines.length) {
+      if (n === lines.length - 1) {
+        markdown += lines[n]
+        break
+      }
+      markdown += lines[n] + lineBreaks[n]
+      n++
+    }
+    return markdown
+  }
+  
+  const modLines = (n, lines, br, opt) => {
+  
+    const markAfterNum = '[A-Z0-9]{1,6}(?:[.-][A-Z0-9]{1,6}){0,5}';
+    const joint = '[.:．。：　]';
+    const jointFullWidth = '[．。：　]';
+    const jointHalfWidth = '[.:]';
+  
+    const markAfterEn = '(?:' +
+      ' *(?:' +
+        jointHalfWidth + '(?:(?=[ ]+)|$)|' +
+        jointFullWidth + '|' +
+        '(?=[ ]+[^0-9a-zA-Z])' +
+      ')|' +
+      ' *' + '(' + markAfterNum + ')(?:' +
+        jointHalfWidth + '(?:(?=[ ]+)|$)|' +
+        jointFullWidth + '|' +
+        '(?=[ ]+[^a-z])|$' +
+      ')|' +
+      '[.](' + markAfterNum + ')(?:' +
+        joint + '|(?=[ ]+[^a-z])|$' +
+      ')' +
+    ')';
+    const markAfterJa = '(?:' +
+    ' *(?:' +
+      jointHalfWidth + '(?:(?=[ ]+)|$)|' +
+      jointFullWidth + '|' +
+      '(?=[ ]+)' +
+    ')|' +
+    ' *' + '(' + markAfterNum + ')(?:' +
+      jointHalfWidth + '(?:(?=[ ]+)|$)|' +
+      jointFullWidth + '|' +
+      '(?=[ ]+)|$' +
+    ')' +
+  ')';
+  
+    const labelEn = '(?:[fF][iI][gG](?:[uU][rR][eE])?|[iI][lL]{2}[uU][sS][tT]|[pP][hH][oO][tT][oO])';
+    const labelJa = '(?:図|イラスト|写真)';
+  
+    const markReg = {
+      //fig(ure)?, illust, photo
+      "img": new RegExp('^(?:' + labelEn + markAfterEn + '|' + labelJa + markAfterJa +
+      ')'),
+    }
+    const markRegWithNoJoint = {
+      "img": new RegExp('^(' + labelEn + '|' + labelJa + ')([ .]?' + markAfterNum + ')?$'),
+    }
+  
+    let reg = /^([ \t]*?)!\[ *?(.*?) *?\]\(([^ ]*?)( +"(.*?)")?\)( *(?:{.*?})?)$/
+  
+    const imgLine = lines[n].match(reg)
+    if (!imgLine) return lines[n]
+    //console.log(imgLine)
+  
+    let hasLabel
+    if (opt.imgAltCaption) hasLabel = imgLine[2].match(new RegExp(markReg.img))
+    if (opt.imgTitleCaption) hasLabel = imgLine[5].match(new RegExp(markReg.img))
+    let hasLabelWithNoJoint
+    if (opt.imgAltCaption) hasLabelWithNoJoint = imgLine[2].match(new RegExp(markRegWithNoJoint.img))
+    if (opt.imgTitleCaption) hasLabelWithNoJoint = imgLine[5].match(new RegExp(markRegWithNoJoint.img))
+
+    lines[n] = imgLine[1]
+    if (hasLabel) {
+      //console.log('With label::')
+      if (opt.imgAltCaption) {
+        lines[n] += imgLine[2]
+      } else if (opt.imgTitleCaption) {
+        lines[n] += imgLine[5]
+      }
+      lines[n] += br + br +  imgLine[1] + '!['
+      if (opt.imgTitleCaption) lines[n] += imgLine[2]
+      lines[n] += ']'
+    } else if (hasLabelWithNoJoint) {
+      //console.log('With label (no joint)::')
+      //console.log(hasLabelWithNoJoint)
+      if (opt.imgAltCaption) {
+        lines[n] += imgLine[2]
+      } else if (opt.imgTitleCaption) {
+        lines[n] += imgLine[5]
+      }
+      lines[n] += br + br +  imgLine[1] + '![' + hasLabelWithNoJoint[0].replace(new RegExp(joint + '$')) + ']'
+    } else {
+      //console.log('No label::')
+      if (opt.labelLang === 'ja') {
+        if (opt.imgAltCaption) {
+          if (imgLine[2]) {
+            lines[n] += '図　' + imgLine[2] + br + br + imgLine[1] + '![]'
+          } else {
+            lines[n] += '図' + br + br + imgLine[1] + '![]'
+          }
+        } else if (opt.imgTitleCaption) {
+          if (imgLine[5]) {
+            lines[n] += '図　' + imgLine[5] + br + br + imgLine[1] + '![' + imgLine[2] + ']'
+          } else {
+            lines[n] += '図' + br + br + imgLine[1] + '![' + imgLine[2] + ']'
+          }
+        }
+      } else if (opt.labelLang === 'en') {
+        if (opt.imgAltCaption) {
+          if (imgLine[2]) {
+            lines[n] += 'Figure. ' + imgLine[2] + br + br + imgLine[1] +'![]'
+          } else {
+            lines[n] += 'Figure.' + br + br + imgLine[1] +'![]'
+          }
+        } else if (opt.imgTitleCaption) {
+          if (imgLine[5]) {
+            lines[n] += 'Figure. ' + imgLine[5] + br + br + imgLine[1] + '![' + imgLine[2] + ']'
+          } else {
+            lines[n] += 'Figure. ' + br + br + imgLine[1] + '![' + imgLine[2] + ']'
+          }
+        }
+      }
+    }
+    lines[n] += '(' + imgLine[3] + ')' + imgLine[6]
+    return lines[n]
+  }
+
+  export default setMarkdownImgAttrToPCaption

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@peaceroad/markdown-imgattr-to-pcaption",
+  "version": "0.1.0",
+  "description": "Change img alt attribute to figure caption paragraph for p7d-markdown-it-p-captions.",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "node test/test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/peaceroad/markdown-imgattr-to-pcaption.git"
+  },
+  "author": "peaceroad <peaceroad@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/peaceroad/markdown-imgattr-to-pcaption/issues"
+  },
+  "homepage": "https://github.com/peaceroad/markdown-imgattr-to-pcaption#readme"
+}

package/test/examples-img-title-attr.txt

@@ -0,0 +1,87 @@
+[Input]
+段落。段落。段落。
+
+![ALT](image.jpg "キャプション")
+
+段落。段落。段落。
+
+
+[Output]
+段落。段落。段落。
+
+図　キャプション
+
+![ALT](image.jpg)
+
+段落。段落。段落。
+
+
+[Input]
+段落。段落。段落。
+
+![ALT](image.jpg "図 キャプション")
+
+段落。段落。段落。
+
+[Output]
+段落。段落。段落。
+
+図 キャプション
+
+![ALT](image.jpg)
+
+段落。段落。段落。
+
+
+
+[Input]
+段落。段落。段落。
+
+![ALT](image.jpg "図1 キャプション")
+
+段落。段落。段落。
+
+[Output]
+段落。段落。段落。
+
+図1 キャプション
+
+![ALT](image.jpg)
+
+段落。段落。段落。
+
+
+
+[Input]
+段落。段落。段落。
+
+![ALT](image.jpg "図1　キャプション")
+
+段落。段落。段落。
+
+[Output]
+段落。段落。段落。
+
+図1　キャプション
+
+![ALT](image.jpg)
+
+段落。段落。段落。
+
+
+
+[Input]
+段落。段落。段落。
+
+![ALT](image.jpg "図1：キャプション")
+
+段落。段落。段落。
+
+[Output]
+段落。段落。段落。
+
+図1：キャプション
+
+![ALT](image.jpg)
+
+段落。段落。段落。

package/test/examples-label-lang.txt

@@ -0,0 +1,16 @@
+[Input]
+段落。段落。段落。
+
+![キャプション](image.jpg)
+
+段落。段落。段落。
+
+
+[Output]
+段落。段落。段落。
+
+Figure. キャプション
+
+![](image.jpg)
+
+段落。段落。段落。

package/test/examples.txt

@@ -0,0 +1,88 @@
+[Input]
+段落。段落。段落。
+
+![キャプション](image.jpg)
+
+段落。段落。段落。
+
+
+[Output]
+段落。段落。段落。
+
+図　キャプション
+
+![](image.jpg)
+
+段落。段落。段落。
+
+
+[Input]
+段落。段落。段落。
+
+![図 キャプション](image.jpg)
+
+段落。段落。段落。
+
+[Output]
+段落。段落。段落。
+
+図 キャプション
+
+![](image.jpg)
+
+段落。段落。段落。
+
+
+
+[Input]
+段落。段落。段落。
+
+![図1 キャプション](image.jpg)
+
+段落。段落。段落。
+
+[Output]
+段落。段落。段落。
+
+図1 キャプション
+
+![](image.jpg)
+
+段落。段落。段落。
+
+
+
+[Input]
+段落。段落。段落。
+
+![図1　キャプション](image.jpg)
+
+段落。段落。段落。
+
+[Output]
+段落。段落。段落。
+
+図1　キャプション
+
+![](image.jpg)
+
+段落。段落。段落。
+
+
+[Input]
+段落。段落。段落。
+
+![図1：キャプション](image.jpg)
+
+段落。段落。段落。
+
+[Output]
+段落。段落。段落。
+
+図1：キャプション
+
+![](image.jpg)
+
+段落。段落。段落。
+
+

package/test/test.js

@@ -0,0 +1,77 @@
+import assert from 'assert'
+import fs from 'fs'
+import path from 'path'
+import setMarkdownImgAttrToPCaption from '../index.js'
+
+let __dirname = path.dirname(new URL(import.meta.url).pathname)
+const isWindows = (process.platform === 'win32')
+if (isWindows) {
+  __dirname = __dirname.replace(/^\/+/, '').replace(/\//g, '\\')
+}
+
+const check = (name, ex) => {
+  const exCont = fs.readFileSync(ex, 'utf-8').trim()
+  let ms = [];
+  let ms0 = exCont.split(/\n*\[Input\]\n/)
+  let n = 1;
+  while(n < ms0.length) {
+    let mhs = ms0[n].split(/\n+\[Output[^\]]*?\]\n/)
+    let i = 1
+    while (i < 2) {
+      if (mhs[i] === undefined) {
+        mhs[i] = ''
+      } else {
+        mhs[i] = mhs[i].replace(/$/,'\n')
+      }
+      i++
+    }
+    ms[n] = {
+      inputMarkdown: mhs[0].trim(),
+      outputMarkdown: mhs[1].trim(),
+    };
+    n++
+  }
+
+  n = 1
+  while(n < ms.length) {
+    //if (n !== 10) { n++; continue }
+    console.log('Test: ' + n + ' >>>')
+    const m = ms[n].inputMarkdown
+    let h
+    let option = {}
+    if (name === 'default') {
+        h = setMarkdownImgAttrToPCaption(m)
+      }
+  
+
+      if (name === 'imgTitleAttr') {
+        h = setMarkdownImgAttrToPCaption(m, {imgTitleCaption: true})
+      }
+
+      if (name === 'labelLang') {
+        h = setMarkdownImgAttrToPCaption(m, {labelLang: 'en'})
+      }
+
+
+        try {
+      assert.strictEqual(h, ms[n].outputMarkdown)
+    } catch(e) {
+      console.log('incorrect: ')
+      //console.log(m)
+      //console.log('::convert ->')
+      console.log('H: ' + h +'\n\nC: ' + ms[n].outputMarkdown)
+    }
+    n++
+  }
+}
+
+
+const example = {
+    default: __dirname + path.sep + 'examples.txt',
+    imgTitleAttr: __dirname + path.sep + 'examples-img-title-attr.txt',
+    labelLang: __dirname + path.sep + 'examples-label-lang.txt',
+}
+for (let ex in example) {
+  console.log('[Test] ' + ex)
+  check(ex, example[ex])
+}