wp-readme-txt-gen 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+- Initial setup of the changelog following Keep a Changelog and Semantic Versioning.

package/README.md

@@ -0,0 +1,37 @@
+# wp-readme-txt-gen
+
+`wp-readme-txt-gen` is an npm module used to convert your `README.md` and `CHANGELOG.md` files into a WordPress style `README.txt`.
+
+## Installation
+
+You can install the module using npm:
+
+```sh
+npm install wp-readme-txt-gen
+```
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+## License
+
+This project is licensed under the MIT License.
+
+## Usage
+
+To use the module, simply run:
+
+```sh
+wp-readme-txt-gen
+```
+
+This will generate a `README.txt` file in the same directory as your `README.md` and `CHANGELOG.md` files.
+
+## Support
+
+If you encounter any issues or have any questions, feel free to open an issue on the GitHub repository.
+
+## Acknowledgements
+
+Thanks to all the contributors who have helped improve this project.

package/index.js

@@ -0,0 +1,75 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const { marked } = require('marked');
+
+// Load configuration from config.json
+async function loadConfig() {
+    const configPath = path.resolve(process.cwd(), 'config.json');
+    const config = JSON.parse(await fs.promises.readFile(configPath, 'utf8'));
+    return config;
+}
+
+// Functions (reusable and modular)
+async function readFileContent(filePath) {
+    return fs.promises.readFile(filePath, 'utf8');
+}
+
+function markdownToWordPressFormat(markdown) {
+    return markdown
+        .replace(/^# (.*$)/gim, '=== $1 ===')
+        .replace(/^## (.*$)/gim, '== $1 ==')
+        .replace(/^### (.*$)/gim, '= $1 =')
+        .replace(/^\* (.*$)/gim, '* $1')
+        .replace(/\[([^\[]+)\]\(([^\)]+)\)/gim, '$1 ($2)');
+}
+
+function removeFirstH1(content) {
+    return content.replace(/^# .*\n/, '');
+}
+
+async function updateStyleFiles(version, styleFiles, versionPattern) {
+    for (const file of styleFiles) {
+        try {
+            const content = await readFileContent(file);
+            const updatedContent = content.replace(new RegExp(versionPattern, 'm'), `$1${version}`);
+            await fs.promises.writeFile(file, updatedContent, 'utf8');
+            console.log(`${file} updated with version ${version}`);
+        } catch (error) {
+            console.error(`Error updating ${file}:`, error);
+        }
+    }
+}
+
+async function generateReadme() {
+    try {
+        const config = await loadConfig();
+
+        const [readmeContent, changelogContent] = await Promise.all([
+            readFileContent(config.readmeMdPath),
+            readFileContent(config.changelogMdPath),
+        ]);
+
+        const version = (readmeContent.match(new RegExp(config.versionPattern, 'm')) || [])[1] || '1.0';
+
+        const readmeFormatted = markdownToWordPressFormat(readmeContent);
+        const changelogFormatted = markdownToWordPressFormat(removeFirstH1(changelogContent));
+        const fullContent = `${readmeFormatted}\n\n== Changelog ==\n${changelogFormatted}`;
+
+        await fs.promises.writeFile(config.readmeTxtPath, fullContent, 'utf8');
+        console.log(`Generated ${config.readmeTxtPath}`);
+
+        await updateStyleFiles(version, config.styleFiles, config.versionReplacementPattern);
+    } catch (error) {
+        console.error('Error in generating README.txt or updating style files:', error);
+    }
+}
+
+// Execute when run from the command line
+if (require.main === module) {
+    generateReadme();
+}
+
+// Export functions for reuse
+module.exports = { generateReadme, updateStyleFiles, markdownToWordPressFormat };

package/package.json

@@ -0,0 +1,18 @@
+{
+  "dependencies": {
+    "marked": "^15.0.0"
+  },
+  "name": "wp-readme-txt-gen",
+  "version": "1.0.0",
+  "description": "`wp-readme-txt-gen` is an npm module used to convert your `README.md` and `CHANGELOG.md` files into a WordPress style `README.txt`.",
+  "main": "index.js",
+  "bin": {
+    "generate-readme": "index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}