WordをGit管理して GitHub + TextLint で迫りくる卒業論文を快適にする

# MacにてHomebrewを利用している場合以下でインストールできる。
$ brew install pandoc

$ pandoc test.docx -f docx -t gfm -o test.md

# -f : 変換元ファイルのファイル形式
# -t : 変換先ファイルのファイル形式（gfmはGitHubにて利用されているマークダウンの形式）
# -o : 変換後の保存ファイル名

# MS Wordで書いた文章をPandocでマークダウンに変換する

Wordで書いた文章をPandocというライブラリを利用してマークダウン形式のファイルに変換します。この文章はブログのサンプルとして書いています。詳しくは[この記事](https://blog.ue-y.me/word-git-textlint/)を読んでください。

## はじめに

こんにちは。論文執筆中の上ちょです。

$ pandoc test.docx -f docx -t gfm -o test.md --wrap=none --reference-links

# --wrap : 折返しの設定（規定は72文字で折り返しするがNoneで無効化）
# --reference-links : リンクを最下部にまとめる

# MS Wordで書いた文章をPandocでマークダウンに変換する

Wordで書いた文章をPandocというライブラリを利用してマークダウン形式のファイルに変換します。この文章はブログのサンプルとして書いています。詳しくは[この記事][]を読んでください。

## はじめに

こんにちは。論文執筆中の上ちょです。

  [この記事]: https://blog.ue-y.me/word-git-textlint/

#!/bin/bash

# define variable
date=`date '+%Y%m%d'`

from_filename="test.docx"
from_exe="docx"
to_filename="test.md"
to_exe="gfm"

options="--wrap=none --reference-links"
current_branch=`git rev-parse --abbrev-ref HEAD`


# command
pandoc -s ${from_filename} -f ${from_exe} -t ${to_exe} ${options} -o ${to_filename}


gitfunc() {
  git add -A
  git commit -m "Auto commit by docx2md"
  git push --set-upstream origin ${currentbranch}
}

if [[ $# -gt 0 ]]; then
  echo "catch commandline args"
  if [[ $1 == "push" ]]; then
    echo "git add / commit / push"
    gitfunc
  fi
fi

# permission denied: ./docx2md.sh と言われた場合は以下を実行
chmod 700 ./docx2md.sh

# 以下のコマンドでGitコミット・プッシュができる
./docx2md.sh push

# 上記のライブラリをインストールする
$ npm install -D textlint textlint-rule-ja-hiragana-fukushi textlint-rule-ja-hiragana-hojodoushi textlint-rule-ja-hiragana-keishikimeishi textlint-rule-ja-no-weak-phrase textlint-rule-ja-unnatural-alphabet textlint-rule-no-double-negative-ja textlint-rule-no-dropping-the-ra textlint-rule-no-mix-dearu-desumasu textlint-rule-no-mixed-zenkaku-and-hankaku-alphabet textlint-rule-prefer-tari-tari @textlint-ja/textlint-rule-no-synonyms

word-textlint-sample
├── .gitignore
├── .textlintrc  # 追加
├── docx2md.sh
├── package-lock.json
├── package.json
├── test.docx
└── test.md

{
  "rules": {
    "@textlint-ja/no-synonyms": true,
    "ja-hiragana-fukushi": true,
    "ja-hiragana-hojodoushi": true,
    "ja-hiragana-keishikimeishi": true,
    "ja-no-weak-phrase": true,
    "ja-unnatural-alphabet": true,
    "no-double-negative-ja": true,
    "no-dropping-the-ra": true,
    "no-mix-dearu-desumasu": true,
    "no-mixed-zenkaku-and-hankaku-alphabet": {
      "prefer": "半角"
    },
    "prefer-tari-tari": true
  }
}

$ npx textlint *.md

word-textlint-sample
├── .gitignore
├── .textlintrc
├── docx2md.sh
├── package-lock.json
├── package.json
├── test.docx
├── test.md
└── .github  # 追加
    └── workflows  # 追加
        └── lint.yml  # 追加

name: Textlint workflow

on:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  textlint:
    name: textlint
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v2
        with:
          node-version: '16'
          cache: 'npm'
      - name: npm install
        run: npm ci
      - name: test
        run: npx textlint *.md