easyen 0.1.1

package/dist/normalize.js

@@ -0,0 +1,38 @@
+"use strict";
+/**
+ * String-level cleaning steps. Each function does exactly one transform and
+ * is pure: same input always gives the same output, no side effects.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeApostrophes = normalizeApostrophes;
+exports.expandContractions = expandContractions;
+/** Turn curly apostrophes (’) into straight ones ('). */
+function normalizeApostrophes(text) {
+    return text.replace(/[’]/g, "'");
+}
+/**
+ * Ordered contraction rules. Specials (won't, can't) must run before the
+ * generic "n't" rule, otherwise "can't" would wrongly become "ca not".
+ * Expansions are lower-case function words; that is fine because matching
+ * is case-insensitive.
+ */
+const CONTRACTION_RULES = [
+    [/\bwon't\b/gi, "will not"],
+    [/\bcan't\b/gi, "can not"],
+    [/\bshan't\b/gi, "shall not"],
+    [/\bain't\b/gi, "be not"],
+    [/n't\b/gi, " not"], // don't -> do not, isn't -> is not
+    [/'re\b/gi, " are"], // they're -> they are
+    [/'ve\b/gi, " have"], // I've -> I have
+    [/'ll\b/gi, " will"], // we'll -> we will
+    [/'m\b/gi, " am"], // I'm -> I am
+    [/'d\b/gi, ""], // I'd -> I (had/would is ambiguous, keep the stem)
+    [/'s\b/gi, ""], // it's / child's -> drop (is/has or possessive)
+];
+/**
+ * Expand the common English contractions so their base words can be matched.
+ * Assumes apostrophes are already straight (run `normalizeApostrophes` first).
+ */
+function expandContractions(text) {
+    return CONTRACTION_RULES.reduce((acc, [pattern, replacement]) => acc.replace(pattern, replacement), text);
+}

package/dist/pipe.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Left-to-right function composition for same-typed steps.
+ *
+ *   const f = pipe(a, b, c);  // f(x) === c(b(a(x)))
+ *
+ * Used to chain the string-cleaning steps into one readable pipeline.
+ */
+export declare function pipe<T>(...steps: Array<(value: T) => T>): (value: T) => T;

package/dist/pipe.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pipe = pipe;
+/**
+ * Left-to-right function composition for same-typed steps.
+ *
+ *   const f = pipe(a, b, c);  // f(x) === c(b(a(x)))
+ *
+ * Used to chain the string-cleaning steps into one readable pipeline.
+ */
+function pipe(...steps) {
+    return (value) => steps.reduce((acc, step) => step(acc), value);
+}

package/dist/sentences.d.ts

@@ -0,0 +1,23 @@
+/** A sentence that is longer than the limit. */
+export interface LongSentence {
+    text: string;
+    words: number;
+}
+export interface SentenceCheck {
+    /** How many sentences were found. */
+    sentences: number;
+    /** Average words per sentence (the main number; lower reads easier). */
+    wordsPerSentence: number;
+    /** Words in the longest sentence. */
+    longest: number;
+    /** Sentences over the limit, longest first. These are the ones to break up. */
+    longSentences: LongSentence[];
+}
+export interface SentenceOptions {
+    /**
+     * A sentence with more words than this is "long".
+     * @default 30
+     */
+    longSentenceWords?: number;
+}
+export declare function checkSentences(text: string, options?: SentenceOptions): SentenceCheck;

package/dist/sentences.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkSentences = checkSentences;
+/**
+ * The second readability signal: sentence length.
+ *
+ * Word coverage cannot see that a text is hard because its sentences are long
+ * and winding. This counts sentence length — pure measurement, no judgement.
+ * The AI decides whether a long sentence should be broken up.
+ */
+const extract_1 = require("./extract");
+/** Split text into sentence-like pieces (on . ! ? and line breaks). */
+function splitSentences(text) {
+    return text
+        .split(/[.!?]+(?=\s|$)|\n+/)
+        .map((piece) => piece.trim())
+        .filter(Boolean);
+}
+function checkSentences(text, options = {}) {
+    const limit = options.longSentenceWords ?? 30;
+    const pieces = splitSentences(text)
+        .map((piece) => ({ text: piece, words: (0, extract_1.splitWords)(piece).length }))
+        .filter((s) => s.words > 0);
+    const sentences = pieces.length;
+    const totalWords = pieces.reduce((sum, s) => sum + s.words, 0);
+    const longest = pieces.reduce((max, s) => Math.max(max, s.words), 0);
+    const longSentences = pieces
+        .filter((s) => s.words > limit)
+        .sort((a, b) => b.words - a.words);
+    return {
+        sentences,
+        wordsPerSentence: sentences === 0 ? 0 : totalWords / sentences,
+        longest,
+        longSentences,
+    };
+}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "easyen",
+  "version": "0.1.1",
+  "description": "Check how easy an English text is to read — vocabulary level and sentence length. Helps keep AI output simple. Pure TypeScript, zero runtime dependencies.",
+  "author": "zhangxiangliang",
+  "keywords": [
+    "english",
+    "readability",
+    "vocabulary",
+    "plain-english",
+    "sentence-length",
+    "ai",
+    "typescript",
+    "可读性",
+    "词汇",
+    "英语"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zhangxiangliang/easyen.git"
+  },
+  "homepage": "https://github.com/zhangxiangliang/easyen#readme",
+  "bugs": "https://github.com/zhangxiangliang/easyen/issues",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "easyen": "dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "clean": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\"",
+    "prebuild": "npm run clean",
+    "build": "tsc -p tsconfig.build.json",
+    "postbuild": "node scripts/copy-dictionaries.mjs && node -e \"require('fs').chmodSync('dist/cli.js', 0o755)\"",
+    "prepack": "npm run build",
+    "prepare": "husky",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "typecheck": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p tsconfig.test.json",
+    "test": "jest --config jest.config.js --coverage",
+    "test:unit": "npm test -- --runInBand",
+    "ci": "npm run build && npm run typecheck && npm test",
+    "validate": "npm run lint && npm run ci",
+    "validate:release": "npm run validate"
+  },
+  "license": "MIT",
+  "files": [
+    "dist/**/*",
+    "SKILL.md"
+  ],
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.0.0",
+    "eslint": "^10.2.1",
+    "globals": "^17.5.0",
+    "husky": "^9.1.7",
+    "jest": "^30.3.0",
+    "semantic-release": "^25.0.3",
+    "ts-jest": "^29.4.9",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.59.1"
+  }
+}