Add several tests to templates

.github/workflows/build.yml

@@ -0,0 +1,13 @@
+name: extension:build
+on: push
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install modules
+      run: yarn
+    - name: Run compiler
+      run: yarn compile
+    - name: Run `extenion build` command
+      run: yarn test:build

.github/workflows/cli.yml

@@ -0,0 +1,13 @@
+name: extension:cli
+on: push
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install modules
+      run: yarn
+    - name: Run compiler
+      run: yarn compile
+    - name: Run `extenion` cli without arguments
+      run: yarn test:cli

.github/workflows/create.yml

@@ -0,0 +1,13 @@
+name: extension:create
+on: push
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install modules
+      run: yarn
+    - name: Run compiler
+      run: yarn compile
+    - name: Run extenion create command
+      run: yarn test:create

package.json

@@ -10,6 +10,9 @@
     "lint": "eslint . --config .eslintrc.js",
     "release": "dotenv -- turbo run compile && changeset publish",
     "test": "dotenv -- turbo run test",
+    "test:build": "dotenv -- turbo run test:build",
+    "test:create": "dotenv -- turbo run test:create",
+    "test:cli": "dotenv -- turbo run test:cli",
     "test:watch": "dotenv -- turbo run test:watch",
     "types": "tsc --noEmit --project tsconfig.json",
     "version-packages": "changeset version",

packages/run-chrome-extension/steps/RunChromePlugin/chrome/browser.config.ts

@@ -106,6 +106,8 @@ export default function browserConfig(
     '--disable-features=DialMediaRouteProvider',
     // Don't send hyperlink auditing pings
     '--no-pings',
+    // Ensure the side panel is visible. This is used for testing the side panel feature.
+    '--enable-features=SidePanelUpdates',
 
     // Flags to pass to Chrome
     // Any of http://peter.sh/experiments/chromium-command-line-switches/

programs/cli/cli.ts

@@ -15,15 +15,15 @@ import type {CreateOptions} from '@extension-create/create'
 import type {DevOptions} from '@extension-create/develop/extensionDev'
 import type {StartOptions} from '@extension-create/develop/extensionStart'
 import type {BuildOptions} from '@extension-create/develop/extensionBuild'
-import type {PreviewOptions} from '@extension-create/develop/extensionPreview'
+// import type {PreviewOptions} from '@extension-create/develop/extensionPreview'
 import type {BrowsersSupported} from './types'
 
 // Modules
 import createExtension from '@extension-create/create'
 import {
   extensionDev,
   extensionStart,
-  extensionBuild,
+  extensionBuild
   // extensionPreview
 } from '@extension-create/develop'
 
@@ -34,29 +34,14 @@ import packageJson from './package.json'
 // Before all, check for updates.
 checkUpdates(packageJson)
 
-if (semver.lte(process.version, '18.0.0')) {
-  messages.unsupportedNodeVersion()
-  process.exit(1)
-}
-
 const extensionJs = program
 
-// ███████╗██╗  ██╗████████╗███████╗███╗   ██╗███████╗██╗ ██████╗ ███╗   ██╗
-// ██╔════╝╚██╗██╔╝╚══██╔══╝██╔════╝████╗  ██║██╔════╝██║██╔═══██╗████╗  ██║
-// █████╗   ╚███╔╝    ██║   █████╗  ██╔██╗ ██║███████╗██║██║   ██║██╔██╗ ██║
-// ██╔══╝   ██╔██╗    ██║   ██╔══╝  ██║╚██╗██║╚════██║██║██║   ██║██║╚██╗██║
-// ███████╗██╔╝ ██╗   ██║   ███████╗██║ ╚████║███████║██║╚██████╔╝██║ ╚████║
-// ╚══════╝╚═╝  ╚═╝   ╚═╝   ╚══════╝╚═╝  ╚═══╝╚══════╝╚═╝ ╚═════╝ ╚═╝  ╚═══╝
-//  ██████╗██████╗ ███████╗ █████╗ ████████╗███████╗
-// ██╔════╝██╔══██╗██╔════╝██╔══██╗╚══██╔══╝██╔════╝
-// ██║     ██████╔╝█████╗  ███████║   ██║   █████╗
-// ██║     ██╔══██╗██╔══╝  ██╔══██║   ██║   ██╔══╝
-// ╚██████╗██║  ██║███████╗██║  ██║   ██║   ███████╗
-//  ╚═════╝╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝   ╚═╝   ╚══════╝
-
-if (process.env.EXTENSION_ENV === 'development') {
-  console.log(`Running extension via ${packageJson.name}...`)
-}
+// ███████╗██╗  ██╗████████╗███████╗███╗   ██╗███████╗██╗ ██████╗ ███╗   ██╗        ██╗███████╗
+// ██╔════╝╚██╗██╔╝╚══██╔══╝██╔════╝████╗  ██║██╔════╝██║██╔═══██╗████╗  ██║        ██║██╔════╝
+// █████╗   ╚███╔╝    ██║   █████╗  ██╔██╗ ██║███████╗██║██║   ██║██╔██╗ ██║        ██║███████╗
+// ██╔══╝   ██╔██╗    ██║   ██╔══╝  ██║╚██╗██║╚════██║██║██║   ██║██║╚██╗██║   ██   ██║╚════██║
+// ███████╗██╔╝ ██╗   ██║   ███████╗██║ ╚████║███████║██║╚██████╔╝██║ ╚████║██╗╚█████╔╝███████║
+// ╚══════╝╚═╝  ╚═╝   ╚═╝   ╚══════╝╚═╝  ╚═══╝╚══════╝╚═╝ ╚═════╝ ╚═╝  ╚═══╝╚═╝ ╚════╝ ╚══════╝
 
 extensionJs
   .name(packageJson.name)
@@ -83,45 +68,8 @@ extensionJs
     '-t, --template <template-name>',
     'specify a template for the created project'
   )
-  .action(async function (
-    pathOrRemoteUrl: string,
-    {
-      browser = 'chrome',
-      template,
-      ...otherCommandOptions
-    }: CreateOptions & DevOptions & StartOptions & BuildOptions & PreviewOptions
-  ) {
-    switch (pathOrRemoteUrl) {
-      case 'dev':
-        for (const vendor of vendors(browser)) {
-          await extensionDev(pathOrRemoteUrl, {
-            mode: 'development',
-            browser: vendor as any,
-            ...otherCommandOptions
-          })
-        }
-        break
-      case 'start':
-        for (const vendor of vendors(browser)) {
-          await extensionStart(pathOrRemoteUrl, {
-            mode: 'production',
-            browser: vendor as any,
-            ...otherCommandOptions
-          })
-        }
-        break
-      case 'build':
-        for (const vendor of vendors(browser)) {
-          await extensionBuild(pathOrRemoteUrl, {
-            browser: vendor as any,
-            ...otherCommandOptions
-          })
-        }
-        break
-      default:
-        await createExtension(pathOrRemoteUrl, {template})
-        break
-    }
+  .action(async function (pathOrRemoteUrl: string, {template}: CreateOptions) {
+    await createExtension(pathOrRemoteUrl, {template})
   })
 
 // ██████╗ ███████╗██╗   ██╗

programs/cli/jest.config.js

@@ -1,5 +1,4 @@
 module.exports = {
   preset: 'ts-jest',
-  testEnvironment: 'node',
-  testMatch: ['**/*.spec.ts']
+  testEnvironment: 'node'
 }

programs/cli/package.json

@@ -26,13 +26,17 @@
     "url": "https://cezaraugusto.com"
   },
   "scripts": {
+    "watch": "yarn compile --watch",
     "compile:readme-files": "node ./scripts/copyMarkdownFilesToCli.js",
     "compile:tailwind-config": "node ./scripts/copyTailwindConfig.js",
     "compile:stylelint-config": "node ./scripts/copyStylelintConfig.js",
     "compile:cli": "tsup-node ./cli.ts --format cjs --dts --target=node18",
     "compile": "yarn compile:readme-files && yarn compile:tailwind-config && yarn compile:stylelint-config &&yarn compile:cli",
     "clean": "rm -rf dist",
-    "test": "jest"
+    "before:test": "./spec/fixtures/install-npm-deps-for-fixtures.sh",
+    "test:build": "npm run before:test && jest spec/build.spec.ts",
+    "test:cli": "npm run before:test && jest spec/cli.spec.ts",
+    "test:create": "npm run before:test && jest spec/create.spec.ts"
   },
   "keywords": [
     "zero-config",

programs/cli/spec/build.spec.ts

@@ -0,0 +1,126 @@
+//  ██████╗██╗     ██╗
+// ██╔════╝██║     ██║
+// ██║     ██║     ██║
+// ██║     ██║     ██║
+// ╚██████╗███████╗██║
+//  ╚═════╝╚══════╝╚═╝
+
+import path from 'path'
+import {ALL_TEMPLATES, DEFAULT_TEMPLATE, BROWSERS} from './fixtures/constants'
+import {
+  extensionProgram,
+  distFileExists,
+  removeAllTemplateFolders
+} from './fixtures/helpers'
+
+describe('extension build', () => {
+  beforeEach(async () => {
+    await removeAllTemplateFolders()
+  })
+
+  describe('running built-in templates', () => {
+    it.each(ALL_TEMPLATES)(
+      `builds an extension created via "$name" template`,
+      async (template) => {
+        const extensionPath = path.join(__dirname, 'fixtures', template.name)
+        await extensionProgram(`build ${extensionPath}`)
+
+        // Expect manifest file to exist
+        expect(
+          distFileExists(template.name, BROWSERS[0], 'manifest.json')
+        ).toBeTruthy()
+
+        // TODO: cezaraugusto test ui context files output
+
+        if (template.name !== 'init') {
+          expect(
+            distFileExists(template.name, BROWSERS[0], 'icons/icon_16.png')
+          ).toBeTruthy()
+          expect(
+            distFileExists(template.name, BROWSERS[0], 'icons/icon_48.png')
+          ).toBeTruthy()
+        }
+      },
+      80000
+    )
+  })
+
+  describe('using the --browser flag', () => {
+    it.each(ALL_TEMPLATES)(
+      `builds the "$name" extension template across all browsers`,
+      async (template) => {
+        const extensionPath = path.join(__dirname, 'fixtures', template.name)
+        // Firefox is skippeed because it can't handle service workers.
+        const [chrome, edge /*, firefox */] = BROWSERS
+
+        await extensionProgram(`build ${extensionPath} --browser=chrome,edge`)
+
+        expect(distFileExists(template.name, chrome)).toBeTruthy()
+        expect(distFileExists(template.name, edge)).toBeTruthy()
+      },
+      50000
+    )
+  })
+
+  describe.skip('using the --polyfill flag', () => {
+    it.skip.each(ALL_TEMPLATES)(
+      `builds an extension created via "$name" template with the polyfill code`,
+      async (template) => {
+        const extensionPath = path.join(__dirname, 'fixtures', template.name)
+
+        await extensionProgram(`build ${extensionPath} --polyfill`)
+
+        // TODO cezaraugusto test this
+      },
+      50000
+    )
+  })
+
+  describe('using the --zip flag', () => {
+    it.each([DEFAULT_TEMPLATE])(
+      `builds and zips the distribution files of an extension created via "$name" template`,
+      async (template) => {
+        const extensionPath = path.join(__dirname, 'fixtures', template.name)
+
+        await extensionProgram(`build ${extensionPath} --zip`)
+
+        expect(distFileExists(template.name, 'chrome')).toBeTruthy()
+      },
+      50000
+    )
+
+    it.each([DEFAULT_TEMPLATE])(
+      `builds and zips the source files of an extension created via "$name" template`,
+      async (template) => {
+        const extensionPath = path.join(__dirname, 'fixtures', template.name)
+
+        await extensionProgram(`build ${extensionPath} --zip-source`)
+
+        expect(
+          distFileExists(
+            template.name,
+            BROWSERS[0],
+            `${template.name}-1.0-source.zip`
+          )
+        ).toBeTruthy()
+      },
+      50000
+    )
+
+    it.each([DEFAULT_TEMPLATE])(
+      `builds and zips the source files of an extension created via "$name" template with a custom output name using the --zip-filename flag`,
+      async (template) => {
+        const extensionPath = path.join(__dirname, 'fixtures', template.name)
+
+        await extensionProgram(
+          `build ${extensionPath} --zip --zip-filename ${template.name}-nice`
+        )
+
+        expect(
+          distFileExists(template.name, BROWSERS[0], `${template.name}-nice.zip`)
+        ).toBeTruthy()
+      },
+      50000
+    )
+  })
+})