@scurrlin/stencil 1.34.5 → 1.34.7

package/README.md

@@ -16,7 +16,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 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 371 "Sum of Two Integers":
+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 372 "Super Pow":
 
 ## Example
 
@@ -24,28 +24,28 @@ Solution
 
 ```python
 class Solution:
-    def getSum(self, a: int, b: int) -> int:
-        mask = 0xffffffff
-        while (b & mask) > 0:
-            carry = ( a & b ) << 1
-            a = (a ^ b) 
-            b = carry
-        
-        return (a & mask) if b > 0 else a
+    def superPow(self, a: int, b: List[int]) -> int:
+        exp = 0
+        for e in b:
+            exp = e + 10 * exp
+            exp %= 1140
+        if exp == 0:
+            exp = 1140 
+        return pow(a, exp, 1337)
 ```
 
 Solution with Stencil
 
 ```python
 c S:
-    d g(s, a: i, b: i) -> i:
-        m = 0
-        w (b & m) > 0:
-            c = ( a & b ) << 1
-            a = (a ^ b) 
-            b = c
-        
-        r (a & m) i b > 0 e a
+    d s(s, a: i, b: L[i]) -> i:
+        e = 0
+        f e i b:
+            e = e + 1 * e
+            e %= 1
+        i e == 0:
+            e = 1 
+        r p(a, e, 1)
 ```
 
 ## Local Installation

package/dist/bin/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin/cli.js

@@ -0,0 +1,37 @@
+#!/usr/bin/env node
+import { transformFile } from '../src/index.js';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+async function run() {
+    const argv = await yargs(hideBin(process.argv))
+        .usage('Usage: stencil <path> [options]')
+        .example('npx stencil path/to/file.py --start 2 --end 10', 'Transform only lines 2-10 (local installation)\n')
+        .example('stencil path/to/file.py --start 2 --end 10', 'Transform only lines 2-10 (global installation)')
+        .option('start', {
+        alias: 's',
+        type: 'number',
+        default: undefined,
+        describe: 'Start line number for transformation'
+    })
+        .option('end', {
+        alias: 'e',
+        type: 'number',
+        default: undefined,
+        describe: 'End line number for transformation'
+    })
+        .demandCommand(1, 'Please provide the path to the file you wish to transform.')
+        .help('h')
+        .alias('h', 'help')
+        .argv;
+    const filePath = argv._[0];
+    const { start, end } = argv;
+    try {
+        const transformedCode = await transformFile(filePath, { startLine: start, endLine: end });
+        console.log(transformedCode);
+    }
+    catch (error) {
+        console.error('Error:', error.message);
+        process.exit(1);
+    }
+}
+run();

package/dist/src/index.d.ts

@@ -0,0 +1,7 @@
+interface TransformOptions {
+    startLine?: number | null;
+    endLine?: number | null;
+}
+export declare function transformFile(filePath: string, options?: TransformOptions): Promise<string>;
+export declare function transformLine(line: string): string;
+export {};

package/dist/src/index.js

@@ -0,0 +1,36 @@
+import fs from 'node:fs';
+import readline from 'node:readline';
+export async function transformFile(filePath, options = {}) {
+    const { startLine = null, endLine = null } = options;
+    if (!fs.existsSync(filePath)) {
+        throw new Error(`File not found: ${filePath}`);
+    }
+    const fileStream = fs.createReadStream(filePath, { encoding: 'utf-8' });
+    fileStream.on('error', (err) => {
+        throw new Error(`Unable to read file: ${err.message}`);
+    });
+    const rl = readline.createInterface({
+        input: fileStream,
+        crlfDelay: Infinity
+    });
+    let currentLine = 0;
+    const transformedLines = [];
+    for await (const line of rl) {
+        currentLine++;
+        if ((startLine === null || currentLine >= startLine) &&
+            (endLine === null || currentLine <= endLine)) {
+            transformedLines.push(transformLine(line));
+        }
+        else {
+            transformedLines.push(line);
+        }
+    }
+    return transformedLines.join('\n');
+}
+export function transformLine(line) {
+    // \p{L} matches any kind of letter from any language
+    // \p{N} matches any kind of numeric character
+    return line.replace(/[\p{L}\p{N}]+/gu, (match) => {
+        return match[0];
+    });
+}

package/package.json

@@ -1,13 +1,33 @@
 {
   "name": "@scurrlin/stencil",
-  "version": "1.34.5",
+  "version": "1.34.7",
+  "type": "module",
   "description": "A memorization tool that strips code down to first letters and punctuation only.",
-  "main": "src/index.js",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    }
+  },
   "bin": {
-    "stencil": "./bin/cli.js"
+    "stencil": "./dist/bin/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE.txt"
+  ],
+  "engines": {
+    "node": ">=22"
   },
   "scripts": {
-    "start": "node bin/cli.js"
+    "start": "node dist/bin/cli.js",
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build && npm test"
   },
   "dependencies": {
     "yargs": "^17.7.2"
@@ -20,5 +40,12 @@
     "leetcode"
   ],
   "author": "Sean Currlin",
-  "license": "MIT"
-}
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "@types/yargs": "^17.0.35",
+    "typescript": "^6.0.2",
+    "vite": "^8.0.2",
+    "vitest": "^4.1.1"
+  }
+}

package/bin/cli.js

@@ -1,52 +0,0 @@
-#!/usr/bin/env node
-
-const { transformFile } = require('../src/index');
-const yargs = require('yargs/yargs');
-const { hideBin } = require('yargs/helpers');
-
-async function run() {
-  const argv = yargs(hideBin(process.argv))
-    .usage('Usage: stencil <path> [options]')
-    
-    // Local Installation Example
-    .example(
-      'npx stencil path/to/file.py --start 2 --end 10',
-      'Transform only lines 2-10 (local installation)\n'
-    )
-    
-    // Global Installation Example
-    .example(
-      'stencil path/to/file.py --start 2 --end 10',
-      'Transform only lines 2-10 (global installation)'
-    )
-
-    .option('start', {
-      alias: 's',
-      type: 'number',
-      default: null,
-      describe: 'Start line number for transformation'
-    })
-    .option('end', {
-      alias: 'e',
-      type: 'number',
-      default: null,
-      describe: 'End line number for transformation'
-    })
-    .demandCommand(1, 'Please provide the path to the file you wish to transform.')
-    .help('h')
-    .alias('h', 'help')
-    .argv;
-
-  const filePath = argv._[0];
-  const { start, end } = argv;
-
-  try {
-    const transformedCode = await transformFile(filePath, { startLine: start, endLine: end });
-    console.log(transformedCode);
-  } catch (error) {
-    console.error('Error:', error.message);
-    process.exit(1);
-  }
-}
-
-run();

package/src/index.js

@@ -1,60 +0,0 @@
-const fs = require('fs');
-const readline = require('readline');
-
-async function transformFile(filePath, options = {}) {
-  const { startLine = null, endLine = null } = options;
-
-  // Check if file exists
-  if (!fs.existsSync(filePath)) {
-    throw new Error(`File not found: ${filePath}`);
-  }
-
-  // Create readable stream with UTF-8 encoding
-  const fileStream = fs.createReadStream(filePath, { encoding: 'utf-8' });
-
-  // Handle stream errors
-  fileStream.on('error', (err) => {
-    throw new Error(`Unable to read file: ${err.message}`);
-  });
-
-  // Create interface for reading the file line by line
-  const rl = readline.createInterface({
-    input: fileStream,
-    crlfDelay: Infinity
-  });
-
-  let currentLine = 0;
-  let transformedLines = [];
-
-  for await (const line of rl) {
-    currentLine++;
-
-    // Determine if the current line should be transformed
-    if (
-      (startLine === null || currentLine >= startLine) &&
-      (endLine === null || currentLine <= endLine)
-    ) {
-      transformedLines.push(transformLine(line));
-    } else {
-      transformedLines.push(line);
-    }
-  }
-
-  return transformedLines.join('\n');
-}
-
-function transformLine(line) {
-  // 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
-  // '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
-  });
-}
-
-module.exports = {
-  transformFile,
-  transformLine
-};