From 79b9784f0de13e33be7207e17f45bc05e5b61eb4 Mon Sep 17 00:00:00 2001 From: Cezar Augusto Date: Mon, 22 Jan 2024 18:15:12 -0300 Subject: [PATCH] boring setup --- .gitignore | 2 +- README.md | 20 ++++--------------- .../reload-extension/reloadService.js | 1 - programs/cli/spec/cli.spec.ts | 1 - programs/develop/webpack/options/babel.ts | 8 +++++--- tsconfig.json | 8 +------- 6 files changed, 11 insertions(+), 29 deletions(-) diff --git a/.gitignore b/.gitignore index 8cb253e2..76eceb96 100644 --- a/.gitignore +++ b/.gitignore @@ -59,4 +59,4 @@ packages/*/demo packages/*/spec browser-extension-test-data TODO.yml -_examples +__TEST__ diff --git a/README.md b/README.md index 7bdb7ae0..962bdd22 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,6 @@ -[action-image]: https://github.com/cezaraugusto/extension-create/workflows/CI/badge.svg -[action-url]: https://github.com/cezaraugusto/extension-create/actions -[maintenance-image]: https://img.shields.io/badge/Maintained%3F-yes-green.svg -[maintenance-url]: https://GitHub.com/extension-create/extension-create/graphs/commit-activity -[npm-version-image]: https://badgen.net/npm/v/extension-create -[npm-version-url]: https://npmjs.com/package/extension-create -[npm-dependents-image]: https://badgen.net/npm/dependents/extension-create -[npm-dependents-url]: https://npmjs.com/package/extension-create [npm-downloads-image]: https://badgen.net/npm/dm/extension-create [npm-downloads-url]: https://npmjs.ccom/package/extension-create -> # THIS PROJECT IS UNDER ACTIVE DEVELOPMENT - # extension-create [![Maintenance][maintenance-image]][maintenance-url] [![workflow][action-image]][action-url] [![Npm package version][npm-version-image]][npm-version-url] [![Npm package dependents][npm-dependents-image]][npm-dependents-url] [![Npm package monthly downloads][npm-downloads-image]][npm-downloads-url] Logo @@ -19,7 +9,7 @@ Create modern cross-browser extensions with no build configuration. - [Creating an extension](#creating-an-extension) — How to create a new extension. - [Getting started immediately](#getting-started-immediately) — Get work done in no time. -- [I have an extension](#i-have-an-extension) - Use only specific parts of `extension-create` +- [I have an extension](#i-have-an-extension) - Use only specific parts of `extension-create`. `extension-create` helps you develop cross-browser extensions with built-in support for module imports/exports, auto-reload, and more. Interested to know how it's being developed? [Every week I send emails about its progress](https://cezaraugusto.substack.com/). For goals, see the [wiki](https://github.com/cezaraugusto/extension-create/wiki/This-initiative). @@ -31,7 +21,7 @@ cd my-extension-hello npm start ``` -A new browser instance (for now, Chrome) will open up with your extension ready for development. +A new browser instance will open up with your extension ready for development. You are done. Time to hack on your extension! @@ -47,8 +37,6 @@ The [chrome-extensions-sample](https://github.com/GoogleChrome/chrome-extensions If we go to the samples repository and look for an extension sample to work, let's say the [page-redder](https://github.com/GoogleChrome/chrome-extensions-samples/tree/main/functional-samples/sample.page-redder) sample, all we need is to copy and paste it's URL as an argument for the start command: -> Optimized for **git version 2.30.0**. Older versions are supported, but download can take much longer. - ```sh npx extension-create dev https://github.com/GoogleChrome/chrome-extensions-samples/tree/main/functional-samples/sample.page-redder ``` @@ -71,7 +59,7 @@ And see a Chrome Extension sample running automatically. On Edge! ## I have an extension -Use the command line interface `extension-create` provides and add it to your npm scripts. Here's how it should look in your `package.json`: +Just add `extension-create` to your npm scripts. Here's how it should look in your `package.json`: ```js { @@ -90,7 +78,7 @@ Use the command line interface `extension-create` provides and add it to your np | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | Google Chrome ✅ | Microsoft Edge ✅ | Mozilla Firefox ⛔️ | Apple Safari ⛔️ | Opera browser ⛔️ | Chromium (forks) 🤔 | -> Mainstream Chromium-like browsers include Brave, and Vivaldi. These vendors are supported on production but there are currently no modules to handle development using these browsers. I do plan to support them in the near future. +> Chromium-like browsers include Brave, Vivaldi, and other popular browser choices. These vendors are supported on production but there are currently no modules to handle development using these browsers. I do plan to support them in the near future. If you want to target a specific browser, just pass the `--browser` flag to the dev/start command (Chrome or Edge, soon others), like `npx extension-create dev --browser=edge`. diff --git a/packages/run-chrome-extension/extensions/reload-extension/reloadService.js b/packages/run-chrome-extension/extensions/reload-extension/reloadService.js index 6a2f3b5d..3b14cd95 100644 --- a/packages/run-chrome-extension/extensions/reload-extension/reloadService.js +++ b/packages/run-chrome-extension/extensions/reload-extension/reloadService.js @@ -112,7 +112,6 @@ async function requestInitialLoadData() { ) resolve(null) } else { - console.log({response}) resolve(response) } } diff --git a/programs/cli/spec/cli.spec.ts b/programs/cli/spec/cli.spec.ts index 5e27d7bd..005f69f1 100644 --- a/programs/cli/spec/cli.spec.ts +++ b/programs/cli/spec/cli.spec.ts @@ -9,7 +9,6 @@ export default function cliSpec() {} /** * exist if node version is less than 16 - * can start the cli * can output the helper text * can output the version */ diff --git a/programs/develop/webpack/options/babel.ts b/programs/develop/webpack/options/babel.ts index def4e976..3aea5454 100644 --- a/programs/develop/webpack/options/babel.ts +++ b/programs/develop/webpack/options/babel.ts @@ -17,9 +17,11 @@ export function getBabelConfigFile(projectDir: string) { const configFile = path.join(projectDir, file) if (fs.existsSync(configFile)) { - console.log( - `🟡 - Using Babel config file: \`${path.basename(configFile)}\`` - ) + if (process.env.EXTENSION_ENV === 'development') { + console.log( + `🟡 - Using Babel config file: \`${path.basename(configFile)}\`` + ) + } return configFile } } diff --git a/tsconfig.json b/tsconfig.json index c72c47ff..d86d1400 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,11 +1,5 @@ { "extends": "./packages/tsconfig/base.json", "include": ["."], - "exclude": [ - "dist", - "node_modules", - "browser-extension-test-data", - "__hmr-tests__", - "__utils__" - ] + "exclude": ["dist", "node_modules", "browser-extension-test-data", "__TEST__"] }