Expose a consistent API for both ESM and CJS

.prettierignore

@@ -12,3 +12,4 @@ Dockerfile
 # white-list files we want to process
 !*.js
 !*.md
+!*.mjs

.travis.yml

@@ -12,8 +12,8 @@ before_install:
 - git checkout -
 - npm install -g npm;
 script:
-- npm run test-ci
 - npm run build
+- npm run test-ci
 - npm run lint
 - npm run prettier-ci
 - npm run typecheck

README.md

@@ -23,7 +23,7 @@ TODO: add a command line script ([issue #9](https://github.com/mozilla/sign-addo
 Here is how to retrieve a signed version of an [XPI file](https://developer.mozilla.org/en-US/docs/Mozilla/XPI):
 
 ```javascript
-var signAddon = require('sign-addon').default;
+var { signAddon } = require('sign-addon');
 
 signAddon({
   // Required arguments:
@@ -88,7 +88,7 @@ signAddon({
 In ES6 code, you can import it more concisely:
 
 ```javascript
-import signAddon from 'sign-addon';
+import { signAddon } from 'sign-addon';
 ```
 
 ## Dealing With Extension IDs

package.json

@@ -12,13 +12,13 @@
     "build": "rimraf dist/ && webpack",
     "changelog": "conventional-changelog -p angular -u",
     "changelog-lint": "commitlint --from master",
-    "eslint": "eslint .",
+    "eslint": "eslint . --ext mjs --ext js",
     "lint": "npm run eslint",
     "prettier": "prettier --write '**'",
-    "prettier-ci": "prettier --list-different '**' || (echo '\n\nThis failure means you did not run `yarn prettier-dev` before committing\n\n' && exit 1)",
+    "prettier-ci": "prettier --list-different '**' || (echo '\n\nThis failure means you did not run `npm run prettier-dev` before committing\n\n' && exit 1)",
     "prettier-dev": "pretty-quick --branch master",
     "test": "jest",
-    "test-ci": "yarn test --coverage && codecov",
+    "test-ci": "npm run test --coverage && codecov",
     "typecheck": "tsc"
   },
   "dependencies": {
@@ -30,8 +30,10 @@
     "jsonwebtoken": "8.5.1",
     "mz": "2.7.0",
     "request": "2.88.2",
+    "shelljs": "0.8.4",
     "source-map-support": "0.5.19",
-    "stream-to-promise": "3.0.0"
+    "stream-to-promise": "3.0.0",
+    "tmp": "0.2.1"
   },
   "devDependencies": {
     "@babel/core": "7.10.4",

src/index.js

@@ -141,4 +141,4 @@ export const signAddonAndExit = async (
   }
 };
 
-export default signAddon;
+export default { signAddon, signAddonAndExit };

tests/fixtures/import-as-esm/test-import.mjs

@@ -0,0 +1,11 @@
+import assert from 'assert';
+
+// eslint-disable-next-line import/no-unresolved
+import signAddon from 'sign-addon';
+
+assert.deepEqual(
+  Object.keys(signAddon).sort(),
+  ['signAddon', 'signAddonAndExit'].sort(),
+);
+assert.equal(typeof signAddon.signAddon, 'function');
+assert.equal(typeof signAddon.signAddonAndExit, 'function');

tests/fixtures/require-as-cjs/test-require.js

@@ -0,0 +1,11 @@
+const assert = require('assert');
+
+// eslint-disable-next-line import/no-unresolved
+const signAddon = require('sign-addon');
+
+assert.deepEqual(
+  Object.keys(signAddon).sort(),
+  ['signAddon', 'signAddonAndExit'].sort(),
+);
+assert.equal(typeof signAddon.signAddon, 'function');
+assert.equal(typeof signAddon.signAddonAndExit, 'function');

tests/functional/imports.spec.js

@@ -0,0 +1,48 @@
+import { execSync } from 'child_process';
+import path from 'path';
+
+import shell from 'shelljs';
+
+import { withTempDir } from '../test-util';
+
+describe(__filename, () => {
+  const node = shell.which('node');
+  const npm = shell.which('npm');
+  const fixturesDir = path.join(__dirname, '..', 'fixtures');
+  const fixtureEsmImport = path.join(fixturesDir, 'import-as-esm');
+  const fixtureCjsRequire = path.join(fixturesDir, 'require-as-cjs');
+
+  describe('imported as a library', () => {
+    beforeAll(() => {
+      execSync(`${npm} link`, {
+        cwd: path.resolve(path.join(__dirname, '..', '..')),
+      });
+    });
+
+    afterAll(() => {
+      execSync(`${npm} unlink`, {
+        cwd: path.resolve(path.join(__dirname, '..', '..')),
+      });
+    });
+
+    it('can be imported as an ESM module', async () => {
+      await withTempDir(async (tmpDir) => {
+        execSync(`${npm} link sign-addon`, { cwd: tmpDir.path() });
+        shell.cp('-rf', `${fixtureEsmImport}/*`, tmpDir.path());
+        execSync(`${node} --experimental-modules test-import.mjs`, {
+          cwd: tmpDir.path(),
+        });
+      });
+    });
+
+    it('can be imported as a CommonJS module', async () => {
+      await withTempDir(async (tmpDir) => {
+        execSync(`${npm} link sign-addon`, { cwd: tmpDir.path() });
+        shell.cp('-rf', `${fixtureCjsRequire}/*`, tmpDir.path());
+        execSync(`${node} --experimental-modules test-require.js`, {
+          cwd: tmpDir.path(),
+        });
+      });
+    });
+  });
+});