@scurrlin/stencil 1.0.0

package/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025 Sean Currlin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,71 @@
+```
+ ▗▄▄▖▗▄▄▄▖▗▄▄▄▖▗▖  ▗▖ ▗▄▄▖▗▄▄▄▖▗▖   
+▐▌     █  ▐▌   ▐▛▚▖▐▌▐▌     █  ▐▌   
+ ▝▀▚▖  █  ▐▛▀▀▘▐▌ ▝▜▌▐▌     █  ▐▌   
+▗▄▄▞▘  █  ▐▙▄▄▖▐▌  ▐▌▝▚▄▄▖▗▄█▄▖▐▙▄▄▖
+
+```
+
+## Overview
+
+Whether you are studying for technical interviews, or just starting your coding journey, pattern recognition and memorization are absolutely necessary. It doesn't take a valedictorian to figure that out, but how exactly are you supposed to do that? Between data structures, algorithms, and design patterns, the task of incrementally committing enough of that information to memory can feel impossible. You could spend hours studying fully implemented algorithms only to draw a blank when staring at an empty code editor.
+
+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 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 to fully memorized. Below is an example of Stencil in action using LeetCode problem 217 "Contains Duplicate":
+
+## Example
+
+Solution
+
+```python
+class Solution:
+    def containsDuplicate(self, nums: List[int]) -> bool:
+        nums.sort()
+        n = len(nums)
+        for i in range(1, n):
+            if nums[i] == nums[i - 1]:
+                return True
+        return False
+```
+
+Solution with Stencil
+
+```python
+c S:
+    d c(s, n: L[i]) -> b:
+        n.s()
+        n = l(n)
+        f i i r(1, n):
+            i n[i] == n[i - 1]:
+                r T
+        r F
+```
+
+## Local Installation
+
+To install **Stencil** locally, run the following command in the terminal of your directory:
+
+```bash
+npm install stencil
+```
+
+Once installed, you can run it with the following command:
+
+```bash
+npx stencil path/to/your/file.py --start <start_line> --end <end_line>
+```
+
+## Global Installation
+
+If you prefer to install **Stencil** globally, run the following command in your terminal:
+
+```bash
+npm install -g stencil
+```
+
+Once installed, you can run it with the following command:
+
+```bash
+stencil path/to/your/file.py --start <start_line> --end <end_line>
+```

package/bin/cli.js

@@ -0,0 +1,52 @@
+#!/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/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@scurrlin/stencil",
+  "version": "1.0.0",
+  "description": "A memorization tool that strips code down to first letters and punctuation only.",
+  "main": "src/index.js",
+  "bin": {
+    "stencil": "./bin/cli.js"
+  },
+  "scripts": {
+    "start": "node bin/cli.js"
+  },
+  "dependencies": {
+    "yargs": "^17.7.2"
+  },
+  "keywords": [
+    "stencil",
+    "memory",
+    "study",
+    "code",
+    "transform"
+  ],
+  "author": "Sean Currlin",
+  "license": "MIT"
+}

package/src/index.js

@@ -0,0 +1,60 @@
+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 an 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) {
+  // Regular expression 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
+  return line.replace(/[\p{L}\p{N}]+/gu, (match) => {
+    return match[0]; // Retain only the first character
+  });
+}
+
+module.exports = {
+  transformFile,
+  transformLine
+};