Merge pull request #8 from soderlind/remove/requires

feat: make Requires at least / Requires PHP optional (0.1.9), fix #4

Author: soderlind

CHANGELOG.md

@@ -12,6 +12,12 @@
 ### Security
 - Addresses code scanning warning related to incomplete string escaping for inline code conversion and emphasis token detection.
 
+## [0.1.9] - 2025-10-27
+### Changed
+- "Requires at least" and "Requires PHP" header fields are now optional. Format validation still applies if provided.
+### Documentation
+- README updated to reflect new optional status of these fields.
+
 
 All notable changes to this project will be documented in this file.
 
@@ -86,6 +92,7 @@ The format is based on Keep a Changelog (https://keepachangelog.com/en/1.0.0/) a
 [0.1.6]: https://github.com/soderlind/wordpress-readme-preview/compare/v0.1.5...v0.1.6
 [0.1.7]: https://github.com/soderlind/wordpress-readme-preview/compare/v0.1.6...v0.1.7
 [0.1.8]: https://github.com/soderlind/wordpress-readme-preview/compare/v0.1.7...v0.1.8
+[0.1.9]: https://github.com/soderlind/wordpress-readme-preview/compare/v0.1.8...v0.1.9
 [0.1.4]: https://github.com/soderlind/wordpress-readme-preview/compare/v0.1.3...v0.1.4
 [0.1.5]: https://github.com/soderlind/wordpress-readme-preview/compare/v0.1.4...v0.1.5
 [0.1.3]: https://github.com/soderlind/wordpress-readme-preview/compare/v0.1.1...v0.1.3

README.md

@@ -62,12 +62,15 @@ A Visual Studio Code extension that provides syntax highlighting, IntelliSense,
 - ✅ Plugin Name (`=== Plugin Name ===`)
 - ✅ Contributors (WordPress.org usernames)
 - ✅ Tags (1-5 recommended tags)
-- ✅ Requires at least (WordPress version)
 - ✅ Tested up to (WordPress version)  
 - ✅ Stable tag (plugin version)
 - ✅ License (GPL-compatible)
 - ✅ Short description (≤150 characters)
 
+Optional (still parsed & format-validated if present):
+- ℹ️ Requires at least (WordPress version)
+- ℹ️ Requires PHP (minimum PHP version)
+
 **Advanced Content Validation:**
 - 🎯 **Precise Error Positioning** - Exact line/column highlighting
 - 🚫 **False Positive Prevention** - Smart detection avoids hallucinated errors

package.json

@@ -2,7 +2,7 @@
 	"name": "wordpress-readme-preview",
 	"displayName": "WordPress Readme",
 	"description": "Preview, validate, and edit WordPress readme.txt files with syntax highlighting, IntelliSense, and accurate rendering",
-	"version": "0.1.8",
+	"version": "0.1.9",
 	"publisher": "persoderlind",
 	"engines": {
 		"vscode": "^1.74.0"

src/parser/readmeParser.ts

@@ -3,10 +3,10 @@ export interface ReadmeHeader {
   contributors: string[];
   donateLink?: string;
   tags: string[];
-  requiresAtLeast: string;
+  requiresAtLeast: string; // now optional (empty string allowed)
   testedUpTo: string;
   stableTag: string;
-  requiresPHP?: string;
+  requiresPHP?: string; // optional
   license: string;
   licenseURI?: string;
   shortDescription: string;
@@ -245,9 +245,7 @@ export class ReadmeParser {
       result.warnings.push('Maximum 5 tags recommended');
     }
 
-    if (!header.requiresAtLeast) {
-      result.errors.push('Requires at least field is required');
-    }
+    // 'Requires at least' no longer mandatory; only validate format if present
 
     if (!header.testedUpTo) {
       result.errors.push('Tested up to field is required');

src/parser/validator.ts

@@ -26,7 +26,6 @@ export class ReadmeValidator {
     'pluginName',
     'contributors',
     'tags',
-    'requiresAtLeast',
     'testedUpTo',
     'stableTag',
     'license',

src/test/validator.test.ts

@@ -11,7 +11,7 @@ const headerLines = [
 	'=== Plugin Name ===',
 	'Contributors: john, jane',
 	'Tags: tag1, tag2',
-	'Requires at least: 1.0',
+	// 'Requires at least' intentionally omitted to confirm optional handling
 	'Tested up to: 6.5',
 	'Stable tag: 1.0.0',
 	'License: GPL',
@@ -67,6 +67,12 @@ describe('ReadmeValidator', () => {
 		expect(r.errors.some(e => /Contributors is required/.test(e.message))).toBe(true);
 	});
 
+	it('does not error when Requires at least is absent', () => {
+		const txt = build(['== Description ==', 'Body']);
+		const r = validate(txt);
+		expect(r.errors.some(e => /Requires at least field is required/.test(e.message))).toBe(false);
+	});
+
 	it('produces high score and no errors on clean input', () => {
 		const txt = build([
 			'== Description ==',