extension-create 3.14.5 → 3.15.0-next.1

package/dist/module.cjs

@@ -635,78 +635,30 @@ async function findManifestJsonPath(projectPath) {
     }
     throw new Error(`Could not locate manifest.json under ${projectPath}. Checked common paths and searched up to depth ${manifestSearchMaxDepth}.`);
 }
-async function writeReadmeFile(projectPath, projectName, logger) {
+async function pathExists(target) {
     try {
-        await promises_namespaceObject.access(external_path_namespaceObject.join(projectPath, 'README.md'));
-        return;
-    } catch  {}
-    const initTemplateReadme = `
-<a href="https://extension.js.org" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Powered%20by%20%7C%20Extension.js-0971fe" alt="Powered by Extension.js" align="right" /></a>
-
-# [projectName]
-
-> [templateDescription]
-
-This project was created with Extension.js. Use the commands below to run and build it.
-
-## Installation
-
-\`\`\`bash
-[runCommand] create <project-name>
-cd <project-name>
-npm install
-\`\`\`
-
-For a different starter, add \`--template=<slug>\` (see the [templates](https://extension.js.org/docs/getting-started/templates) docs).
-
-## Commands
-
-### dev
-
-Run the extension in development mode. You can target a specific browser using the
-\`--browser <browser>\` flag. Supported values: \`chrome\`, \`firefox\`, \`edge\`.
-
-\`\`\`bash
-[runCommand] dev --browser chrome
-# or
-[runCommand] dev --browser firefox
-# or
-[runCommand] dev --browser edge
-\`\`\`
-
-### build
-
-Build the extension for production. Use \`--browser <browser>\` to select a target.
-
-\`\`\`bash
-[runCommand] build (defaults to Chrome)
-# or use convenience scripts
-[runCommand] build:firefox (Firefox)
-[runCommand] build:edge (Edge)
-\`\`\`
-
-### Preview
-
-Preview the extension in the browser.
-
-\`\`\`bash
-[runCommand] preview
-\`\`\`
-
-## Learn more
-
-Learn more in the [Extension.js docs](https://extension.js.org).
-  `;
+        await promises_namespaceObject.access(target);
+        return true;
+    } catch  {
+        return false;
+    }
+}
+async function writeReadmeFile(projectPath, projectName, logger) {
     const installCommand = await getInstallCommand();
     const manifestJsonPath = await findManifestJsonPath(projectPath);
     const manifestJson = JSON.parse(await promises_namespaceObject.readFile(manifestJsonPath, 'utf-8'));
-    const readmeFileEdited = initTemplateReadme.replaceAll('[projectName]', projectName).replaceAll("[templateDescription]", manifestJson.description).replaceAll('[runCommand]', installCommand);
+    const description = String(manifestJson.description || '').trim();
+    const screenshotPath = external_path_namespaceObject.join(projectPath, 'public', 'screenshot.png');
+    const hasScreenshot = await pathExists(screenshotPath);
+    const screenshotEmbed = hasScreenshot ? `\n![screenshot](./public/screenshot.png)\n` : '';
+    const blockquote = description ? `> ${description}\n\n` : '';
+    const readme = `<a href="https://extension.js.org" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Powered%20by%20%7C%20Extension.js-0971fe" alt="Powered by Extension.js" align="right" /></a>\n\n# ${projectName}\n\n` + blockquote + `${screenshotEmbed}` + `## Commands\n` + `\n` + `### dev\n` + `\n` + "Run the extension in development mode. Target a browser with `--browser`:\n" + `\n` + "```bash\n" + `${installCommand} run dev\n` + `${installCommand} run dev -- --browser=firefox\n` + `${installCommand} run dev -- --browser=edge\n` + "```\n" + `\n` + `### build\n` + `\n` + `Build for production. Convenience scripts target each browser:\n` + `\n` + "```bash\n" + `${installCommand} run build           # Chrome (default)\n` + `${installCommand} run build:firefox\n` + `${installCommand} run build:edge\n` + "```\n" + `\n` + `### preview\n` + `\n` + `Preview the production build in the browser:\n` + `\n` + "```bash\n" + `${installCommand} run preview\n` + "```\n" + `\n` + `## Learn more\n` + `\n` + `[Extension.js docs](https://extension.js.org).\n`;
     try {
         logger.log(writingReadmeMetaData());
         await promises_namespaceObject.mkdir(projectPath, {
             recursive: true
         });
-        await promises_namespaceObject.writeFile(external_path_namespaceObject.join(projectPath, 'README.md'), readmeFileEdited);
+        await promises_namespaceObject.writeFile(external_path_namespaceObject.join(projectPath, 'README.md'), readme);
     } catch (error) {
         logger.error(writingReadmeMetaDataEError(projectName, error));
         throw error;

package/package.json

@@ -24,7 +24,7 @@
     "dist"
   ],
   "name": "extension-create",
-  "version": "3.14.5",
+  "version": "3.15.0-next.1",
   "description": "The standalone extension creation engine for Extension.js",
   "author": {
     "name": "Cezar Augusto",
@@ -81,7 +81,7 @@
   "devDependencies": {
     "@biomejs/biome": "^2.2.4",
     "@changesets/cli": "^2.29.8",
-    "@rslib/core": "^0.19.4",
+    "@rslib/core": "^0.21.3",
     "@types/adm-zip": "^0.5.7",
     "@types/chrome": "^0.1.33",
     "@types/cross-spawn": "^6.0.6",