extension 0.2.0 → 1.1.1

package/LICENSE

@@ -1,20 +1,21 @@
-Copyright (c) 2012 Near Infinity Corporation
+MIT License
 
-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:
+Copyright (c) 2024 Cezar Augusto <boss@cezaraugusto.net> (https://cezaraugusto.com)
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of 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 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.
+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/README.md

@@ -1,166 +1,111 @@
-# extension
+[action-image]: https://github.com/cezaraugusto/extension-create/actions/workflows/ci.yml/badge.svg?branch=main
+[action-url]: https://github.com/cezaraugusto/extension-create/actions
+[npm-image]: https://img.shields.io/npm/v/extension-create.svg
+[npm-url]: https://npmjs.org/package/extension-create
+[downloads-image]: https://img.shields.io/npm/dm/extension-create.svg
+[downloads-url]: https://npmjs.org/package/extension-create
+[node]: https://img.shields.io/node/v/extension-create.svg
+[node-url]: https://nodejs.org
+[prs]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
+[prs-url]: https://github.com/cezaraugusto/extension-create/blob/main/CONTRIBUTING.md
+[vunlerabilities]: https://snyk.io/test/github/cezaraugusto/extension-create/badge.svg
+[fossa-image]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcezaraugusto%2Fextension-create.svg?type=shield
+[fossa-url]: https://app.fossa.com/projects/git%2Bgithub.com%2Fcezaraugusto%2Fextension-create?ref=badge_large
+
+# extension-create [![npm][npm-image]][npm-url] [![fossa][fossa-image]][fossa-url] [![workflow][action-image]][action-url] [![downloads][downloads-image]][downloads-url] [![PR's welcome][prs]][prs-url]
+
+<img alt="Logo" align="right" src="https://user-images.githubusercontent.com/4672033/102850460-4d22aa80-43f8-11eb-82db-9efce586f73e.png" width="25%" />
+
+Create 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`.
+
+`extension-create` helps you develop cross-browser extensions with built-in support for module imports/exports, auto-reload, and more.
+
+## Creating an Extension
+
+```sh
+npx extension-create@latest create my-extension-hello
+cd my-extension-hello
+npm run dev
+```
 
-Framework for selectively extending JavaScript objects
+A new browser instance will open up with your extension ready for development.
 
-## Installation
+You are done. Time to hack on your extension!
 
-    $ npm install extension
+<p align="center">
+<img src="https://user-images.githubusercontent.com/4672033/106184765-ba0c2b80-6180-11eb-9d0f-d9d00d168290.gif" width="720" alt="npm start">
+</p>
 
-## Usage
+## Getting Started Immediately
 
-The extension module is pretty flexible and can be used in several different ways. The first method allows you to register extensions for certain object types for use later in your code.
+### Kickstart any sample from Chrome Extension Samples
 
-```javascript
-var ext = require('extension');
+The [chrome-extensions-sample](https://github.com/GoogleChrome/chrome-extensions-samples/) project is a great way to kickstart developing your extension.
 
-// register some built in extensions
-ext.register(String.prototype, ext.string);
+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:
 
-// register your own custom extensions
-ext.register(String.prototype, {
-  echo: function() {
-	console.log(this);
-  },
+#### Command
 
-  cap: function() {
-	console.log(this.toUpperCase());
-  }
-});
+```sh
+# This command will:
+# 1. Download the Chrome extension sample URL to the current working directory
+# 2. Bundle the downloaded extension using extension-create
+# 3. Enable the extension in Chrome using a fresh user profile
+npx extension-create dev https://github.com/GoogleChrome/chrome-extensions-samples/tree/main/functional-samples/sample.page-redder
 ```
 
-Once extensions are registered, they can be used globally
-
-```javascript
-// enable extensions registered against 
-// String.prototype for duration of program
-ext.use(String.prototype)
-var str = 'hello world';
-str.echo(); // prints hello world to the console
-```
+<p align="center">
+<img src="https://user-images.githubusercontent.com/4672033/106188671-04dc7200-6186-11eb-940a-52aebab46f31.gif" width="720" alt="npm start">
+</p>
 
-or within the scope of a function. Please note that any async callbacks within the scope function will **not** see the object extensions.
+Will not only download the extension but also kickstart a Chrome instance in a fresh profile with your sample extension loaded and default auto-reload support. Try it yourself!
 
-```javascript
-// enable extensions registered against 
-// String.prototype within function scope
-var str = 'hello world';
+### Use `Microsoft Edge` to kickstart any sample from [chrome-extesions-sample](https://github.com/GoogleChrome/chrome-extensions-samples/)
 
-ext.use(String.prototype, function() {
-  str.echo(); // prints 'hello world' to the console
-});
+**You read it!** Just run the command above with the `--browser=edge` flag:
 
-str.echo(); // TypeError: Object has no method 'echo'
+```sh
+npx extension-create dev --browser=edge https://github.com/GoogleChrome/chrome-extensions-samples/tree/main/functional-samples/sample.page-redder
 ```
 
-You don't even have to use all the extensions registered for an object. You can pick and choose only the ones you like
-
-```javascript
-var str = 'hello world';
-
-ext.use(String.prototype, ['echo']); // use only the echo extension method
-str.echo(); // prints 'hello world' to the console
-str.cap(); // TypeError: Object has no method 'cap'
-
-ext.use(String.prototype, ['cap'], function() { // use cap extension within function scope
-  str.echo(); // prints 'hello world' to the console
-  str.cap(); // prints 'HELLO WORLD' to the console
-});
-
-str.cap(); // TypeError: Object has no method 'cap'
-```
+And see a Chrome Extension sample running automatically. On Edge!
 
-The examples above demonstrate extending built-in JavaScript object prototypes, but extensions can be registered against any object.
+## I have an extension
 
-```javascript
-var myObj = {};
+Just add `extension-create` to your npm scripts. Here's how it should look in your `package.json`:
 
-ext.register(myObj, {
-  say: function(text) {
-	console.log(text);
+```js
+{
+  // ...npm stuff,
+  "scripts": {
+    "start": "npx extension-create start",
+    "dev": "npx extension-create dev",
+    "build": "npx extension-create build"
+  },
+  "devDependencies": {
+    "extension-create": "latest"
   }
-});
-ext.use(myObj);
-
-myObj.say('hello'); // prints 'hello' to the console
-var newObj = {};
-newObj.say('hello'); // TypeError: Object has no method 'say'
+}
 ```
 
-There are many built-in extension methods, which are documented below and can be found in the `lib/` directory of this project. If you'd like to use them directly without having to first register them, you can do that too.
-
-```javascript
-var strext = require('extension').string;
-var objext = require('extension').object;
-
-strext.contains('hello world', 'hello'); // true
-objext.isString('hello world'); // true
-```
-
-## Extension API
-
-### register(object, extensionObject)
-
-Register properties of extensionObject as extensions to the object argument
+#### Using a specific browser for development
 
-__Arguments__
+| <img width=120 src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/chrome/chrome.svg" alt="Chrome browser logo"> | <img width=120 src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/edge/edge.svg" alt="Microsoft Edge browser logo"> | <img width=120 src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/firefox/firefox.svg" alt="Mozilla Firefox browser logo"> | <img width=120 src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/safari/safari.svg" alt="Apple Safari browser logo"> | <img width=120 src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/opera/opera.svg" alt="Opera browser logo"> | <img width=120 src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/chromium/chromium.svg" alt="Chromium browser logo"> |
+| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
+| Google Chrome ✅                                                                                                                 | Microsoft Edge ✅                                                                                                                    | Mozilla Firefox ⛔️                                                                                                                         | Apple Safari ⛔️                                                                                                                       | Opera browser ⛔️                                                                                                             | Chromium (forks) 🤔                                                                                                                    |
 
-* object - the object against which to register extensions
-* extensionObject - Object containing extension properties/method
+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`.
 
-### use(object [, properties] [, scopeFunction])
+That's it!
 
-Use the specified registered extensions for the given object, optionally only within the scope of a provided function.
+## Program Options Table
 
-__Arguments__
-
-* object - the object whose registered extensions you wish to use
-* properties - an optional array of property/method names representing a subset of the registered extensions you'd like to use
-* scopeFunction - an optional function within which the specified registered extensions will be applied. They are removed after the method returns or throws an exception.
-
-### registerAndUse(object, extensionObject)
-
-Register properties of extensionObject as extensions to the object argument and set them up for use. It's the equivalent of calling `#register` followed immediately by `#use` without the scoping function argument.
-
-__Arguments__
-
-* object - the object against which to register extensions
-* extensionObject - Object containing extension properties/method
-
-### find(object)
-
-Find all the extension properties/methods registered against the given object. The return value is an object containing all the extension properties/methods.
-
-__Arguments__
-
-* object - the object against which you wish to find registered extensions
-
-
-## Built-in Extensions
-
-Coming soon! Please see files in the lib/ directory in the meantime.
+For a list of all commands available, see [OPTIONS_TABLE.md](OPTIONS_TABLE.md).
 
 ## License
 
-(The MIT License)
-
-Copyright (c) 2012 Near Infinity Corporation
-
-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.
-
+MIT (c) Cezar Augusto.

package/dist/cli.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/cli.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+"use strict";
+
+// cli.ts
+var import_child_process = require("child_process");
+function runCli() {
+  (0, import_child_process.exec)("@extension-create/cli", (error, stdout, stderr) => {
+    if (error) {
+      console.error(`exec error: ${error}`);
+      return;
+    }
+    console.log(`stdout: ${stdout}`);
+    console.error(`stderr: ${stderr}`);
+  });
+}
+runCli();

package/dist/module.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/module.js

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// module.ts
+var import_cli = __toESM(require("@extension-create/cli"));
+(0, import_cli.default)();

package/package.json

@@ -1,22 +1,47 @@
 {
-  "name": "extension",
-  "description": "Framework for selectively extending JavaScript objects.",
-  "version": "0.2.0",
-  "author": "Jeff Kunkle <jeff.kunkle@nearinfinity.com>",
-  "keywords": ["prototype", "extension"],
-  "repository": { "type": "git", "url": "https://github.com/nearinfinity/node-extension.git" },
-  "engines": { "node" : ">=0.6.0" },
-  "bugs": { "url": "https://github.com/nearinfinity/node-extension/issues" },
   "license": "MIT",
-  "maintainers": [
-    { "name": "Jeff Kunkle", "email": "jeff.kunkle@nearinfinity.com" }
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cezaraugusto/extension-create.git"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "name": "extension",
+  "version": "1.1.1",
+  "description": "Create cross-browser extensions with no build configuration.",
+  "main": "./dist/cli.js",
+  "types": "./dist/cli.d.ts",
+  "files": [
+    "dist"
   ],
-  "devDependencies": {
-    "mocha": "~0.12.1",
-    "chai": "~0.3.4"
+  "bin": {
+    "extension": "./dist/cli.js"
+  },
+  "author": {
+    "name": "Cezar Augusto",
+    "email": "boss@cezaraugusto.net",
+    "url": "https://cezaraugusto.com"
   },
   "scripts": {
-    "test": "mocha -R spec"
+    "compile:readme-files": "node ./scripts/copyMarkdownFilesToCli.js",
+    "compile:cli": "tsup-node ./cli.ts --format cjs --dts --target=node18",
+    "compile": "yarn compile:readme-files && yarn compile:cli"
   },
-  "main": "./lib/extension.js"
+  "keywords": [
+    "zero-config",
+    "build",
+    "develop",
+    "browser",
+    "extension",
+    "chrome extension",
+    "edge extension",
+    "firefox extension",
+    "web",
+    "react",
+    "typescript"
+  ],
+  "dependencies": {
+    "@extension-create/cli": "*"
+  }
 }

package/.npmignore

@@ -1,2 +0,0 @@
-node_modules
-coverage

package/lib/array.js

@@ -1,77 +0,0 @@
-'use strict';
-
-module.exports = {
-  contains: function (source, obj) {
-    if (arguments.length < 2) {
-      obj = source;
-      source = this;
-    }
-    if (!Array.isArray(source)) {
-      return false;
-    }
-
-    for (var i = 0, l = source.length; i < l; i++) {
-      if (source[i] === obj) {
-        return true;
-      }
-    }
-    return false;
-  },
-
-  isEmpty: function (obj) {
-    obj = arguments.length > 0 ? obj : this;
-    return obj.length < 1;
-  },
-
-  sortCaseInsensitive: function (obj) {
-    obj = arguments.length > 0 ? obj : this;
-    return obj.sort(function (a, b) {
-      a = String(a).toUpperCase();
-      b = String(b).toUpperCase();
-      if (a > b) {
-        return 1;
-      }
-      if (a < b) {
-        return -1;
-      }
-      return 0;
-    });
-  },
-
-  first: function (source, fn) {
-    if (arguments.length < 2) {
-      fn = source;
-      source = this;
-    }
-    for (var i = 0, l = source.length; i < l; i++) {
-      if (fn(source[i])) {
-        return source[i];
-      }
-    }
-  },
-
-  // fn
-  // source, fn
-  groupBy: function () {
-    var source, fn;
-    if (arguments.length === 1) {
-      source = this;
-      fn = arguments[0];
-    } else {
-      source = arguments[0];
-      fn = arguments[1];
-    }
-    var results = {};
-
-    var length = source.length;
-    for (var i = 0; i < length; i++) {
-      var key = fn(source[i]);
-      if (key in results) {
-        results[key].push(source[i]);
-      } else {
-        results[key] = [source[i]];
-      }
-    }
-    return results;
-  }
-};

package/lib/extension.js

@@ -1,122 +0,0 @@
-'use strict';
-
-var objext = require('./object');
-var extensionKeys = [];
-var extensionObjs = [];
-
-var register = exports.register = function (obj, extObj) {
-  verifyPresent('Object to be extended cannot be null or undefined', obj);
-  verifyPresent('Extensions cannot be null or undefined', extObj);
-
-  if (objext.isEmpty(extObj)) {
-    return;
-  }
-
-  var index = extensionKeys.indexOf(obj);
-  if (index > -1) {
-    Object.keys(extObj).forEach(function(ext) {
-      extensionObjs[index][ext] = extObj[ext];
-    });
-  } else {
-    extensionKeys.push(obj);
-    extensionObjs.push(extObj);
-  }
-};
-
-var registerAndUse = exports.registerAndUse = function (obj, extObj) {
-  register(obj, extObj);
-  use(obj);
-};
-
-var find = exports.find = function (obj) {
-  verifyPresent('object argument is required', obj);
-
-  var index = extensionKeys.indexOf(obj);
-  if (index > -1) {
-    return extensionObjs[index];
-  } else {
-    return undefined;
-  }
-};
-
-var use = exports.use = function (obj, props, fn) {
-  verifyPresent('Object on which to use extensions cannot be null or undefined', obj);
-
-  if (typeof props === 'function') {
-    fn = props;
-    props = undefined;
-  }
-
-  var props = getProps(obj, props);
-
-  if (fn === undefined) {
-    addProps(obj, props);
-  } else {
-    try {
-      addProps(obj, props);
-      fn();
-    } finally {
-      removeProps(obj, props);
-    }
-  }
-};
-
-function addProps(obj, props) {
-  var index = extensionKeys.indexOf(obj);
-  if (index < 0) {
-    return;
-  }
-
-  props.forEach(function(prop) {
-    var ext = extensionObjs[index][prop];
-    if (ext) {
-      Object.defineProperty(obj, prop, {
-        value: ext,
-        configurable: true
-      });
-    }
-  });
-}
-
-function removeProps(obj, props) {
-  props.forEach(function(prop) {
-    if (obj[prop]) {
-      delete obj[prop];
-    }
-  });
-}
-
-function getProps(obj, props) {
-  if (props === null || props === undefined) {
-    var index = extensionKeys.indexOf(obj);
-    return index > -1 ? Object.keys(extensionObjs[index]) : [];
-  }
-
-  if (!Array.isArray(props)) {
-    props = [props];
-  }
-
-  props.forEach(verifyProp.bind(this, obj));
-  props = props.filter(function(prop) {
-    return obj[prop] === undefined;
-  });
-
-  return props;
-}
-
-function verifyProp(obj, prop) {
-  var index = extensionKeys.indexOf(obj);
-  if (index < 0 || extensionObjs[index][prop] === undefined) {
-    throw new Error(obj + '#' + prop + ' extension not found.');
-  }
-}
-
-function verifyPresent(message, obj) {
-  if (obj === null || obj === undefined) {
-    throw new Error(message);
-  }
-}
-
-exports.string = require('./string');
-exports.object = require('./object');
-exports.array = require('./array');

package/lib/object.js

@@ -1,60 +0,0 @@
-'use strict';
-
-module.exports = {
-  isString: function (obj) {
-    obj = arguments.length > 0 ? obj : this;
-    return typeof obj === 'string';
-  },
-
-  isFunction: function (obj) {
-    obj = arguments.length > 0 ? obj : this;
-    return typeof obj === 'function';
-  },
-
-  isArray: function (obj) {
-    obj = arguments.length > 0 ? obj : this;
-    return Array.isArray(obj);
-  },
-
-  isNumber: function (obj) {
-    obj = arguments.length > 0 ? obj : this;
-    return typeof obj === 'number';
-  },
-
-  isObject: function (obj) {
-    obj = arguments.length > 0 ? obj : this;
-    return obj !== null &&
-      !Array.isArray(obj) &&
-      typeof obj === 'object';
-  },
-
-  isEmpty: function (obj) {
-    obj = arguments.length > 0 ? obj : this;
-    if (obj === null || obj === undefined) {
-      return true;
-    }
-    if (module.exports.isObject(obj)) {
-      return Object.keys(obj).length < 1;
-    } else if (Array.isArray(obj)) {
-      return obj.length < 1;
-    } else {
-      return false;
-    }
-  },
-
-  toArray: function (obj) {
-    obj = arguments.length > 0 ? obj : this;
-    var results = [];
-    for (var k in obj) {
-      if (!obj.hasOwnProperty(k)) {
-        continue;
-      }
-      results.push({
-        key: k,
-        value: obj[k]
-      })
-    }
-    return results;
-  }
-};
-