Fix clean function

Author: cezaraugusto

.github/CODE_OF_CONDUCT.md

@@ -1,4 +1,3 @@
-
 # Code of Conduct
 
 ## Our Pledge
@@ -18,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
+- Focusing on what is best not just for us as individuals, but for the overall
   community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or advances of
+- The use of sexualized language or imagery, and sexual attention or advances of
   any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
   without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities

README.md

@@ -1,14 +1,14 @@
 [npm-version-image]: https://img.shields.io/npm/v/extension.svg?color=0971fe
 [npm-version-url]: https://www.npmjs.com/package/extension
-[downloads-image]: https://img.shields.io/npm/dm/extension.svg
+[downloads-image]: https://img.shields.io/npm/dm/extension.svg?color=2ecc40
 [downloads-url]: https://npmjs.org/package/extension
-[action-image]: https://github.com/extension-js/extension.js/actions/workflows/ci.yml/badge.svg?branch=main
+[action-image]: https://github.com/extension-js/extension.js/actions/workflows/ci.yml/badge.svg?branch=main&color=2ecc40
 [action-url]: https://github.com/extension-js/extension.js/actions
-[coverage-image]: https://img.shields.io/codecov/c/github/extension-js/extension.js
+[coverage-image]: https://img.shields.io/codecov/c/github/extension-js/extension.js?color=2ecc40
 [coverage-url]: https://codecov.io/github/extension-js/extension.js
-[discord-image]: https://img.shields.io/discord/1253608412890271755?label=Discord&logo=discord&style=flat
+[discord-image]: https://img.shields.io/discord/1253608412890271755?label=Discord&logo=discord&style=flat&color=2ecc40
 [discord-url]: https://discord.gg/v9h2RgeTSN
-[snyk-image]: https://snyk.io/test/github/extension-js/extension/badge.svg
+[snyk-image]: https://snyk.io/test/github/extension-js/extension/badge.svg?color=2ecc40
 [snyk-url]: https://snyk.io/test/github/extension-js/extension
 
 > The cross-browser extension framework

programs/cli/README.md

@@ -1,14 +1,14 @@
 [npm-version-image]: https://img.shields.io/npm/v/extension.svg?color=0971fe
 [npm-version-url]: https://www.npmjs.com/package/extension
-[downloads-image]: https://img.shields.io/npm/dm/extension.svg
+[downloads-image]: https://img.shields.io/npm/dm/extension.svg?color=2ecc40
 [downloads-url]: https://npmjs.org/package/extension
-[action-image]: https://github.com/extension-js/extension.js/actions/workflows/ci.yml/badge.svg?branch=main
+[action-image]: https://github.com/extension-js/extension.js/actions/workflows/ci.yml/badge.svg?branch=main&color=2ecc40
 [action-url]: https://github.com/extension-js/extension.js/actions
-[coverage-image]: https://img.shields.io/codecov/c/github/extension-js/extension.js
+[coverage-image]: https://img.shields.io/codecov/c/github/extension-js/extension.js?color=2ecc40
 [coverage-url]: https://codecov.io/github/extension-js/extension.js
-[discord-image]: https://img.shields.io/discord/1253608412890271755?label=Discord&logo=discord&style=flat
+[discord-image]: https://img.shields.io/discord/1253608412890271755?label=Discord&logo=discord&style=flat&color=2ecc40
 [discord-url]: https://discord.gg/v9h2RgeTSN
-[snyk-image]: https://snyk.io/test/github/extension-js/extension/badge.svg
+[snyk-image]: https://snyk.io/test/github/extension-js/extension/badge.svg?color=2ecc40
 [snyk-url]: https://snyk.io/test/github/extension-js/extension
 
 > The cross-browser extension framework

programs/develop/commands/commands-lib/get-project-path.ts

@@ -1,4 +1,5 @@
 import * as path from 'path'
+import * as fs from 'fs'
 import goGitIt from 'go-git-it'
 import * as messages from './messages'
 import {downloadAndExtractZip} from './extract-from-zip'
@@ -68,3 +69,10 @@ export async function getProjectPath(pathOrRemoteUrl: string | undefined) {
 
   return path.resolve(process.cwd(), pathOrRemoteUrl)
 }
+
+export function getProjectOutputPath(projectPath: string, browser: string) {
+  const distPath = path.join(projectPath, 'dist', browser)
+  const outputPath = fs.existsSync(distPath) ? distPath : projectPath
+
+  return outputPath
+}

programs/develop/commands/commands-lib/messages.ts

@@ -236,7 +236,7 @@ export function writingTypeDefinitionsError(error: any) {
 
 export function downloadingText(url: string) {
   return (
-    `${getLoggingPrefix('info')} Downloading extension...\n` +
+    `${getLoggingPrefix('info')} Downloading browser extension...\n` +
     `${chalk.gray('URL')} ${chalk.underline(url)}`
   )
 }

programs/develop/commands/preview.ts

@@ -10,7 +10,10 @@ import * as path from 'path'
 import {rspack, type Configuration} from '@rspack/core'
 import {merge} from 'webpack-merge'
 import webpackConfig from '../webpack/webpack-config'
-import {getProjectPath} from './commands-lib/get-project-path'
+import {
+  getProjectPath,
+  getProjectOutputPath
+} from './commands-lib/get-project-path'
 import * as messages from './commands-lib/messages'
 import {loadCustomWebpackConfig} from './commands-lib/get-extension-config'
 import {PreviewOptions} from './commands-lib/config-types'
@@ -47,11 +50,12 @@ export async function extensionPreview(
       }
     })
 
+    const contextPath = getProjectOutputPath(projectPath, browser)
     const onlyBrowserRunners = baseConfig.plugins?.filter((plugin) => {
       return plugin?.constructor.name === 'plugin-browsers'
     })
 
-    const userExtensionConfig = await loadCustomWebpackConfig(projectPath)
+    const userExtensionConfig = await loadCustomWebpackConfig(contextPath)
     const userConfig = userExtensionConfig({
       ...baseConfig,
       plugins: onlyBrowserRunners
@@ -66,9 +70,7 @@ export async function extensionPreview(
       }
 
       if (!stats?.hasErrors()) {
-        console.log(
-          messages.runningInProduction(path.join(projectPath, 'dist', browser))
-        )
+        console.log(messages.runningInProduction(contextPath))
       } else {
         console.log(stats.toString({colors: true}))
         process.exit(1)

programs/develop/webpack/plugin-compilation/clean-dist.ts

@@ -1,10 +1,15 @@
 import * as fs from 'fs'
 import * as path from 'path'
 import {type Compiler} from '@rspack/core'
+import {getProjectOutputPath} from '../../commands/commands-lib/get-project-path'
 
 export class CleanDistFolderPlugin {
+  constructor(private options: {browser: string}) {}
   apply(compiler: Compiler): void {
-    const outputPath = path.join(compiler.options.output.path || '')
+    const outputPath = getProjectOutputPath(
+      compiler.options.context!,
+      this.options.browser
+    )
 
     if (fs.existsSync(outputPath)) {
       try {

programs/develop/webpack/plugin-compilation/index.ts

@@ -11,10 +11,12 @@ export class CompilationPlugin {
 
   public readonly manifestPath: string
   public readonly browser: PluginInterface['browser']
+  public readonly clean: boolean
 
-  constructor(options: PluginInterface) {
+  constructor(options: PluginInterface & {clean: boolean}) {
     this.manifestPath = options.manifestPath
     this.browser = options.browser || 'chrome'
+    this.clean = options.clean || true
   }
 
   public apply(compiler: Compiler): void {
@@ -26,7 +28,15 @@ export class CompilationPlugin {
       browser: this.browser
     }).apply(compiler)
 
-    new CleanDistFolderPlugin().apply(compiler)
+    // The CleanDistFolderPlugin will remove the dist folder
+    // before the compilation starts. This is a problem
+    // for preview mode, where we don't want to clean the
+    // folder that is being used by the preview server.
+    if (this.clean) {
+      new CleanDistFolderPlugin({
+        browser: this.browser || 'chrome'
+      }).apply(compiler)
+    }
 
     compiler.hooks.done.tapAsync('develop:brand', (stats, done) => {
       stats.compilation.name = undefined

programs/develop/webpack/plugin-extension/feature-html/html-lib/parse5-utilities

@@ -0,0 +1 @@
+Subproject commit 61556a4917863645031ac3e26b308df327389f0a

programs/develop/webpack/webpack-config.ts

@@ -9,6 +9,7 @@ import * as path from 'path'
 import * as fs from 'fs'
 import {type Configuration} from '@rspack/core'
 import {DevOptions} from '../commands/commands-lib/config-types'
+import {getProjectOutputPath} from '../commands/commands-lib/get-project-path'
 
 // Plugins
 import {CompilationPlugin} from './plugin-compilation'
@@ -37,9 +38,14 @@ export default function webpackConfig(
     JSON.parse(fs.readFileSync(manifestPath, 'utf-8')),
     devOptions.browser
   )
-  const userExtensionOutputPath = path.join(
+  const userExtensionOutputPath = getProjectOutputPath(
     projectPath,
-    `dist/${devOptions.browser}`
+    devOptions.browser
+  )
+  const managerExtensionPath = path.join(
+    __dirname,
+    'extensions',
+    `${devOptions.browser}-manager-extension`
   )
 
   const browser = devOptions.chromiumBinary
@@ -101,7 +107,8 @@ export default function webpackConfig(
     plugins: [
       new CompilationPlugin({
         manifestPath,
-        browser
+        browser,
+        clean: devOptions.output?.clean
       }),
       new StaticAssetsPlugin({
         mode: devOptions.mode,
@@ -132,7 +139,7 @@ export default function webpackConfig(
       new BrowsersPlugin({
         extension: [
           userExtensionOutputPath,
-          path.join(__dirname, 'extensions', `${browser}-manager-extension`)
+          devOptions.mode !== 'production' ? managerExtensionPath : ''
         ],
         browser,
         open: devOptions.open,