Skip to content

Commit a3105a5

Browse files
MetroxeMetroxe
committed
Merge branch '#136'
2 parents 5c6a188 + 2111876 commit a3105a5

File tree

94 files changed

+1449
-665
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+1449
-665
lines changed

‎.github/pull_request_template.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,10 @@
22
- [ ] You wrote all of your code in 1 single HTML file.
33
- [ ] Your file is less than 1mb.
44
- [ ] You didn't import any external files (e.g. images, stylesheets or js files).
5-
- [ ] There are no incoming or outgoing network requests.
5+
- [ ] There are no incoming or outgoing network requests.
6+
- [ ] Your HTML file includes the required meta tags in the `<head>` section:
7+
- `<meta name="description" content="Brief description of your entry">`
8+
- `<meta name="author" content="Your Name">`
9+
- `<meta name="github" content="your-github-username">`
10+
11+
**Note:** You do NOT need to edit `entries.js` - it's automatically generated from your HTML meta tags!

‎.github/scripts/generate-entries-json.js‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
const fs = require('fs');
2+
const path = require('path');
3+
const cheerio = require('cheerio');
4+
5+
/**
6+
* Extract metadata from an HTML file
7+
* @param {string} filePath - Path to the HTML file
8+
* @returns {object|null} - Extracted metadata or null if invalid
9+
*/
10+
function extractMetadata(filePath) {
11+
try {
12+
const content = fs.readFileSync(filePath, 'utf8');
13+
const $ = cheerio.load(content);
14+
const filename = path.basename(filePath);
15+
16+
// Extract metadata from meta tags and title
17+
const title = $('meta[name="title"]').attr('content') || $('title').text() || filename.replace(/\.[^/.]+$/, "");
18+
const description = $('meta[name="description"]').attr('content') || '';
19+
const author = $('meta[name="author"]').attr('content') || '';
20+
const github = $('meta[name="github"]').attr('content') || '';
21+
22+
// Extract compatible browsers if specified
23+
const compatibleBrowsersContent = $('meta[name="compatible-browsers"]').attr('content');
24+
let compatibleBrowsers = [];
25+
if (compatibleBrowsersContent) {
26+
compatibleBrowsers = compatibleBrowsersContent.split(',').map(b => b.trim()).filter(b => b);
27+
}
28+
29+
// Build entry object
30+
const entry = {
31+
title: title.trim(),
32+
filename: filename
33+
};
34+
35+
if (description) entry.description = description.trim();
36+
if (author) entry.author = author.trim();
37+
if (github) entry.github = github.trim();
38+
if (compatibleBrowsers.length > 0) entry.compatibleBrowsers = compatibleBrowsers;
39+
40+
return entry;
41+
} catch (error) {
42+
console.error(`Error processing ${filePath}:`, error.message);
43+
return null;
44+
}
45+
}
46+
47+
/**
48+
* Generate entries.js from all HTML files in the entries directory
49+
*/
50+
function generateEntriesJs() {
51+
const entriesDir = 'entries';
52+
53+
if (!fs.existsSync(entriesDir)) {
54+
console.error('Entries directory not found');
55+
process.exit(1);
56+
}
57+
58+
const entries = [];
59+
const files = fs.readdirSync(entriesDir)
60+
.filter(file => file.match(/\.html?$/i))
61+
.sort(); // Sort alphabetically for consistent output
62+
63+
console.log(`Processing ${files.length} HTML files...`);
64+
65+
for (const file of files) {
66+
const filePath = path.join(entriesDir, file);
67+
const metadata = extractMetadata(filePath);
68+
69+
if (metadata) {
70+
entries.push(metadata);
71+
console.log(`✅ ${file}: ${metadata.title}`);
72+
} else {
73+
console.log(`❌ ${file}: Failed to extract metadata`);
74+
}
75+
}
76+
77+
// Sort entries by title for consistency with current entries.js
78+
entries.sort((a, b) => a.title.localeCompare(b.title));
79+
80+
// Write JavaScript file
81+
const jsContent = `/**
82+
* This file is automatically generated from HTML meta tags.
83+
* Last updated: ${new Date().toISOString()}
84+
*
85+
* DO NOT EDIT MANUALLY - Changes will be overwritten!
86+
* To update entries, modify the meta tags in your HTML files.
87+
*/
88+
89+
const entries = ${JSON.stringify(entries, null, 2)};`;
90+
91+
const jsOutputFile = 'entries.js';
92+
fs.writeFileSync(jsOutputFile, jsContent, 'utf8');
93+
94+
console.log(`\n✅ Generated ${jsOutputFile} with ${entries.length} entries`);
95+
96+
// Log any files missing metadata
97+
const missingMetadata = files.filter(file => {
98+
const filePath = path.join(entriesDir, file);
99+
const metadata = extractMetadata(filePath);
100+
return !metadata || !metadata.title || !metadata.description || !metadata.author;
101+
});
102+
103+
if (missingMetadata.length > 0) {
104+
console.log(`\n⚠️ Files missing complete metadata:`);
105+
missingMetadata.forEach(file => {
106+
const filePath = path.join(entriesDir, file);
107+
const metadata = extractMetadata(filePath);
108+
const missing = [];
109+
if (!metadata || !metadata.title) missing.push('title');
110+
if (!metadata || !metadata.description) missing.push('description');
111+
if (!metadata || !metadata.author) missing.push('author');
112+
console.log(` ${file}: missing ${missing.join(', ')}`);
113+
});
114+
}
115+
}
116+
117+
// Run the generator
118+
generateEntriesJs();

‎.github/scripts/update-entries-meta-tags.js‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
const fs = require('fs');
2+
const path = require('path');
3+
const cheerio = require('cheerio');
4+
5+
// Read and parse the original entries.js file to get the metadata
6+
function getOriginalEntries() {
7+
try {
8+
const entriesContent = fs.readFileSync('entries.js', 'utf8');
9+
10+
// Extract the entries array using regex
11+
const entriesMatch = entriesContent.match(/const\s+entries\s*=\s*(\[[\s\S]*?\]);/);
12+
if (!entriesMatch) {
13+
throw new Error('Could not find entries array in entries.js');
14+
}
15+
16+
// Use Function constructor to safely evaluate the array
17+
const entriesArrayString = entriesMatch[1];
18+
const entries = new Function('return ' + entriesArrayString)();
19+
20+
return entries;
21+
} catch (error) {
22+
console.error('Error reading entries.js:', error.message);
23+
return [];
24+
}
25+
}
26+
27+
// Add meta tags to HTML content using surgical string manipulation
28+
function addMetaTags(content, entry) {
29+
// First check what's missing using cheerio for parsing only
30+
const $ = cheerio.load(content);
31+
32+
const hasTitle = $('title').length > 0;
33+
const hasMetaTitle = $('meta[name="title"]').length > 0;
34+
const hasDescription = $('meta[name="description"]').length > 0;
35+
const hasAuthor = $('meta[name="author"]').length > 0;
36+
const hasGithub = $('meta[name="github"]').length > 0;
37+
const hasCompatibleBrowsers = $('meta[name="compatible-browsers"]').length > 0;
38+
const hasViewport = $('meta[name="viewport"]').length > 0;
39+
const hasHead = $('head').length > 0;
40+
41+
// Build list of meta tags to add
42+
const metaTags = [];
43+
44+
// Add comment explaining the addition
45+
metaTags.push(' <!-- Meta tags added due to entries.js deprecation on July 8th, 2025 -->');
46+
47+
// Add viewport if missing (best practice)
48+
if (!hasViewport) {
49+
metaTags.push(' <meta name="viewport" content="width=device-width, initial-scale=1.0">');
50+
}
51+
52+
// Don't add title meta tag if title element exists
53+
if (entry.title && !hasTitle && !hasMetaTitle) {
54+
metaTags.push(` <meta name="title" content="${escapeHtml(entry.title)}">`);
55+
}
56+
57+
// Add description if missing
58+
if (entry.description && !hasDescription) {
59+
metaTags.push(` <meta name="description" content="${escapeHtml(entry.description)}">`);
60+
}
61+
62+
// Add author if missing
63+
if (entry.author && !hasAuthor) {
64+
metaTags.push(` <meta name="author" content="${escapeHtml(entry.author)}">`);
65+
}
66+
67+
// Add github if missing
68+
if (entry.github && !hasGithub) {
69+
metaTags.push(` <meta name="github" content="${escapeHtml(entry.github)}">`);
70+
}
71+
72+
// Add compatible browsers if missing
73+
if (entry.compatibleBrowsers && entry.compatibleBrowsers.length > 0 && !hasCompatibleBrowsers) {
74+
const browsers = entry.compatibleBrowsers.join(', ');
75+
metaTags.push(` <meta name="compatible-browsers" content="${escapeHtml(browsers)}">`);
76+
}
77+
78+
// If nothing to add, return original content
79+
if (metaTags.length <= 1) { // Only comment, no actual meta tags
80+
return content;
81+
}
82+
83+
let updatedContent = content;
84+
85+
if (!hasHead) {
86+
// Create head section after opening html tag or at the beginning
87+
const htmlTagMatch = updatedContent.match(/(<html[^>]*>)/i);
88+
if (htmlTagMatch) {
89+
const insertPos = htmlTagMatch.index + htmlTagMatch[0].length;
90+
const headSection = `\n<head>\n${metaTags.join('\n')}\n</head>`;
91+
updatedContent = updatedContent.slice(0, insertPos) + headSection + updatedContent.slice(insertPos);
92+
} else {
93+
// No html tag, add head at the beginning
94+
const headSection = `<head>\n${metaTags.join('\n')}\n</head>\n`;
95+
updatedContent = headSection + updatedContent;
96+
}
97+
} else {
98+
// Find head tag and insert after it
99+
const headTagMatch = updatedContent.match(/(<head[^>]*>)/i);
100+
if (headTagMatch) {
101+
const insertPos = headTagMatch.index + headTagMatch[0].length;
102+
const insertion = `\n${metaTags.join('\n')}`;
103+
updatedContent = updatedContent.slice(0, insertPos) + insertion + updatedContent.slice(insertPos);
104+
}
105+
}
106+
107+
return updatedContent;
108+
}
109+
110+
// Simple HTML escape function
111+
function escapeHtml(text) {
112+
const map = {
113+
'&': '&amp;',
114+
'<': '&lt;',
115+
'>': '&gt;',
116+
'"': '&quot;',
117+
"'": '&#039;'
118+
};
119+
120+
return text.replace(/[&<>"']/g, function(m) { return map[m]; });
121+
}
122+
123+
// Update all entry files with meta tags
124+
function updateAllEntries() {
125+
const originalEntries = getOriginalEntries();
126+
if (originalEntries.length === 0) {
127+
console.error('No entries found in entries.js');
128+
return;
129+
}
130+
131+
console.log(`Found ${originalEntries.length} entries in entries.js`);
132+
133+
let updatedCount = 0;
134+
let skippedCount = 0;
135+
136+
for (const entry of originalEntries) {
137+
const filePath = path.join('entries', entry.filename);
138+
139+
if (!fs.existsSync(filePath)) {
140+
console.log(`❌ File not found: ${entry.filename}`);
141+
continue;
142+
}
143+
144+
try {
145+
const originalContent = fs.readFileSync(filePath, 'utf8');
146+
const updatedContent = addMetaTags(originalContent, entry);
147+
148+
// Only write if content changed
149+
if (originalContent !== updatedContent) {
150+
fs.writeFileSync(filePath, updatedContent, 'utf8');
151+
console.log(`✅ Updated: ${entry.filename}`);
152+
updatedCount++;
153+
} else {
154+
console.log(`⏭️ Skipped: ${entry.filename} (already has meta tags)`);
155+
skippedCount++;
156+
}
157+
} catch (error) {
158+
console.error(`❌ Error updating ${entry.filename}:`, error.message);
159+
}
160+
}
161+
162+
console.log(`\n📊 Summary:`);
163+
console.log(` Updated: ${updatedCount} files`);
164+
console.log(` Skipped: ${skippedCount} files`);
165+
console.log(` Total: ${originalEntries.length} files`);
166+
}
167+
168+
// Run the update
169+
updateAllEntries();

‎.github/scripts/validate-entries.js‎

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -144,26 +144,38 @@ function validateNoNetworkRequests(content) {
144144
return issues;
145145
}
146146

147-
// Validate entry exists in entries.js
148-
function validateEntryInManifest(filename) {
149-
try {
150-
const entriesContent = fs.readFileSync('entries.js', 'utf8');
151-
152-
// Extract the entries array
153-
const entriesMatch = entriesContent.match(/const\s+entries\s*=\s*\[([\s\S]*?)\];/);
154-
if (!entriesMatch) {
155-
return ['Could not parse entries.js file'];
156-
}
157-
158-
// Check if filename exists in the entries
159-
if (!entriesContent.includes(`"${filename}"`)) {
160-
return [`Entry not found in entries.js. Please add an entry for ${filename}`];
161-
}
162-
163-
return [];
164-
} catch (error) {
165-
return [`Error reading entries.js: ${error.message}`];
147+
// Validate required meta tags exist in HTML
148+
function validateRequiredMetaTags(content) {
149+
const issues = [];
150+
const $ = cheerio.load(content);
151+
152+
// Check for title (can be from meta tag or title element)
153+
const metaTitle = $('meta[name="title"]').attr('content');
154+
const titleElement = $('title').text();
155+
156+
if (!metaTitle && !titleElement) {
157+
issues.push('Missing title: Add either <meta name="title" content="Your Title"> or <title>Your Title</title>');
158+
}
159+
160+
// Check for description
161+
const description = $('meta[name="description"]').attr('content');
162+
if (!description) {
163+
issues.push('Missing description: Add <meta name="description" content="Brief description of your entry">');
164+
}
165+
166+
// Check for author
167+
const author = $('meta[name="author"]').attr('content');
168+
if (!author) {
169+
issues.push('Missing author: Add <meta name="author" content="Your Name">');
166170
}
171+
172+
// GitHub username is optional but recommended
173+
const github = $('meta[name="github"]').attr('content');
174+
if (!github) {
175+
issues.push('Recommended: Add <meta name="github" content="your-github-username"> to link to your profile');
176+
}
177+
178+
return issues;
167179
}
168180

169181
// Validate HTML syntax and structure
@@ -232,8 +244,8 @@ function validateEntry(filePath) {
232244
// 5. Validate no network requests
233245
issues.push(...validateNoNetworkRequests(content));
234246

235-
// 6. Validate entry exists in entries.js
236-
issues.push(...validateEntryInManifest(filename));
247+
// 6. Validate required meta tags
248+
issues.push(...validateRequiredMetaTags(content));
237249

238250
return issues;
239251
}

0 commit comments

Comments
 (0)