Reconfigure webpack to export javascript rule files separately

.npmignore

@@ -7,4 +7,5 @@
 !README.md
 !bin/addons-linter
 !dist/addons-linter.*
-!dist/locale/**
+!dist/locale/**
+!dist/rules/**

.travis.yml

@@ -3,9 +3,9 @@ node_js:
   - 'v10.21.0'
   - 'v12.18.0'
 script:
-  - npm run test-ci
   - node scripts/build-locales
   - npm run build
+  - npm run test-ci
   - npm run lint
   # run integration tests using an addons-linter binary in a production-like environment
   - npm run test-integration:production

README.md

@@ -109,6 +109,8 @@ If you have Node.js installed, here's the quick start to getting your developmen
 git clone https://github.com/mozilla/addons-linter.git
 cd addons-linter
 npm install
+# Build the project.
+npm run build
 # Run the test-suite and watch for changes. Use `npm run test-once` to
 # just run it once.
 npm run test
@@ -156,7 +158,7 @@ Dependencies are automatically kept up-to-date using [renovatebot](https://renov
 
 ### Building
 
-You can run `npm build` to build the library.
+You can run `npm run build` to build the library.
 
 Once you build the library you can use the CLI in `bin/addons-linter`.
 

src/main.js

@@ -17,4 +17,8 @@ export function createInstance({
   return new Linter(config);
 }
 
-export default Linter;
+export default {
+  Linter,
+  createInstance,
+  isRunFromCLI,
+};

src/rules/javascript/content-scripts-file-absent.js

@@ -6,7 +6,7 @@ import {
   CONTENT_SCRIPT_EMPTY,
 } from 'messages/javascript';
 
-module.exports = {
+export default {
   create(context) {
     const existingFiles = Object.keys(context.settings.existingFiles || {}).map(
       (fileName) => {

src/rules/javascript/deprecated-entities.js

@@ -9,9 +9,7 @@ export const DEPRECATED_ENTITIES = [
   },
 ];
 
-module.exports = {
-  DEPRECATED_ENTITIES,
-
+export default {
   create(context) {
     return {
       // eslint-disable-next-line consistent-return

src/rules/javascript/event-listener-fourth.js

@@ -1,7 +1,7 @@
 import { EVENT_LISTENER_FOURTH } from 'messages/javascript';
 import { getNodeReference } from 'utils';
 
-module.exports = {
+export default {
   create(context) {
     return {
       // eslint-disable-next-line consistent-return

src/rules/javascript/global-require-arg.js

@@ -2,10 +2,9 @@ import { UNEXPECTED_GLOGAL_ARG } from 'messages';
 import { getVariable } from 'utils';
 
 /*
- * This rule will detect a global passed to `require()` as the first arg
- *
+ * This rule will detect a global passed to `require()` as the first argument.
  */
-module.exports = {
+export default {
   create(context) {
     return {
       // eslint-disable-next-line consistent-return

src/rules/javascript/opendialog-nonlit-uri.js

@@ -1,6 +1,6 @@
 import { OPENDIALOG_NONLIT_URI } from 'messages';
 
-module.exports = {
+export default {
   create(context) {
     return {
       // eslint-disable-next-line consistent-return

src/rules/javascript/opendialog-remote-uri.js

@@ -1,7 +1,7 @@
 import { isLocalUrl } from 'utils';
 import { OPENDIALOG_REMOTE_URI } from 'messages';
 
-module.exports = {
+export default {
   create(context) {
     return {
       // eslint-disable-next-line consistent-return

src/rules/javascript/webextension-api-compat-android.js

@@ -4,7 +4,7 @@ import { ANDROID_INCOMPATIBLE_API } from 'messages/javascript';
 import { createCompatibilityRule } from 'utils';
 import { hasBrowserApi } from 'schema/browser-apis';
 
-module.exports = {
+export default {
   create(context) {
     return createCompatibilityRule(
       'firefox_android',

src/rules/javascript/webextension-api-compat.js

@@ -4,7 +4,7 @@ import { INCOMPATIBLE_API } from 'messages/javascript';
 import { createCompatibilityRule } from 'utils';
 import { hasBrowserApi } from 'schema/browser-apis';
 
-module.exports = {
+export default {
   create(context) {
     return createCompatibilityRule(
       'firefox',

src/rules/javascript/webextension-api.js

@@ -1,7 +1,7 @@
 import { isTemporaryApi } from 'schema/browser-apis';
 import { apiToMessage, isBrowserNamespace } from 'utils';
 
-module.exports = {
+export default {
   create(context) {
     return {
       // eslint-disable-next-line consistent-return

src/rules/javascript/webextension-deprecated-api.js

@@ -3,7 +3,7 @@ import { DEPRECATED_JAVASCRIPT_APIS } from 'const';
 import { isDeprecatedApi, hasBrowserApi } from 'schema/browser-apis';
 import { isBrowserNamespace } from 'utils';
 
-module.exports = {
+export default {
   create(context) {
     return {
       MemberExpression(node) {

src/rules/javascript/webextension-unsupported-api.js

@@ -2,7 +2,7 @@ import { UNSUPPORTED_API } from 'messages/javascript';
 import { hasBrowserApi } from 'schema/browser-apis';
 import { isBrowserNamespace } from 'utils';
 
-module.exports = {
+export default {
   create(context) {
     return {
       MemberExpression(node) {

src/scanners/javascript.js

@@ -1,3 +1,4 @@
+/* global appRoot */
 import path from 'path';
 
 import ESLint from 'eslint';
@@ -39,10 +40,15 @@ export default class JavaScriptScanner {
     return 'javascript';
   }
 
-  async scan(
+  async scan({
     _ESLint = ESLint,
-    { _ruleMapping = ESLINT_RULE_MAPPING, _messages = messages } = {}
-  ) {
+    _messages = messages,
+    _ruleMapping = ESLINT_RULE_MAPPING,
+    // This tells ESLint where to expect the ESLint rules for addons-linter.
+    // Its default value is defined below. This property is mainly used for
+    // testing purposes.
+    _rulePaths = undefined,
+  } = {}) {
     this.sourceType = this.detectSourceType(this.filename);
 
     const rules = {};
@@ -64,7 +70,11 @@ export default class JavaScriptScanner {
         sourceType: this.sourceType,
       },
       rules,
-      rulePaths: [path.join(__dirname, '..', 'rules', 'javascript')],
+      // The default value for `rulePaths` is configured so that it finds the
+      // files exported by webpack when this project is built.
+      rulePaths: _rulePaths || [
+        path.join(appRoot, 'dist', 'rules', 'javascript'),
+      ],
       plugins: ['no-unsanitized'],
       allowInlineConfig: false,
 
@@ -104,7 +114,7 @@ export default class JavaScriptScanner {
         if (typeof message.message === 'undefined') {
           throw new Error(
             oneLine`JS rules must pass a valid message as
-          the second argument to context.report()`
+            the second argument to context.report()`
           );
         }
 

tests/fixtures/rules/javascript/message-rule/message-rule.js

@@ -0,0 +1,9 @@
+module.exports = {
+  create: (context) => {
+    return {
+      MemberExpression(node) {
+        context.report(node, 'this is the message');
+      },
+    };
+  },
+};

tests/fixtures/rules/javascript/metadata-not-passed/metadata-not-passed.js

@@ -0,0 +1,17 @@
+module.exports = {
+  create: (context) => {
+    return {
+      Identifier: (node) => {
+        const metadata = context.settings.addonMetadata;
+
+        if (typeof metadata !== 'object') {
+          context.report(node, 'Metadata should be an object.');
+        }
+
+        if (metadata.guid !== 'snowflake') {
+          context.report(node, 'Metadata properties not present.');
+        }
+      }
+    }
+  }
+};

tests/setup.js

@@ -1,3 +1,6 @@
+import fs from 'fs';
+import path from 'path';
+
 import sinon from 'sinon';
 
 // Setup sinon global to be a sandbox which is restored
@@ -22,6 +25,12 @@ jest.mock('cli', () => {
   };
 });
 
+global.appRoot = path.join(__dirname, '..');
+
+if (!fs.existsSync(path.join(global.appRoot, 'dist'))) {
+  throw new Error('Please run `npm run build` before running the test suite.');
+}
+
 afterEach(() => {
   global.sinon.restore();
 });

tests/unit/helpers.js

@@ -1,3 +1,4 @@
+import path from 'path';
 import fs from 'fs';
 import { Readable, Stream } from 'stream';
 import { assert } from 'assert';
@@ -240,17 +241,17 @@ export function getStreamableIO(files) {
     getFiles: () => {
       return Promise.resolve(files);
     },
-    getFileAsStream: (path) => {
+    getFileAsStream: (_path) => {
       if (
-        files[path] instanceof Stream &&
-        typeof files[path]._read === 'function' &&
-        typeof files[path]._readableState === 'object'
+        files[_path] instanceof Stream &&
+        typeof files[_path]._read === 'function' &&
+        typeof files[_path]._readableState === 'object'
       ) {
-        return Promise.resolve(files[path]);
+        return Promise.resolve(files[_path]);
       }
 
       const stream = new Readable();
-      stream.push(files[path]);
+      stream.push(files[_path]);
       stream.push(null);
       return Promise.resolve(stream);
     },
@@ -381,3 +382,9 @@ export function replacePlaceholders(text, data) {
     }
   );
 }
+
+export const FIXTURES_DIR = path.join(__dirname, '..', 'fixtures');
+
+export const getJsRulePathForRule = (ruleName) => {
+  return path.join(FIXTURES_DIR, 'rules', 'javascript', ruleName);
+};