get-reading-time 1.0.0 → 1.0.2

package/README.md

@@ -26,13 +26,13 @@ A simple text analysis tool that provides insights into text such as reading tim
 
 To install the package from npm, run:
 ``` bash
-npm install text-analysis-tool 
+npm i get-reading-time
 ```
 
 
 Or using yarn:
 ```bash
-yarn  add get-reading-time
+yarn add get-reading-time
 ```
 
 ## Usage

package/dist/index.d.mts

@@ -0,0 +1,16 @@
+interface TextAnalysisResult {
+    readingTime: {
+        minutes: number;
+        seconds: number;
+    };
+    wordCount: number;
+    characterCount: number;
+    sentenceCount: number;
+    linkCount: number;
+    readabilityScore: number;
+    sentiment: string;
+    keywords: string[];
+}
+declare function analyzeText(text: string, wordsPerMinute?: number): TextAnalysisResult;
+
+export { analyzeText };

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+interface TextAnalysisResult {
+    readingTime: {
+        minutes: number;
+        seconds: number;
+    };
+    wordCount: number;
+    characterCount: number;
+    sentenceCount: number;
+    linkCount: number;
+    readabilityScore: number;
+    sentiment: string;
+    keywords: string[];
+}
+declare function analyzeText(text: string, wordsPerMinute?: number): TextAnalysisResult;
+
+export { analyzeText };

package/dist/index.js

@@ -0,0 +1,163 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  analyzeText: () => analyzeText
+});
+module.exports = __toCommonJS(index_exports);
+var import_sentiment = __toESM(require("sentiment"));
+var DEFAULT_READING_SPEED = 200;
+function analyzeText(text, wordsPerMinute = DEFAULT_READING_SPEED) {
+  if (!text || typeof text !== "string") {
+    throw new Error("Invalid text input. Please provide a valid string.");
+  }
+  const cleanText = cleanTextInput(text);
+  const wordCount = calculateWordCount(cleanText);
+  const characterCount = calculateCharacterCount(cleanText);
+  const sentenceCount = calculateSentenceCount(cleanText);
+  const { minutes, seconds } = calculateReadingTime(wordCount, wordsPerMinute);
+  const linkCount = countLinks(cleanText);
+  const readabilityScore = calculateReadabilityScore(cleanText);
+  const sentiment = analyzeSentiment(cleanText);
+  const keywords = extractKeywords(cleanText);
+  return {
+    readingTime: { minutes, seconds },
+    wordCount,
+    characterCount,
+    sentenceCount,
+    linkCount,
+    readabilityScore,
+    sentiment,
+    keywords
+  };
+}
+function cleanTextInput(text) {
+  return text.replace(/\s+/g, " ").trim();
+}
+function calculateWordCount(text) {
+  return text.split(/\s+/).length;
+}
+function calculateCharacterCount(text) {
+  return text.replace(/\s+/g, "").length;
+}
+function calculateSentenceCount(text) {
+  return (text.match(/[.!?]+/g) || []).length;
+}
+function calculateReadingTime(wordCount, wordsPerMinute) {
+  if (wordCount === 0) return { minutes: 0, seconds: 0 };
+  const readingTimeInMinutes = wordCount / wordsPerMinute;
+  const minutes = readingTimeInMinutes.toFixed(2);
+  const seconds = ((readingTimeInMinutes - Math.floor(readingTimeInMinutes)) * 60).toFixed(2);
+  return { minutes: parseFloat(minutes), seconds: parseFloat(seconds) };
+}
+function countLinks(text) {
+  const linkRegex = /https?:\/\/[^\s]+/g;
+  const matches = text.match(linkRegex);
+  return matches ? matches.length : 0;
+}
+function calculateReadabilityScore(text) {
+  const wordCount = calculateWordCount(text);
+  const sentenceCount = calculateSentenceCount(text);
+  const syllableCount = calculateSyllableCount(text);
+  if (wordCount === 0 || sentenceCount === 0) return 0;
+  return 206.835 - 1.015 * (wordCount / sentenceCount) - 84.6 * (syllableCount / wordCount);
+}
+function calculateSyllableCount(text) {
+  return (text.match(/[aeiouy]{1,2}/g) || []).length;
+}
+function analyzeSentiment(text) {
+  const sentiment = new import_sentiment.default();
+  const result = sentiment.analyze(text);
+  return result.score > 0 ? "Positive" : result.score < 0 ? "Negative" : "Neutral";
+}
+function extractKeywords(text) {
+  const words = text.toLowerCase().split(/\s+/);
+  const wordFrequency = /* @__PURE__ */ new Map();
+  const stopWords = /* @__PURE__ */ new Set([
+    "the",
+    "and",
+    "a",
+    "to",
+    "of",
+    "in",
+    "on",
+    "for",
+    "with",
+    "at",
+    "by",
+    "an",
+    "this",
+    "that",
+    "it",
+    "is",
+    "was",
+    "for",
+    "as",
+    "be",
+    "are",
+    "which",
+    "or",
+    "but",
+    "not",
+    "from",
+    "have",
+    "has"
+  ]);
+  words.forEach((word) => {
+    if (!isStopWord(word, stopWords) && word.length > 2) {
+      wordFrequency.set(word, (wordFrequency.get(word) || 0) + 1);
+    }
+  });
+  const nGrams = extractNGrams(words);
+  nGrams.forEach((nGram) => {
+    if (!isStopWord(nGram, stopWords)) {
+      wordFrequency.set(nGram, (wordFrequency.get(nGram) || 0) + 1);
+    }
+  });
+  return Array.from(wordFrequency).sort(([, countA], [, countB]) => countB - countA).slice(0, 5).map(([key]) => key);
+}
+function extractNGrams(words) {
+  const nGrams = [];
+  for (let i = 0; i < words.length - 1; i++) {
+    nGrams.push(words[i] + " " + words[i + 1]);
+    if (i < words.length - 2) {
+      nGrams.push(words[i] + " " + words[i + 1] + " " + words[i + 2]);
+    }
+  }
+  return nGrams;
+}
+function isStopWord(word, stopWords) {
+  return stopWords.has(word);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  analyzeText
+});

package/dist/index.mjs

@@ -0,0 +1,128 @@
+// src/index.ts
+import Sentiment from "sentiment";
+var DEFAULT_READING_SPEED = 200;
+function analyzeText(text, wordsPerMinute = DEFAULT_READING_SPEED) {
+  if (!text || typeof text !== "string") {
+    throw new Error("Invalid text input. Please provide a valid string.");
+  }
+  const cleanText = cleanTextInput(text);
+  const wordCount = calculateWordCount(cleanText);
+  const characterCount = calculateCharacterCount(cleanText);
+  const sentenceCount = calculateSentenceCount(cleanText);
+  const { minutes, seconds } = calculateReadingTime(wordCount, wordsPerMinute);
+  const linkCount = countLinks(cleanText);
+  const readabilityScore = calculateReadabilityScore(cleanText);
+  const sentiment = analyzeSentiment(cleanText);
+  const keywords = extractKeywords(cleanText);
+  return {
+    readingTime: { minutes, seconds },
+    wordCount,
+    characterCount,
+    sentenceCount,
+    linkCount,
+    readabilityScore,
+    sentiment,
+    keywords
+  };
+}
+function cleanTextInput(text) {
+  return text.replace(/\s+/g, " ").trim();
+}
+function calculateWordCount(text) {
+  return text.split(/\s+/).length;
+}
+function calculateCharacterCount(text) {
+  return text.replace(/\s+/g, "").length;
+}
+function calculateSentenceCount(text) {
+  return (text.match(/[.!?]+/g) || []).length;
+}
+function calculateReadingTime(wordCount, wordsPerMinute) {
+  if (wordCount === 0) return { minutes: 0, seconds: 0 };
+  const readingTimeInMinutes = wordCount / wordsPerMinute;
+  const minutes = readingTimeInMinutes.toFixed(2);
+  const seconds = ((readingTimeInMinutes - Math.floor(readingTimeInMinutes)) * 60).toFixed(2);
+  return { minutes: parseFloat(minutes), seconds: parseFloat(seconds) };
+}
+function countLinks(text) {
+  const linkRegex = /https?:\/\/[^\s]+/g;
+  const matches = text.match(linkRegex);
+  return matches ? matches.length : 0;
+}
+function calculateReadabilityScore(text) {
+  const wordCount = calculateWordCount(text);
+  const sentenceCount = calculateSentenceCount(text);
+  const syllableCount = calculateSyllableCount(text);
+  if (wordCount === 0 || sentenceCount === 0) return 0;
+  return 206.835 - 1.015 * (wordCount / sentenceCount) - 84.6 * (syllableCount / wordCount);
+}
+function calculateSyllableCount(text) {
+  return (text.match(/[aeiouy]{1,2}/g) || []).length;
+}
+function analyzeSentiment(text) {
+  const sentiment = new Sentiment();
+  const result = sentiment.analyze(text);
+  return result.score > 0 ? "Positive" : result.score < 0 ? "Negative" : "Neutral";
+}
+function extractKeywords(text) {
+  const words = text.toLowerCase().split(/\s+/);
+  const wordFrequency = /* @__PURE__ */ new Map();
+  const stopWords = /* @__PURE__ */ new Set([
+    "the",
+    "and",
+    "a",
+    "to",
+    "of",
+    "in",
+    "on",
+    "for",
+    "with",
+    "at",
+    "by",
+    "an",
+    "this",
+    "that",
+    "it",
+    "is",
+    "was",
+    "for",
+    "as",
+    "be",
+    "are",
+    "which",
+    "or",
+    "but",
+    "not",
+    "from",
+    "have",
+    "has"
+  ]);
+  words.forEach((word) => {
+    if (!isStopWord(word, stopWords) && word.length > 2) {
+      wordFrequency.set(word, (wordFrequency.get(word) || 0) + 1);
+    }
+  });
+  const nGrams = extractNGrams(words);
+  nGrams.forEach((nGram) => {
+    if (!isStopWord(nGram, stopWords)) {
+      wordFrequency.set(nGram, (wordFrequency.get(nGram) || 0) + 1);
+    }
+  });
+  return Array.from(wordFrequency).sort(([, countA], [, countB]) => countB - countA).slice(0, 5).map(([key]) => key);
+}
+function extractNGrams(words) {
+  const nGrams = [];
+  for (let i = 0; i < words.length - 1; i++) {
+    nGrams.push(words[i] + " " + words[i + 1]);
+    if (i < words.length - 2) {
+      nGrams.push(words[i] + " " + words[i + 1] + " " + words[i + 2]);
+    }
+  }
+  return nGrams;
+}
+function isStopWord(word, stopWords) {
+  return stopWords.has(word);
+}
+export {
+  analyzeText
+};

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "get-reading-time",
-  "version": "1.0.0",
-  "main": "index.js",
+  "version": "1.0.2",
+  "main": "/dist/index.js",
+  "module": "/dist/index.mjs",
+  "types": "/dist/index.d.ts",
   "scripts": {
-    "build": "tsc",
+    "build": "tsup",
     "start": "node dist/test.js"
   },
   "repository": {
@@ -137,6 +139,7 @@
     "typescript": "^5.7.2"
   },
   "dependencies": {
-    "sentiment": "^5.0.2"
+    "sentiment": "^5.0.2",
+    "tsup": "^8.3.5"
   }
 }

package/src/index.ts

@@ -1,163 +0,0 @@
-import Sentiment from "sentiment";
-
-// Constants
-const DEFAULT_READING_SPEED = 200; // Default reading speed (words per minute)
-
-// Type Definitions
-interface TextAnalysisResult {
-    readingTime: { minutes: number; seconds: number };
-    wordCount: number;
-    characterCount: number;
-    sentenceCount: number;
-    linkCount: number;
-    readabilityScore: number;
-    sentiment: string;
-    keywords: string[];
-}
-
-// Main Analysis Function
-export function analyzeText(
-    text: string,
-    wordsPerMinute: number = DEFAULT_READING_SPEED
-): TextAnalysisResult {
-    if (!text || typeof text !== "string") {
-        throw new Error("Invalid text input. Please provide a valid string.");
-    }
-
-    // Clean the input text for further analysis
-    const cleanText = cleanTextInput(text);
-
-    // Perform analysis
-    const wordCount = calculateWordCount(cleanText);
-    const characterCount = calculateCharacterCount(cleanText);
-    const sentenceCount = calculateSentenceCount(cleanText);
-    const { minutes, seconds } = calculateReadingTime(wordCount, wordsPerMinute);
-    const linkCount = countLinks(cleanText);
-    const readabilityScore = calculateReadabilityScore(cleanText);
-    const sentiment = analyzeSentiment(cleanText);
-    const keywords = extractKeywords(cleanText);
-
-    return {
-        readingTime: { minutes, seconds },
-        wordCount,
-        characterCount,
-        sentenceCount,
-        linkCount,
-        readabilityScore,
-        sentiment,
-        keywords
-    };
-}
-
-// Clean the input text by removing extra spaces and special characters
-function cleanTextInput(text: string): string {
-    return text.replace(/\s+/g, " ").trim();
-}
-
-// Calculate word count
-function calculateWordCount(text: string): number {
-    return text.split(/\s+/).length;
-}
-
-// Calculate character count excluding spaces
-function calculateCharacterCount(text: string): number {
-    return text.replace(/\s+/g, "").length;
-}
-
-// Calculate sentence count based on punctuation marks
-function calculateSentenceCount(text: string): number {
-    return (text.match(/[.!?]+/g) || []).length;
-}
-
-// Calculate reading time in minutes and seconds
-function calculateReadingTime(wordCount: number, wordsPerMinute: number): { minutes: number; seconds: number } {
-    if (wordCount === 0) return { minutes: 0, seconds: 0 }; // Avoid division by zero
-
-    const readingTimeInMinutes = wordCount / wordsPerMinute;
-    const minutes = readingTimeInMinutes.toFixed(2);  // Convert to 2 decimal places
-    const seconds = ((readingTimeInMinutes - Math.floor(readingTimeInMinutes)) * 60).toFixed(2);  // Seconds as float with 2 decimal places
-
-    return { minutes: parseFloat(minutes), seconds: parseFloat(seconds) };
-}
-
-// Count the number of links (URLs) in the text
-function countLinks(text: string): number {
-    const linkRegex = /https?:\/\/[^\s]+/g;
-    const matches = text.match(linkRegex);
-    return matches ? matches.length : 0;
-}
-
-// Calculate readability score using Flesch Reading Ease formula
-function calculateReadabilityScore(text: string): number {
-    const wordCount = calculateWordCount(text);
-    const sentenceCount = calculateSentenceCount(text);
-    const syllableCount = calculateSyllableCount(text);
-
-    if (wordCount === 0 || sentenceCount === 0) return 0; // Avoid division by zero
-
-    return 206.835 - 1.015 * (wordCount / sentenceCount) - 84.6 * (syllableCount / wordCount);
-}
-
-// Simple syllable count based on vowels (simplified version)
-function calculateSyllableCount(text: string): number {
-    return (text.match(/[aeiouy]{1,2}/g) || []).length;
-}
-
-// Perform sentiment analysis using Sentiment.js
-function analyzeSentiment(text: string): string {
-    const sentiment = new Sentiment();
-    const result = sentiment.analyze(text);
-    return result.score > 0 ? "Positive" : result.score < 0 ? "Negative" : "Neutral";
-}
-
-// Extract top 5 SEO-friendly keywords from the text
-function extractKeywords(text: string): string[] {
-    const words = text.toLowerCase().split(/\s+/);
-    const wordFrequency: Map<string, number> = new Map();
-
-    // Use a Set for fast stop word lookup
-    const stopWords = new Set([
-        "the", "and", "a", "to", "of", "in", "on", "for", "with", "at", "by", "an", "this",
-        "that", "it", "is", "was", "for", "as", "be", "are", "which", "or", "but", "not", "from", "have", "has"
-    ]);
-
-    // Count word frequency
-    words.forEach((word) => {
-        if (!isStopWord(word, stopWords) && word.length > 2) {  // Only consider words longer than 2 characters
-            wordFrequency.set(word, (wordFrequency.get(word) || 0) + 1);
-        }
-    });
-
-    // Extract meaningful n-grams (bi-grams and tri-grams)
-    const nGrams = extractNGrams(words);
-    nGrams.forEach((nGram) => {
-        if (!isStopWord(nGram, stopWords)) {
-            wordFrequency.set(nGram, (wordFrequency.get(nGram) || 0) + 1);
-        }
-    });
-
-    // Sort words and n-grams by frequency and return top 5
-    return Array.from(wordFrequency)
-        .sort(([, countA], [, countB]) => countB - countA)
-        .slice(0, 5)
-        .map(([key]) => key);
-}
-
-// Extract n-grams (bi-grams and tri-grams) from the list of words
-function extractNGrams(words: string[]): string[] {
-    const nGrams: string[] = [];
-
-    for (let i = 0; i < words.length - 1; i++) {
-        nGrams.push(words[i] + " " + words[i + 1]);  // Bi-grams
-        if (i < words.length - 2) {
-            nGrams.push(words[i] + " " + words[i + 1] + " " + words[i + 2]);  // Tri-grams
-        }
-    }
-
-    return nGrams;
-}
-
-// Check if a word is a common stop word (to exclude from keywords)
-function isStopWord(word: string, stopWords: Set<string>): boolean {
-    return stopWords.has(word);
-}

package/src/test.ts

@@ -1,61 +0,0 @@
-import { analyzeText } from "./index";
-
-// Example text to analyze
-const exampleText = `
-How do I decide what to put in a paragraph?
-Before you can begin to determine what the composition of a particular paragraph will be, you must first decide on an argument and a working thesis statement for your paper. What is the most important idea that you are trying to convey to your reader? The information in each paragraph must be related to that idea. In other words, your paragraphs should remind your reader that there is a recurrent relationship between your thesis and the information in each paragraph. A working thesis functions like a seed from which your paper, and your ideas, will grow. The whole process is an organic one—a natural progression from a seed to a full-blown paper where there are direct, familial relationships between all of the ideas in the paper.
-
-The decision about what to put into your paragraphs begins with the germination of a seed of ideas; this “germination process” is better known as brainstorming. There are many techniques for brainstorming; whichever one you choose, this stage of paragraph development cannot be skipped. Building paragraphs can be like building a skyscraper: there must be a well-planned foundation that supports what you are building. Any cracks, inconsistencies, or other corruptions of the foundation can cause your whole paper to crumble.
-
-So, let’s suppose that you have done some brainstorming to develop your thesis. What else should you keep in mind as you begin to create paragraphs? Every paragraph in a paper should be:
-
-Unified: All of the sentences in a single paragraph should be related to a single controlling idea (often expressed in the topic sentence of the paragraph).
-Clearly related to the thesis: The sentences should all refer to the central idea, or thesis, of the paper (Rosen and Behrens 119).
-Coherent: The sentences should be arranged in a logical manner and should follow a definite plan for development (Rosen and Behrens 119).
-Well-developed: Every idea discussed in the paragraph should be adequately explained and supported through evidence and details that work together to explain the paragraph’s controlling idea (Rosen and Behrens 119).
-How do I organize a paragraph?
-There are many different ways to organize a paragraph. The organization you choose will depend on the controlling idea of the paragraph. Below are a few possibilities for organization, with links to brief examples:
-
-Narration: Tell a story. Go chronologically, from start to finish. (See an example.)
-Description: Provide specific details about what something looks, smells, tastes, sounds, or feels like. Organize spatially, in order of appearance, or by topic. (See an example.)
-Process: Explain how something works, step by step. Perhaps follow a sequence—first, second, third. (See an example.)
-Classification: Separate into groups or explain the various parts of a topic. (See an example.)
-Illustration: Give examples and explain how those examples support your point. (See an example in the 5-step process below.)
-Illustration paragraph: a 5-step example
-From the list above, let’s choose “illustration” as our rhetorical purpose. We’ll walk through a 5-step process for building a paragraph that illustrates a point in an argument. For each step there is an explanation and example. Our example paragraph will be about human misconceptions of piranhas.
-
-Step 1. Decide on a controlling idea and create a topic sentence
-Paragraph development begins with the formulation of the controlling idea. This idea directs the paragraph’s development. Often, the controlling idea of a paragraph will appear in the form of a topic sentence. In some cases, you may need more than one sentence to express a paragraph’s controlling idea.
-
-Controlling idea and topic sentence — Despite the fact that piranhas are relatively harmless, many people continue to believe the pervasive myth that piranhas are dangerous to humans.
-
-Step 2. Elaborate on the controlling idea
-Paragraph development continues with an elaboration on the controlling idea, perhaps with an explanation, implication, or statement about significance. Our example offers a possible explanation for the pervasiveness of the myth.
-
-Elaboration — This impression of piranhas is exacerbated by their mischaracterization in popular media.
-
-Step 3. Give an example (or multiple examples)
-Paragraph development progresses with an example (or more) that illustrates the claims made in the previous sentences.
-
-Example — For example, the promotional poster for the 1978 horror film Piranha features an oversized piranha poised to bite the leg of an unsuspecting woman.
-
-Step 4. Explain the example(s)
-The next movement in paragraph development is an explanation of each example and its relevance to the topic sentence. The explanation should demonstrate the value of the example as evidence to support the major claim, or focus, in your paragraph.
-
-Continue the pattern of giving examples and explaining them until all points/examples that the writer deems necessary have been made and explained. NONE of your examples should be left unexplained. You might be able to explain the relationship between the example and the topic sentence in the same sentence which introduced the example. More often, however, you will need to explain that relationship in a separate sentence.`;
-
-// Analyze the text
-try {
-    const analysis = analyzeText(exampleText);
-
-    // Output the analysis results
-    console.log("Text Analysis Result:");
-    console.log(JSON.stringify(analysis, null, 2));
-} catch (error) {
-    // Narrow the type of error to Error
-    if (error instanceof Error) {
-        console.error("Error analyzing text:", error.message);
-    } else {
-        console.error("Unknown error:", error);
-    }
-}

package/tsconfig.json

@@ -1,12 +0,0 @@
-{
-    "compilerOptions": {
-      "target": "ES6",
-      "module": "CommonJS",
-      "outDir": "dist",
-      "strict": true,
-      "esModuleInterop": true
-    },
-    "include": ["src/**/*.ts"],
-    "exclude": ["node_modules"]
-  }
-