@scurrlin/stencil 1.0.4 → 1.0.6

package/README.md

@@ -14,7 +14,7 @@ Whether you are studying for technical interviews, or just starting your coding
 
 Most people when they attempt to memorize something study the full text and then attempt to regurgitate it on a blank page. Shocking, I know... but what if there was a step in between? What if memorization and pattern recognition weren't all or nothing games? This is where Stencil comes in.
 
-Stencil is a memorization tool that strips code files down to their first letters while preserving spacing, capitalization, and punctuation. The "stencil" of the file is designed to act as a bridge between having something partially memorized and fully memorized. Below is an example of Stencil in action using LeetCode problem 217 "Contains Duplicate":
+Stencil is a language-agnostic memorization tool that strips code files down to their first letters while preserving spacing, capitalization, and punctuation. The "stencil" of the file is designed to act as a bridge between having something partially memorized and fully memorized. Below is an example of Stencil in action using LeetCode problem 217 "Contains Duplicate":
 
 ## Example
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scurrlin/stencil",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "A memorization tool that strips code down to first letters and punctuation only.",
   "main": "src/index.js",
   "bin": {

package/src/index.js

@@ -17,7 +17,7 @@ async function transformFile(filePath, options = {}) {
     throw new Error(`Unable to read file: ${err.message}`);
   });
 
-  // Create an interface for reading the file line by line
+  // Create interface for reading the file line by line
   const rl = readline.createInterface({
     input: fileStream,
     crlfDelay: Infinity
@@ -44,11 +44,11 @@ async function transformFile(filePath, options = {}) {
 }
 
 function transformLine(line) {
-  // Regular expression to match sequences of letters and numbers
+  // Regex to match sequences of letters and numbers
   // \p{L} matches any kind of letter from any language
   // \p{N} matches any kind of numeric character
-  // The 'u' flag enables Unicode support
-  // The 'g' flag enables global matching
+  // 'u' flag enables Unicode support
+  // 'g' flag enables global matching
   return line.replace(/[\p{L}\p{N}]+/gu, (match) => {
     return match[0]; // Retain only the first character
   });