repo-anon 0.1.0

package/README.md

@@ -0,0 +1,53 @@
+# repo-anon
+
+A Node.js CLI tool to anonymize and de-anonymize files in a repository based on a `.phrases` configuration file. Perfect for preparing repositories for AI processing while keeping sensitive info, such as company or brand names, protected.
+
+## Features
+
+- **Anonymize**: Replaces sensitive phrases with configured placeholders.
+- **De-anonymize**: Restores original phrases from placeholders.
+- **Recursive**: Traverses through all project directories (ignoring `node_modules`, `.git`, etc.).
+- **CI/CD Ready**: Includes GitLab pipeline configuration for publishing to the GitLab package registry.
+
+## Installation
+
+```bash
+npm install -g @your_gitlab_namespace/repo-anon
+```
+
+*(Note: Replace `@your_gitlab_namespace` with your actual GitLab namespace).*
+
+## Usage
+
+1. Create a `.phrases` file in the current working directory:
+
+   ```json
+   {
+     "CompanyA": "ANON_COMPANY_A", 
+     "BrandX": "ANON_BRAND_X"
+   }
+   ```
+
+2. Run the anonymization command:
+
+   ```bash
+   repo-anon anonymize
+   ```
+
+3. Revert changes (if needed):
+
+   ```bash
+   repo-anon deanonymize
+   ```
+
+## Development
+
+- **Tests**: Run unit tests using `npm test`.
+- **Linting**: Lint the project using `npm run lint`.
+
+## CI/CD Deployment
+
+The project includes a `.gitlab-ci.yml` configured to automatically publish new versions to the GitLab package registry when a tag is pushed.
+
+---
+Built with ❤️.

package/bin/repo-anon.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const { anonymize, deanonymize } = require('./../lib/processor');
+
+program
+  .version('1.0.0')
+  .description('Repository Anonymizer CLI');
+
+program
+  .command('anonymize')
+  .description('Anonymize project based on .phrases file')
+  .action(anonymize);
+
+program
+  .command('deanonymize')
+  .description('De-anonymize project based on .phrases file')
+  .action(deanonymize);
+
+program.parse(process.argv);

package/eslint.config.mjs

@@ -0,0 +1,11 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+
+export default [
+  {
+    languageOptions: {
+      globals: { ...globals.node, ...globals.jest }
+    }
+  },
+  pluginJs.configs.recommended,
+];

package/lib/processor.js

@@ -0,0 +1,65 @@
+const fs = require('fs');
+const path = require('path');
+
+const PHRASES_FILE = '.phrases';
+
+function loadPhrases() {
+  if (!fs.existsSync(PHRASES_FILE)) {
+    throw new Error('No .phrases file found.');
+  }
+  return JSON.parse(fs.readFileSync(PHRASES_FILE, 'utf8'));
+}
+
+function processContent(content, phrases, reverse = false) {
+  let changed = false;
+  let newContent = content;
+
+  for (const [original, placeholder] of Object.entries(phrases)) {
+    const search = reverse ? placeholder : original;
+    const replace = reverse ? original : placeholder;
+    if (newContent.includes(search)) {
+      newContent = newContent.split(search).join(replace);
+      changed = true;
+    }
+  }
+  return changed ? newContent : null;
+}
+
+async function walk(dir, callback) {
+  const files = fs.readdirSync(dir);
+  for (const file of files) {
+    if (['node_modules', '.git', '.phrases', 'package.json', 'package-lock.json', 'bin', 'tests', '.gitlab-ci.yml'].includes(file)) continue;
+    const filePath = path.join(dir, file);
+    if (fs.statSync(filePath).isDirectory()) {
+      await walk(filePath, callback);
+    } else {
+      callback(filePath);
+    }
+  }
+}
+
+async function anonymize() {
+  const phrases = loadPhrases();
+  walk(process.cwd(), (filePath) => {
+    const content = fs.readFileSync(filePath, 'utf8');
+    const newContent = processContent(content, phrases);
+    if (newContent) {
+      fs.writeFileSync(filePath, newContent, 'utf8');
+      console.log(`Updated: ${filePath}`);
+    }
+  });
+}
+
+async function deanonymize() {
+  const phrases = loadPhrases();
+  walk(process.cwd(), (filePath) => {
+    const content = fs.readFileSync(filePath, 'utf8');
+    const newContent = processContent(content, phrases, true);
+    if (newContent) {
+      fs.writeFileSync(filePath, newContent, 'utf8');
+      console.log(`Updated: ${filePath}`);
+    }
+  });
+}
+
+module.exports = { anonymize, deanonymize, processContent };

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "repo-anon",
+  "version": "0.1.0",
+  "description": "CLI tool to anonymize/de-anonymize repositories.",
+  "main": "index.js",
+  "bin": {
+    "repo-anon": "bin/repo-anon.js"
+  },
+  "dependencies": {
+    "commander": "^13.1.0"
+  },
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint ."
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "eslint": "^10.0.2",
+    "globals": "^17.4.0",
+    "jest": "^30.2.0"
+  }
+}

package/tests/processor.test.js

@@ -0,0 +1,27 @@
+const { processContent } = require('../lib/processor');
+
+describe('repo-anon processor', () => {
+    test('should anonymize content', () => {
+        const phrases = { "company": "anon" };
+        const content = "my company is here";
+        const expected = "my anon is here";
+        const result = processContent(content, phrases);
+        expect(result).toBe(expected);
+    });
+
+    test('should deanonymize content', () => {
+        const phrases = { "company": "anon" };
+        const content = "my anon is here";
+        const expected = "my company is here";
+        // reverse = true
+        const result = processContent(content, phrases, true);
+        expect(result).toBe(expected);
+    });
+
+    test('should return null if no change', () => {
+        const phrases = { "company": "anon" };
+        const content = "nothing here";
+        const result = processContent(content, phrases);
+        expect(result).toBeNull();
+    });
+});