✨ Init

Author: MethodGrab

.eslintrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+	extends: [
+		'@methodgrab/standard',
+		'@methodgrab/standard/browser',
+		'@methodgrab/standard/esnext',
+	],
+
+	env: {},
+
+	globals:  {},
+
+	rules: {
+		'no-param-reassign'     : 'off',
+		'no-unused-expressions' : [ 'warn', { allowShortCircuit: true, allowTernary: true } ],
+	},
+};

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+npm-debug.log

LICENSE.md

@@ -0,0 +1,7 @@
+ISC License
+
+Copyright (c) 2016, Nick (@methodgrab)
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -0,0 +1,38 @@
+# Custom New Tab Page
+> Specify a custom URL to show when opening new tabs, _without changing the address bar_.
+
+
+## Usage
+To set your custom new tab url:
+- Open `about:addons`
+- Select `Extensions`
+- Select the `Custom New Tab Page` extension → `Options`
+- Enter your URL in the `New Tab URL` box
+- Done!
+
+
+## Development
+
+Testing unsigned extensions only works with [non-release](https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/jpm#Install_a_different_version_of_Firefox) [builds](https://wiki.mozilla.org/Add-ons/Extension_Signing). To install the unsigned extension:
+- Open Firefox Developer Edition
+- Install the [Extension Auto-Installer](https://addons.mozilla.org/en-US/firefox/addon/autoinstaller) add-on
+- Open `about:config`
+- set `xpinstall.signatures.required` to `false`
+- Close Firefox Developer Edition
+- `npm run start` to load Firefox Developer Edition with the extension installed
+- `npm run watch` to watch for changes and [reload the extension automatically](https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/jpm#Developing_without_browser_restarts)
+
+_NB: These `npm` commands assume you're on Windows with Firefox Developer Edition installed, modify the paths as needed._
+
+
+### Logging
+To show [log messages](https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/console#Logging_Levels) during development:
+- Open `about:config`
+- Create a new string value called `[email protected]` with a value of `all`
+
+
+## Release Process
+
+After making changes to the extension, do the following to publish a new version:
+1. `npm run package` to bundle the `xpi` file
+1. Upload the generated `xpi` to https://addons.mozilla.org/en-US/developers/addons

data/app.css

@@ -0,0 +1,23 @@
+.cntp-has-loaded *,
+.cntp-has-loaded *:before,
+.cntp-has-loaded *:after {
+	margin: 0;
+	padding: 0;
+}
+
+.cntp-has-loaded body {
+	display: block;
+	position: relative;
+	overflow: hidden;
+	width: 100vw;
+	height: 100vh;
+}
+
+.cntp-has-loaded .cntp__iframe {
+	position: absolute;
+	top: 0;
+	left: 0;
+	width: 100vw;
+	height: 100vh;
+	border: 0;
+}

data/app.js

@@ -0,0 +1,18 @@
+const showCustomPage = customNewTabUrl => {
+	console.debug( '[showCustomPage] init', { customNewTabUrl } );
+
+	// no tab URL set, do nothing
+	if ( !customNewTabUrl || !customNewTabUrl.length ) {
+		console.debug( '[showCustomPage] no tab url set' );
+		return false;
+	}
+
+	document.querySelector( 'html' ).classList.add( 'cntp-has-loaded' );
+
+	const content = `<iframe class="cntp__iframe" src="${customNewTabUrl}"></iframe>`;
+	document.body.innerHTML = content;
+
+	return true;
+};
+
+self.port.on( 'showCustomPage', showCustomPage );

index.js

@@ -0,0 +1,25 @@
+const self    = require( 'sdk/self' );
+const pageMod = require( 'sdk/page-mod' );
+const tabs    = require( 'sdk/tabs' );
+const sp      = require( 'sdk/simple-prefs' );
+
+const NEW_TAB_URL = 'about:newtab';
+
+
+pageMod.PageMod({
+	include           : [ NEW_TAB_URL ],
+	contentScriptFile : './app.js',
+	contentStyleFile  : './app.css',
+	onAttach( worker ) {
+		worker.port.emit( 'showCustomPage', sp.prefs.customNewTabUrl );
+	},
+});
+
+
+// Listen for tab openings
+tabs.on( 'open', function onOpen( tab ) {
+	if ( tab.url === NEW_TAB_URL ) {
+		// redirect so pageMod can intercept
+		tab.url = NEW_TAB_URL;
+	}
+});

package.json

@@ -0,0 +1,42 @@
+{
+  "title": "Custom New Tab Page",
+  "name": "custom-new-tab-page",
+  "id": "[email protected]",
+  "version": "0.1.0",
+  "description": "Specify a custom URL to show when opening new tabs, without changing the address bar",
+  "homepage": "https://github.com/methodgrab/firefox-custom-new-tab-page",
+  "main": "index.js",
+  "author": "MethodGrab",
+  "engines": {
+    "firefox": ">=38.0a1"
+  },
+  "license": "ISC",
+  "keywords": [
+    "custom",
+    "new",
+    "tab",
+    "page",
+    "url"
+  ],
+  "scripts": {
+    "test": "npm run lint",
+    "lint": "eslint **/*.js",
+    "start": "jpm run --binary \"C:\\Program Files (x86)\\Firefox Developer Edition\\firefox.exe\" -p dev-edition-default",
+    "watch": "jpm watchpost --post-url http://localhost:8888/",
+    "package": "jpm xpi"
+  },
+  "devDependencies": {
+    "@methodgrab/eslint-config-standard": "^0.10.0",
+    "eslint": "^3.8.0",
+    "jpm": "^1.2.2"
+  },
+  "preferences": [
+    {
+      "name": "customNewTabUrl",
+      "title": "New Tab URL",
+      "description": "The URL to show when a new tab is opened",
+      "type": "string",
+      "value": ""
+    }
+  ]
+}