npm - @dword-design/base-config-web-extension - Versions diffs - 3.1.6 → 3.1.8 - Mend

@dword-design/base-config-web-extension 3.1.6 → 3.1.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/LICENSE.md CHANGED Viewed

@@ -14,8 +14,17 @@ MIT License
 Copyright (c) <year> <copyright holders>
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/dev.js CHANGED Viewed

@@ -1,11 +1,26 @@
 import { execaCommand } from 'execa';
 import getManifest from "./get-manifest.js";
-export default (() => async (browser = 'chrome') => execaCommand('vite', {
-  env: {
-    MANIFEST: JSON.stringify(await getManifest({
-      browser
-    })),
-    TARGET: browser
-  },
-  stdio: 'inherit'
-}));
+export default async function (browser = 'chrome', options) {
+  options = {
+    env: {},
+    log: process.env.NODE_ENV !== 'test',
+    stderr: 'inherit',
+    ...options
+  };
+  return execaCommand('vite', {
+    env: {
+      ...options.env,
+      MANIFEST: JSON.stringify(await getManifest({
+        browser,
+        cwd: this.cwd
+      })),
+      TARGET: browser
+    },
+    ...(options.log && {
+      stdout: 'inherit'
+    }),
+    cwd: this.cwd,
+    reject: process.env.NODE_ENV !== 'test',
+    stderr: options.stderr
+  });
+}

package/dist/get-manifest.js CHANGED Viewed

@@ -1,13 +1,15 @@
+import pathLib from 'node:path';
 import fs from 'fs-extra';
 import loadPkg from 'load-pkg';
 import { pick } from 'lodash-es';
-export default (async ({
+export default async ({
+  cwd,
   browser
 }) => {
-  const packageConfig = await loadPkg();
-  const config = await fs.readJson('config.json').catch(() => ({}));
-  const iconExists = await fs.exists('public/icon.png');
-  const popupExists = await fs.exists('popup.html');
+  const packageConfig = await loadPkg(cwd);
+  const config = await fs.readJson(pathLib.join(cwd, 'config.json')).catch(() => ({}));
+  const iconExists = await fs.exists(pathLib.join(cwd, 'public', 'icon.png'));
+  const popupExists = await fs.exists(pathLib.join(cwd, 'popup.html'));
   return {
     name: config.name,
     ...pick(packageConfig, ['version', 'description']),
@@ -30,7 +32,7 @@ export default (async ({
         ...(typeof config.action === 'object' && config.action)
       }
     }),
-    ...(((await fs.exists('content.js')) || config.css?.length > 0) && {
+    ...(((await fs.exists(pathLib.join(cwd, 'content.js'))) || config.css?.length > 0) && {
       content_scripts: [{
         js: ['content.js'],
         ...(config.css?.length > 0 && {
@@ -39,7 +41,7 @@ export default (async ({
         matches: config.matches || ['<all_urls>']
       }]
     }),
-    ...((await fs.exists('background.js')) && {
+    ...((await fs.exists(pathLib.join(cwd, 'background.js'))) && {
       background: {
         ...(browser === 'firefox' ? {
           scripts: ['background.js']
@@ -64,4 +66,4 @@ export default (async ({
       web_accessible_resources: true
     }))
   };
-});
+};

package/dist/index.js CHANGED Viewed

@@ -1,118 +1,114 @@
+import pathLib from 'node:path';
 import depcheckParserSass from '@dword-design/depcheck-parser-sass';
-import { endent } from '@dword-design/functions';
+import dedent from 'dedent';
 import binName from 'depcheck-bin-name';
 import packageName from 'depcheck-package-name';
 import depcheckParserVue from 'depcheck-parser-vue';
-import outputFiles from 'output-files';
+import fs from 'fs-extra';
 import dev from "./dev.js";
-import lint from "./lint.js";
 import prepublishOnly from "./prepublish-only.js";
-export default (config => ({
-  allowedMatches: ['assets', 'components', 'public', 'background.js', 'content.js', 'config.json', 'index.spec.js', 'options.html', 'popup.html', 'popup.js', 'popup.vue', 'options.js', 'popup.js', 'model'],
-  commands: {
-    dev: {
-      arguments: '[browser]',
-      handler: dev(config)
+export default function () {
+  return {
+    allowedMatches: ['assets', 'components', 'public', 'background.js', 'content.js', 'config.json', 'index.spec.js', 'options.html', 'popup.html', 'popup.js', 'popup.vue', 'options.js', 'popup.js', 'model'],
+    commands: {
+      dev: {
+        arguments: '[browser]',
+        handler: (...args) => dev.call(this, ...args)
+      },
+      prepublishOnly: {
+        arguments: '[browser]',
+        handler: (...args) => prepublishOnly.call(this, ...args)
+      }
     },
-    prepublishOnly: {
-      arguments: '[browser]',
-      handler: prepublishOnly(config)
-    }
-  },
-  depcheckConfig: {
-    parsers: {
-      '**/*.scss': depcheckParserSass,
-      '**/*.vue': depcheckParserVue
-    }
-  },
-  deployAssets: [{
-    label: 'Extension',
-    path: 'extension.zip'
-  }],
-  deployEnv: {
-    CHROME_CLIENT_ID: '${{ secrets.CHROME_CLIENT_ID }}',
-    CHROME_CLIENT_SECRET: '${{ secrets.CHROME_CLIENT_SECRET }}',
-    CHROME_EXTENSION_ID: '${{ secrets.CHROME_EXTENSION_ID }}',
-    CHROME_REFRESH_TOKEN: '${{ secrets.CHROME_REFRESH_TOKEN }}',
-    FIREFOX_EXTENSION_ID: '${{ secrets.FIREFOX_EXTENSION_ID }}',
-    FIREFOX_JWT_ISSUER: '${{ secrets.FIREFOX_JWT_ISSUER }}',
-    FIREFOX_JWT_SECRET: '${{ secrets.FIREFOX_JWT_SECRET }}'
-  },
-  deployPlugins: [[packageName`@semantic-release/exec`, {
-    publishCmd: `yarn ${binName`publish-extension`} --chrome-zip=dist/chrome.zip --firefox-zip=dist/firefox.zip --firefox-sources-zip=dist/firefox-sources.zip`
-  }]],
-  editorIgnore: ['.eslintrc.json', 'dist', 'userdata', 'vite.config.js'],
-  gitignore: ['/.eslintrc.json', '/dist', '/userdata', '/vite.config.js'],
-  isLockFileFixCommitType: true,
-  lint,
-  preDeploySteps: [{
-    run: 'yarn prepublishOnly'
-  }, {
-    env: {
-      FIREFOX_EXTENSION_ID: '${{ secrets.FIREFOX_EXTENSION_ID }}'
+    depcheckConfig: {
+      parsers: {
+        '**/*.scss': depcheckParserSass,
+        '**/*.vue': depcheckParserVue
+      }
     },
-    run: 'yarn prepublishOnly firefox'
-  }, {
-    run: 'zip -r ../chrome.zip .',
-    'working-directory': 'dist/chrome'
-  }, {
-    run: 'zip -r ../firefox.zip .',
-    'working-directory': 'dist/firefox'
-  }, {
-    run: 'git archive --output=dist/firefox-sources.zip HEAD'
-  }],
-  prepare: () => outputFiles({
-    '.eslintrc.json': `${JSON.stringify({
-      extends: packageName`@dword-design/eslint-config`
-    }, undefined, 2)}\n`,
-    'vite.config.js': endent`
-        import vue from '${packageName`@vitejs/plugin-vue`}'
-        import P from 'path'
-        import { defineConfig } from '${packageName`vite`}'
-        import vueBabel from '${packageName`@dword-design/vite-plugin-vue-babel`}'
-        import babel from '${packageName`vite-plugin-babel`}'
-        import eslint from '${packageName`vite-plugin-eslint`}'
-        import webExtension from '${packageName`vite-plugin-web-extension`}'
-        import svgLoader from '${packageName`vite-svg-loader`}'
+    deployAssets: [{
+      label: 'Extension',
+      path: 'extension.zip'
+    }],
+    deployEnv: {
+      CHROME_CLIENT_ID: '${{ secrets.CHROME_CLIENT_ID }}',
+      CHROME_CLIENT_SECRET: '${{ secrets.CHROME_CLIENT_SECRET }}',
+      CHROME_EXTENSION_ID: '${{ secrets.CHROME_EXTENSION_ID }}',
+      CHROME_REFRESH_TOKEN: '${{ secrets.CHROME_REFRESH_TOKEN }}',
+      FIREFOX_EXTENSION_ID: '${{ secrets.FIREFOX_EXTENSION_ID }}',
+      FIREFOX_JWT_ISSUER: '${{ secrets.FIREFOX_JWT_ISSUER }}',
+      FIREFOX_JWT_SECRET: '${{ secrets.FIREFOX_JWT_SECRET }}'
+    },
+    deployPlugins: [[packageName`@semantic-release/exec`, {
+      publishCmd: `pnpm ${binName`publish-extension`} --chrome-zip=dist/chrome.zip --firefox-zip=dist/firefox.zip --firefox-sources-zip=dist/firefox-sources.zip`
+    }]],
+    editorIgnore: ['dist', 'userdata', 'vite.config.js'],
+    gitignore: ['/dist', '/userdata', '/vite.config.js'],
+    isLockFileFixCommitType: true,
+    preDeploySteps: [{
+      run: 'pnpm prepublishOnly'
+    }, {
+      env: {
+        FIREFOX_EXTENSION_ID: '${{ secrets.FIREFOX_EXTENSION_ID }}'
+      },
+      run: 'pnpm prepublishOnly firefox'
+    }, {
+      run: 'zip -r ../chrome.zip .',
+      'working-directory': 'dist/chrome'
+    }, {
+      run: 'zip -r ../firefox.zip .',
+      'working-directory': 'dist/firefox'
+    }, {
+      run: 'git archive --output=dist/firefox-sources.zip HEAD'
+    }],
+    prepare: () => Promise.all([fs.outputFile(pathLib.join(this.cwd, 'vite.config.js'), dedent`
+          import vue from '${packageName`@vitejs/plugin-vue`}'
+          import P from 'path'
+          import { defineConfig } from '${packageName`vite`}'
+          import vueBabel from '${packageName`@dword-design/vite-plugin-vue-babel`}'
+          import babel from '${packageName`vite-plugin-babel`}'
+          import eslint from '${packageName`vite-plugin-eslint`}'
+          import webExtension from '${packageName`vite-plugin-web-extension`}'
+          import svgLoader from '${packageName`vite-svg-loader`}'
-        export default defineConfig({
-          build: {
-            outDir: P.join('dist', process.env.TARGET),
-          },
-          plugins: [
-            vueBabel(),
-            vue(),
-            svgLoader(),
-            eslint({ fix: true }),
-            webExtension({
-              browser: process.env.TARGET,
-              manifest: () => JSON.parse(process.env.MANIFEST),
-              scriptViteConfig: { plugins: [babel(), eslint({ fix: true })] },
-              webExtConfig: { keepProfileChanges: true, chromiumProfile: 'userdata' },
-            }),
-          ],
-        })\n
-      `
-  }),
-  readmeInstallString: endent`
-    ## Recommended setup
-    * Node.js 20.11.1
-    * Yarn 1.22.19
+          export default defineConfig({
+            build: {
+              outDir: P.join('dist', process.env.TARGET),
+            },
+            plugins: [
+              vueBabel(),
+              vue(),
+              svgLoader(),
+              eslint({ fix: true }),
+              webExtension({
+                browser: process.env.TARGET,
+                manifest: () => JSON.parse(process.env.MANIFEST),
+                scriptViteConfig: { plugins: [babel(), eslint({ fix: true })] },
+                webExtConfig: { keepProfileChanges: true, chromiumProfile: 'userdata' },
+              }),
+            ],
+          })\n
+        `), fs.ensureDir(pathLib.join(this.cwd, 'userdata'))]),
+    readmeInstallString: dedent`
+      ## Recommended setup
+      * Node.js 20.11.1
+      * pnpm 9.15.3
-    ## Install
-    \`\`\`bash
-    $ yarn --frozen-lockfile
-    \`\`\`
+      ## Install
+      \`\`\`bash
+      $ pnpm install --frozen-lockfile
+      \`\`\`
-    ## Running a development server
-    \`\`\`bash
-    $ yarn dev [browser]
-    \`\`\`
-    Available browsers are \`firefox\` and \`chrome\`. Default is \`firefox\`.
+      ## Running a development server
+      \`\`\`bash
+      $ pnpm dev [browser]
+      \`\`\`
+      Available browsers are \`firefox\` and \`chrome\`. Default is \`firefox\`.
-    ## Building the extension for upload
-    \`\`\`bash
-    $ yarn prepublishOnly [browser]
-    \`\`\`
-  `
-}));
+      ## Building the extension for upload
+      \`\`\`bash
+      $ pnpm prepublishOnly [browser]
+      \`\`\`
+    `
+  };
+}

package/dist/prepublish-only.js CHANGED Viewed

@@ -1,11 +1,30 @@
 import { execaCommand } from 'execa';
 import getManifest from "./get-manifest.js";
-export default (() => async (browser = 'chrome') => execaCommand('vite build', {
-  env: {
-    MANIFEST: JSON.stringify(await getManifest({
-      browser
-    })),
-    TARGET: browser
-  },
-  stdio: 'inherit'
-}));
+export default async function (...args) {
+  let options = typeof args[0] === 'string' ? args[1] : args[0];
+  options = {
+    browser: 'chrome',
+    env: {},
+    log: process.env.NODE_ENV !== 'test',
+    stderr: 'inherit',
+    ...(typeof args[0] === 'string' && {
+      browser: args[0]
+    }),
+    ...options
+  };
+  return execaCommand('vite build', {
+    env: {
+      ...options.env,
+      MANIFEST: JSON.stringify(await getManifest({
+        browser: options.browser,
+        cwd: this.cwd
+      })),
+      TARGET: options.browser
+    },
+    ...(options.log && {
+      stdout: 'inherit'
+    }),
+    cwd: this.cwd,
+    stderr: options.stderr
+  });
+}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@dword-design/base-config-web-extension",
-  "version": "3.1.6",
+  "version": "3.1.8",
   "repository": "dword-design/base-config-web-extension",
   "funding": "https://github.com/sponsors/dword-design",
   "license": "MIT",
@@ -19,43 +19,42 @@
     "lint": "base lint",
     "prepare": "base prepare",
     "prepublishOnly": "base prepublishOnly",
-    "test": "base test",
-    "test:raw": "base test:raw"
+    "test": "base test"
   },
   "dependencies": {
     "@dword-design/depcheck-parser-sass": "^4.0.4",
-    "@dword-design/eslint-config": "^5.0.1",
-    "@dword-design/functions": "^6.0.0",
-    "@dword-design/vite-plugin-vue-babel": "^1.0.0",
+    "@dword-design/vite-plugin-vue-babel": "^1.0.2",
     "@semantic-release/exec": "^6.0.3",
-    "@vitejs/plugin-vue": "^5.0.4",
-    "depcheck-bin-name": "^1.0.0",
+    "@vitejs/plugin-vue": "^5.2.4",
+    "dedent": "^1.6.0",
+    "depcheck-bin-name": "^1.0.1",
     "depcheck-package-name": "^3.0.1",
     "depcheck-parser-vue": "^5.0.0",
-    "execa": "^8.0.1",
-    "fs-extra": "^11.1.0",
+    "execa": "^9.6.0",
+    "fs-extra": "^11.3.0",
     "load-pkg": "^4.0.0",
     "lodash-es": "^4.17.21",
-    "output-files": "^2.0.0",
-    "publish-browser-extension": "^2.1.3",
-    "vite": "^5.1.4",
-    "vite-plugin-babel": "^1.2.0",
+    "publish-browser-extension": "^2.3.1",
+    "vite": "^5.4.19",
+    "vite-plugin-babel": "^1.3.1",
     "vite-plugin-eslint": "^1.8.1",
-    "vite-plugin-web-extension": "^4.1.1",
+    "vite-plugin-web-extension": "^4.4.3",
     "vite-svg-loader": "^5.1.0",
-    "vue": "^3.4.21"
+    "vue": "^3.5.16"
   },
   "devDependencies": {
-    "@dword-design/base": "^11.0.2",
-    "@dword-design/puppeteer": "^7.0.0",
-    "@dword-design/tester": "^2.0.4",
-    "@dword-design/tester-plugin-tmp-dir": "^2.0.3",
+    "@dword-design/base": "^12.0.18",
     "@mdi/svg": "^7.4.47",
-    "express": "^4.17.1",
-    "globby": "^14.0.0",
-    "webextension-polyfill": "^0.11.0",
-    "with-local-tmp-dir": "^5.0.1"
+    "@playwright/test": "^1.52.0",
+    "express": "^4.21.2",
+    "get-port": "^7.1.0",
+    "globby": "^14.1.0",
+    "output-files": "^2.0.32",
+    "playwright": "^1.52.0",
+    "playwright-chromium": "^1.52.0",
+    "webextension-polyfill": "^0.12.0"
   },
+  "packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977",
   "engines": {
     "node": ">=18"
   },

package/dist/lint.js DELETED Viewed

@@ -1,10 +0,0 @@
-import { execaCommand } from 'execa';
-export default (async () => {
-  try {
-    await execaCommand('eslint --fix --ext .js,.json,.vue --ignore-path .gitignore .', {
-      all: true
-    });
-  } catch (error) {
-    throw new Error(error.all);
-  }
-});