Rewrite html plugin

.github/workflows/test.yml

@@ -6,15 +6,31 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [12, 14]
+        node-version: [16,18]
     steps:
       - name: checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
       - name: Install
-        run: npm install
+        run: yarn install
       - name: Test
-        run: npm test
+        run: yarn test
+  example:
+    name: "Run Example"
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+      - name: setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Install
+        run: yarn install
+        working-directory: ./example
+      - name: Test
+        run: yarn test
+        working-directory: ./example

.gitignore

@@ -1,4 +1,5 @@
 /lib
+/module
 ### https://raw.github.com/github/gitignore/608690d6b9a78c2a003affc792e49a84905b3118/Node.gitignore
 
 # Logs

.mocharc.json

@@ -1,6 +1,8 @@
 {
-  "timeout": "5000",
-  "require": [
-    "@babel/register"
-  ]
+  "$schema": "https://json.schemastore.org/mocharc",
+  "loader": "ts-node/esm",
+  "spec": [
+    "test/**/*.{js,ts}"
+  ],
+  "timeout": 10000
 }

README.md

@@ -2,13 +2,16 @@
 
 Add HTML support for [textlint](https://github.com/textlint/textlint "textlint").
 
-What is textlint plugin? Please see https://github.com/textlint/textlint/blob/master/docs/plugin.md
-
+What is textlint plugin? Please see <https://github.com/textlint/textlint/blob/master/docs/plugin.md>
 
 ## Installation
 
     npm install textlint-plugin-html
 
+Requirements:
+
+- textlint v13+
+
 ## Default supported extensions
 
 - `.html`
@@ -52,6 +55,16 @@ For example, if you want to treat `.custom-ext` as html, put following config to
 
     npm test
 
+## Development
+
+If you update snapshot, please run `npm run updateSnapshot`.
+
+### Add new test case
+
+1. add new fixture file to `test/ast-test-case/<test-case-name>/index.html`
+2. npm run updateSnapshot
+3. check outputs
+
 ## Contributing
 
 1. Fork it!

example/.textlintrc.json

@@ -0,0 +1,11 @@
+{
+  "plugins": [
+    "html"
+  ],
+  "filters": {},
+  "rules": {
+    "preset-ja-technical-writing": {
+      "ja-no-mixed-period": false
+    }
+  }
+}

example/package.json

@@ -0,0 +1,20 @@
+{
+  "private": true,
+  "name": "example",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "textlint test/ -f pretty-error || exit 0"
+  },
+  "workspaces": [
+    "../"
+  ],
+  "author": "azu",
+  "license": "MIT",
+  "devDependencies": {
+    "textlint": "^13.0.5",
+    "textlint-rule-preset-ja-technical-writing": "^7.0.0",
+    "textlint-plugin-html": "^0.3.0"
+  }
+}