refactor: Move to TS and update sentence-splitter/to-string (#10)

* refactor: Move to TS and update sentence-splitter/to-string

* Update package.json

* CI: add .github/release.yml

* chore: remove peerDeps

* fix: move to devDeps

Author: azu

.github/release.yml

@@ -0,0 +1,30 @@
+changelog:
+  exclude:
+    labels:
+      - 'Type: Meta'
+      - 'Type: Question'
+      - 'Type: Release'
+
+  categories:
+    - title: Security Fixes
+      labels: ['Type: Security']
+    - title: Breaking Changes
+      labels: ['Type: Breaking Change']
+    - title: Features
+      labels: ['Type: Feature']
+    - title: Bug Fixes
+      labels: ['Type: Bug']
+    - title: Documentation
+      labels: ['Type: Documentation']
+    - title: Refactoring
+      labels: ['Type: Refactoring']
+    - title: Testing
+      labels: ['Type: Testing']
+    - title: Maintenance
+      labels: ['Type: Maintenance']
+    - title: CI
+      labels: ['Type: CI']
+    - title: Dependency Updates
+      labels: ['Type: Dependencies', "dependencies"]
+    - title: Other Changes
+      labels: ['*']

README.md

@@ -1,4 +1,4 @@
-# textlint-rule-en-max-word-count [![Actions Status: test](https://github.com/azu/textlint-rule-en-max-word-count/workflows/test/badge.svg)](https://github.com/azu/textlint-rule-en-max-word-count/actions?query=workflow%3A"test")
+# textlint-rule-en-max-word-count [![Actions Status: test](https://github.com/textlint-rule/textlint-rule-en-max-word-count/workflows/test/badge.svg)](https://github.com/textlint-rule/textlint-rule-en-max-word-count/actions?query=workflow%3A"test")
 
 [textlint](https://github.com/textlint/textlint "textlint") rule that specify the maximum word count of a sentence.
 

package.json

@@ -2,18 +2,18 @@
   "name": "textlint-rule-en-max-word-count",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/azu/textlint-rule-en-max-word-count.git"
+    "url": "git+https://github.com/textlint-rule/textlint-rule-en-max-word-count.git"
   },
   "author": "azu",
   "email": "[email protected]",
-  "homepage": "https://github.com/azu/textlint-rule-en-max-word-count",
+  "homepage": "https://github.com/textlint-rule/textlint-rule-en-max-word-count",
   "license": "MIT",
   "files": [
     "src/",
     "lib/"
   ],
   "bugs": {
-    "url": "https://github.com/azu/textlint-rule-en-max-word-count/issues"
+    "url": "https://github.com/textlint-rule/textlint-rule-en-max-word-count/issues"
   },
   "version": "2.0.0",
   "description": "textlint rule that specify the maximum word count of a sentence.",
@@ -22,16 +22,16 @@
     "test": "test"
   },
   "dependencies": {
-    "sentence-splitter": "^3.2.2",
-    "textlint-tester": "^12.2.0",
-    "textlint-util-to-string": "^3.1.1",
-    "unist-util-map": "^1.0.1"
+    "sentence-splitter": "^4.1.0",
+    "textlint-util-to-string": "^3.3.2"
   },
   "devDependencies": {
-    "textlint-scripts": "^12.2.1"
-  },
-  "peerDependencies": {
-    "textlint": ">= 12.2.0"
+    "@types/node": "^18.13.0",
+    "@textlint/types": "^13.3.0",
+    "textlint-scripts": "^13.3.0",
+    "textlint-tester": "^13.3.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5"
   },
   "scripts": {
     "build": "textlint-scripts build",

src/split-words.js

@@ -0,0 +1,13 @@
+export function splitWords(string: string) {
+    if (!string) return [];
+
+    const match = string.match(/"(?:\\"|[^"])+"|[^\s]+/g);
+    if (!match) {
+        return [];
+    }
+    // Remove quotes from start and end of quoted strings matched above
+    return match
+        .map(function (word) {
+            return word.replace(/^\"|\"$/g, "");
+        });
+}

src/split-words.ts

@@ -0,0 +1,65 @@
+// Helper for converting plain text from Syntax-ed text(markdown AST
+// https://github.com/azu/textlint-util-to-string
+import { StringSource } from "textlint-util-to-string";
+// Helper for splitting text to sentences
+// https://github.com/azu/sentence-splitter
+import { splitAST, SentenceSplitterSyntax } from "sentence-splitter";
+// Helper for splitting text to words
+// https://github.com/timjrobinson/split-string-words
+import { splitWords } from "./split-words";
+import { TextlintRuleModule } from "@textlint/types";
+import type { TxtNode } from "@textlint/ast-node-types";
+
+// Default options
+const defaultOptions = {
+    // max count of words >
+    max: 50
+};
+export type Options = {
+    max?: number;
+}
+const report: TextlintRuleModule<Options> = (context, options = {}) => {
+    const { Syntax, RuleError, report } = context;
+    const maxWordCount = options.max ? options.max : defaultOptions.max;
+    return {
+        [Syntax.Paragraph](node) {
+            const sentenceRootNode = splitAST(node);
+            // get sentences from Paragraph
+            const sentences = sentenceRootNode.children.filter(node => {
+                return node.type === SentenceSplitterSyntax.Sentence;
+            });
+            sentences.forEach(sentence => {
+                const source = new StringSource(sentence, {
+                    replacer({ node, maskValue }) {
+                        // replace code with dummy code because code will include any words, but we don't want to count it
+                        if (node.type === Syntax.Code) {
+                            return maskValue("_");
+                        }
+                        return;
+                    },
+                });
+                const sentenceText = source.toString();
+                /* sentence object is a node
+                {
+                    type: "Sentence",
+                    raw: text,
+                    value: text,
+                    loc: loc,
+                    range: range
+                };
+                 */
+                // words in a sentence
+                const words = splitWords(sentenceText);
+                // over count of word, then report error
+                if (words.length > maxWordCount) {
+                    // get original index value of sentence.loc.start
+                    const sentenceFragment = `${words.slice(0, 3).join(' ')} ...`;
+                    const ruleError = new RuleError(`Maximum word count (${maxWordCount}) exceeded (${words.length}) by "${sentenceFragment}".`);
+                    report(sentence as TxtNode, ruleError);
+                }
+            });
+        }
+    };
+}
+
+export default report

src/textlint-rule-en-max-word-count.js

@@ -1,5 +1,4 @@
 import TextLintTester from "textlint-tester"
-
 const tester = new TextLintTester();
 // rule
 import rule from "../src/textlint-rule-en-max-word-count";

src/textlint-rule-en-max-word-count.ts

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "newLine": "LF",
+    "noEmit": true,
+    "target": "ES2018",
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+    "jsx": "preserve",
+    "lib": [
+      "esnext"
+    ],
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": [
+    "**/*"
+  ],
+  "exclude": [
+    ".git",
+    "node_modules"
+  ]
+}