create-typescript-app 2.26.7 → 2.28.0

package/lib/blocks/blockVitest.d.ts

@@ -16,6 +16,7 @@ declare const blockVitest: bingo_stratum.BlockWithAddons<{
         uses: string;
     }))[];
     flags: string[];
+    environment?: string | undefined;
 }, {
     access: "public" | "restricted";
     description: string;

package/lib/blocks/blockVitest.js

@@ -39,6 +39,7 @@ const blockVitest = base.createBlock({
   addons: {
     actionSteps: z.array(zActionStep).default([]),
     coverage: zCoverage.default({}),
+    environment: z.string().optional(),
     exclude: zExclude.default([]),
     flags: z.array(z.string()).default([])
   },
@@ -66,7 +67,7 @@ const blockVitest = base.createBlock({
     };
   },
   produce({ addons }) {
-    const { actionSteps, coverage, exclude = [] } = addons;
+    const { actionSteps, coverage, environment, exclude = [] } = addons;
     const excludeText = JSON.stringify(
       Array.from(/* @__PURE__ */ new Set(["node_modules", ...exclude])).sort()
     );
@@ -227,7 +228,8 @@ export default defineConfig({
 			${coverage.exclude?.length ? `exclude: ${JSON.stringify(coverage.exclude)},
 			` : ""}include: ${JSON.stringify(coverage.include)},
 			reporter: ["html", "lcov"],
-		},
+		},${environment ? `
+		environment: "${environment}",` : ""}
 		exclude: [${excludeText.slice(1, excludeText.length - 1)}],
 		setupFiles: ["console-fail-test/setup"],
 	},

package/lib/blocks/blockWebExt.d.ts

@@ -0,0 +1,72 @@
+import * as bingo_stratum from 'bingo-stratum';
+
+declare const blockWebExt: bingo_stratum.BlockWithoutAddons<{
+    access: "public" | "restricted";
+    description: string;
+    directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+            explainer?: string | undefined;
+            footnotes?: string | undefined;
+        };
+        development?: string | undefined;
+    };
+    email: {
+        github: string;
+        npm: string;
+    };
+    title: string;
+    node: {
+        minimum: string;
+        pinned?: string | undefined;
+    };
+    owner: string;
+    repository: string;
+    type?: "commonjs" | "module" | undefined;
+    author?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
+    contributors?: {
+        avatar_url: string;
+        contributions: string[];
+        login: string;
+        name: string;
+        profile: string;
+    }[] | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
+    funding?: string | undefined;
+    guide?: {
+        href: string;
+        title: string;
+    } | undefined;
+    keywords?: string[] | undefined;
+    logo?: {
+        alt: string;
+        src: string;
+        height?: number | undefined;
+        width?: number | undefined;
+    } | undefined;
+    packageData?: {
+        dependencies?: Record<string, string> | undefined;
+        devDependencies?: Record<string, string> | undefined;
+        peerDependencies?: Record<string, string> | undefined;
+        peerDependenciesMeta?: Record<string, unknown> | undefined;
+        scripts?: Record<string, string> | undefined;
+    } | undefined;
+    pnpm?: string | undefined;
+    rulesetId?: string | undefined;
+    version?: string | undefined;
+    words?: string[] | undefined;
+    workflowsVersions?: Record<string, Record<string, {
+        pinned?: boolean | undefined;
+        hash?: string | undefined;
+    }>> | undefined;
+}>;
+
+export { blockWebExt };

package/lib/blocks/blockWebExt.js

@@ -0,0 +1,124 @@
+import { base } from "../base.js";
+import { blockCSpell } from "./blockCSpell.js";
+import { blockDevelopmentDocs } from "./blockDevelopmentDocs.js";
+import { blockGitHubActionsCI } from "./blockGitHubActionsCI.js";
+import { blockGitignore } from "./blockGitignore.js";
+import { blockMarkdownlint } from "./blockMarkdownlint.js";
+import { blockPackageJson } from "./blockPackageJson.js";
+import { blockPrettier } from "./blockPrettier.js";
+const blockWebExt = base.createBlock({
+  about: {
+    name: "Web-ext"
+  },
+  produce() {
+    return {
+      addons: [
+        blockCSpell({
+          ignores: ["assets"]
+        }),
+        blockDevelopmentDocs({
+          sections: {
+            Building: {
+              contents: `
+Run [ESBuild](https://esbuild.github.io) locally to build source files:
+
+\`\`\`shell
+pnpm dev
+\`\`\`
+
+Add \`--watch\` to run the builder in a watch mode that continuously re-builds as you save files:
+
+\`\`\`shell
+pnpm dev --watch
+\`\`\`
+`,
+              innerSections: [
+                {
+                  contents: `
+Follow Google Chrome's _[Load an unpacked extension](https://developer.chrome.com/docs/extensions/mv3/getstarted/#unpacked)_ guide to load this repository's directory as an extension locally.
+
+> \u267B\uFE0F Remember to reload the extension in \`chrome://extensions\` whenever you make changes locally!
+`,
+                  heading: "Local Development with Chrome"
+                },
+                {
+                  contents: `
+Follow Firefox's _[Temporary installation in Firefox](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/)_ guide to load this repository's directory as an extension locally.
+
+You'll then need to authorize the extension to run on <https://github.com>:
+
+1. Find and select the _Extensions_ icon in the top right of Firefox
+2. Select the _"Manage Extension"_ gear icon next to _Refined Saved Replies_
+3. Select the _"Always Allow on github.com"_ option
+
+> \u267B\uFE0F Remember to reload the extension in \`about:debugging#/runtime/this-firefox\` whenever you make changes locally!
+`,
+                  heading: "Local Development with Firefox"
+                },
+                {
+                  contents: `
+Run [\`web-ext\`](https://extensionworkshop.com) to build a production-ready \`.zip\` under \`./web-ext-artifacts/\`:
+
+\`\`\`shell
+pnpm build
+\`\`\`
+
+Then upload that \`./web-ext-artifacts/refined_saved_replies-*.zip\` file to:
+
+- [Chrome Web Store Developer Dashboard](https://chrome.google.com/webstore/devconsole)
+- [Firefox Add-ons Developer Hub](https://addons.mozilla.org/en-US/developers/addon/submit/distribution)
+`,
+                  heading: "Production Builds"
+                }
+              ]
+            },
+            Linting: {
+              contents: {
+                items: [
+                  `- \`pnpm lint:web-ext\` ([web-ext](https://extensionworkshop.com)): Lints browser extension metadata after \`pnpm dev\` creates local files`
+                ]
+              }
+            }
+          }
+        }),
+        blockGitHubActionsCI({
+          jobs: [
+            {
+              name: "Build",
+              steps: [{ run: "pnpm build" }]
+            },
+            {
+              name: "Lint Web-ext",
+              steps: [{ run: "pnpm dev" }, { run: "pnpm lint:web-ext" }]
+            }
+          ]
+        }),
+        blockGitignore({
+          ignores: ["*.zip", "web-ext-artifacts"]
+        }),
+        blockMarkdownlint({
+          ignores: ["assets/"]
+        }),
+        blockPackageJson({
+          properties: {
+            devDependencies: {
+              esbuild: "^0.25.0",
+              "web-ext": "^8.3.0"
+            },
+            scripts: {
+              build: "web-ext build --overwrite-dest",
+              dev: "esbuild src/content-script.ts --bundle --minify --outfile=lib/content-script.js --sourcemap",
+              "lint:web-ext": "web-ext lint"
+            }
+          }
+        }),
+        blockPrettier({
+          ignores: ["assets/"]
+        })
+      ]
+    };
+  }
+});
+export {
+  blockWebExt
+};

package/lib/blocks/index.d.ts

@@ -46,6 +46,7 @@ export { blockTSup } from './blockTSup.js';
 export { blockTypeScript } from './blockTypeScript.js';
 export { blockVitest } from './blockVitest.js';
 export { blockVSCode } from './blockVSCode.js';
+export { blockWebExt } from './blockWebExt.js';
 import 'zod';
 
 declare const blocks: {
@@ -3349,6 +3350,7 @@ declare const blocks: {
             uses: string;
         }))[];
         flags: string[];
+        environment?: string | undefined;
     }, {
         access: "public" | "restricted";
         description: string;
@@ -3494,6 +3496,74 @@ declare const blocks: {
             hash?: string | undefined;
         }>> | undefined;
     }>;
+    blockWebExt: bingo_stratum.BlockWithoutAddons<{
+        access: "public" | "restricted";
+        description: string;
+        directory: string;
+        documentation: {
+            readme: {
+                usage: string;
+                additional?: string | undefined;
+                explainer?: string | undefined;
+                footnotes?: string | undefined;
+            };
+            development?: string | undefined;
+        };
+        email: {
+            github: string;
+            npm: string;
+        };
+        title: string;
+        node: {
+            minimum: string;
+            pinned?: string | undefined;
+        };
+        owner: string;
+        repository: string;
+        type?: "commonjs" | "module" | undefined;
+        author?: string | undefined;
+        bin?: string | Record<string, string> | undefined;
+        contributors?: {
+            avatar_url: string;
+            contributions: string[];
+            login: string;
+            name: string;
+            profile: string;
+        }[] | undefined;
+        emoji?: string | undefined;
+        existingLabels?: {
+            name: string;
+            description: string;
+            color: string;
+        }[] | undefined;
+        funding?: string | undefined;
+        guide?: {
+            href: string;
+            title: string;
+        } | undefined;
+        keywords?: string[] | undefined;
+        logo?: {
+            alt: string;
+            src: string;
+            height?: number | undefined;
+            width?: number | undefined;
+        } | undefined;
+        packageData?: {
+            dependencies?: Record<string, string> | undefined;
+            devDependencies?: Record<string, string> | undefined;
+            peerDependencies?: Record<string, string> | undefined;
+            peerDependenciesMeta?: Record<string, unknown> | undefined;
+            scripts?: Record<string, string> | undefined;
+        } | undefined;
+        pnpm?: string | undefined;
+        rulesetId?: string | undefined;
+        version?: string | undefined;
+        words?: string[] | undefined;
+        workflowsVersions?: Record<string, Record<string, {
+            pinned?: boolean | undefined;
+            hash?: string | undefined;
+        }>> | undefined;
+    }>;
 };
 
 export { blocks };

package/lib/blocks/index.js

@@ -44,6 +44,7 @@ import { blockTSup } from "./blockTSup.js";
 import { blockTypeScript } from "./blockTypeScript.js";
 import { blockVitest } from "./blockVitest.js";
 import { blockVSCode } from "./blockVSCode.js";
+import { blockWebExt } from "./blockWebExt.js";
 const blocks = {
   blockAllContributors,
   blockAreTheTypesWrong,
@@ -90,7 +91,8 @@ const blocks = {
   blockTSup,
   blockTypeScript,
   blockVitest,
-  blockVSCode
+  blockVSCode,
+  blockWebExt
 };
 import { blockAllContributors as blockAllContributors2 } from "./blockAllContributors.js";
 import { blockAreTheTypesWrong as blockAreTheTypesWrong2 } from "./blockAreTheTypesWrong.js";
@@ -139,6 +141,7 @@ import { blockTSup as blockTSup2 } from "./blockTSup.js";
 import { blockTypeScript as blockTypeScript2 } from "./blockTypeScript.js";
 import { blockVitest as blockVitest2 } from "./blockVitest.js";
 import { blockVSCode as blockVSCode2 } from "./blockVSCode.js";
+import { blockWebExt as blockWebExt2 } from "./blockWebExt.js";
 export {
   blockAllContributors2 as blockAllContributors,
   blockAreTheTypesWrong2 as blockAreTheTypesWrong,
@@ -187,5 +190,6 @@ export {
   blockTypeScript2 as blockTypeScript,
   blockVSCode2 as blockVSCode,
   blockVitest2 as blockVitest,
+  blockWebExt2 as blockWebExt,
   blocks
 };

package/lib/data/packageData.d.ts

@@ -1,5 +1,5 @@
 var name = "create-typescript-app";
-var version = "2.26.6";
+var version = "2.27.0";
 var description = "Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 🎁";
 var repository = {
 	type: "git",

package/lib/index.d.ts

@@ -53,6 +53,7 @@ export { blockTSup } from './blocks/blockTSup.js';
 export { blockTypeScript } from './blocks/blockTypeScript.js';
 export { blockVitest } from './blocks/blockVitest.js';
 export { blockVSCode } from './blocks/blockVSCode.js';
+export { blockWebExt } from './blocks/blockWebExt.js';
 export { presetCommon } from './presets/common.js';
 export { presetEverything } from './presets/everything.js';
 export { presetMinimal } from './presets/minimal.js';

package/lib/template.js

@@ -5,6 +5,7 @@ import { blockESLintPlugin } from "./blocks/blockESLintPlugin.js";
 import { blockNcc } from "./blocks/blockNcc.js";
 import { blockRemoveDependencies } from "./blocks/blockRemoveDependencies.js";
 import { blockRemoveFiles } from "./blocks/blockRemoveFiles.js";
+import { blockWebExt } from "./blocks/blockWebExt.js";
 import { presetCommon } from "./presets/common.js";
 import { presetEverything } from "./presets/everything.js";
 import { presetMinimal } from "./presets/minimal.js";
@@ -22,7 +23,8 @@ const template = base.createStratumTemplate({
     blockESLintPlugin,
     blockNcc,
     blockRemoveDependencies,
-    blockRemoveFiles
+    blockRemoveFiles,
+    blockWebExt
   ],
   presets: [presetMinimal, presetCommon, presetEverything],
   suggested: presetCommon

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-typescript-app",
-	"version": "2.26.7",
+	"version": "2.28.0",
 	"description": "Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 🎁",
 	"repository": {
 		"type": "git",