Merge pull request #1 from ChristianMurphy/refactor/unified-message-control

refactor: unified-message-control

Author: ChristianMurphy

.gitignore

@@ -3,5 +3,5 @@
 .nyc_output/
 coverage/
 node_modules/
-remark-message-control.js
-remark-message-control.min.js
+unified-message-control.js
+unified-message-control.min.js

index.js

@@ -3,7 +3,6 @@
 var trim = require('trim');
 var location = require('vfile-location');
 var visit = require('unist-util-visit');
-var marker = require('mdast-comment-marker');
 
 /* Map of allowed verbs. */
 var ALLOWED_VERBS = {
@@ -16,6 +15,8 @@ module.exports = messageControl;
 
 function messageControl(options) {
   var name = options && options.name;
+  var marker = options && options.marker;
+  var test = options && options.test;
   var sources;
   var known;
   var reset;
@@ -26,6 +27,14 @@ function messageControl(options) {
     throw new Error('Expected `name` in `options`, got `' + name + '`');
   }
 
+  if (!marker) {
+    throw new Error('Expected `name` in `options`, got `' + name + '`');
+  }
+
+  if (!test) {
+    throw new Error('Expected `test` in `options`, got `' + test + '`');
+  }
+
   known = options.known;
   reset = options.reset;
   enable = options.enable || [];
@@ -47,7 +56,7 @@ function messageControl(options) {
     var scope = {};
     var globals = [];
 
-    visit(tree, 'html', visitor);
+    visit(tree, test, visitor);
 
     file.messages = file.messages.filter(filter);
 
@@ -74,8 +83,10 @@ function messageControl(options) {
 
       if (!verb || !ALLOWED_VERBS[verb] === true) {
         file.fail(
-          'Unknown keyword `' + verb + '`: expected ' +
-          '`\'enable\'`, `\'disable\'`, or `\'ignore\'`',
+          'Unknown keyword `' +
+            verb +
+            '`: expected ' +
+            '`\'enable\'`, `\'disable\'`, or `\'ignore\'`',
           mark.node
         );
       }
@@ -132,10 +143,7 @@ function messageControl(options) {
       pos = toOffset(message);
 
       while (gapIndex--) {
-        if (
-          gaps[gapIndex].start <= pos &&
-          gaps[gapIndex].end > pos
-        ) {
+        if (gaps[gapIndex].start <= pos && gaps[gapIndex].end > pos) {
           return false;
         }
       }
@@ -217,7 +225,8 @@ function messageControl(options) {
 
         if (
           range.position.line < message.line ||
-          (range.position.line === message.line && range.position.column < message.column)
+          (range.position.line === message.line &&
+            range.position.column < message.column)
         ) {
           return range.state === true;
         }
@@ -258,10 +267,7 @@ function detectGaps(tree, file) {
     update();
 
     update(
-      tree &&
-      tree.position &&
-      tree.position.end &&
-      tree.position.end.offset - 1
+      tree && tree.position && tree.position.end && tree.position.end.offset - 1
     );
   }
 

package.json

@@ -1,10 +1,10 @@
 {
-  "name": "remark-message-control",
-  "version": "4.0.2",
-  "description": "Enable, disable, and ignore messages with remark",
+  "name": "unified-message-control",
+  "version": "0.0.0",
+  "description": "Enable, disable, and ignore messages from unified processors",
   "license": "MIT",
   "keywords": [
-    "remark",
+    "unified",
     "comment",
     "message",
     "marker",
@@ -20,14 +20,14 @@
     "index.js"
   ],
   "dependencies": {
-    "mdast-comment-marker": "^1.0.0",
     "trim": "0.0.1",
     "unist-util-visit": "^1.0.0",
     "vfile-location": "^2.0.0"
   },
   "devDependencies": {
     "browserify": "^14.0.0",
     "esmangle": "^1.0.0",
+    "mdast-comment-marker": "^1.0.2",
     "nyc": "^11.0.0",
     "remark": "^8.0.0",
     "remark-cli": "^4.0.0",
@@ -38,8 +38,8 @@
   },
   "scripts": {
     "build-md": "remark . -qfo",
-    "build-bundle": "browserify index.js --bare -s remarkMessageControl > remark-message-control.js",
-    "build-mangle": "esmangle remark-message-control.js > remark-message-control.min.js",
+    "build-bundle": "browserify index.js --bare -s unifiedMessageControl > unified-message-control.js",
+    "build-mangle": "esmangle unified-message-control.js > unified-message-control.min.js",
     "build": "npm run build-md && npm run build-bundle && npm run build-mangle",
     "lint": "xo",
     "test-api": "node test.js",

readme.md

@@ -1,4 +1,4 @@
-# remark-message-control [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat]
+# unified-message-control [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat]
 
 Enable, disable, and ignore messages with [**remark**][remark].
 
@@ -163,17 +163,17 @@ repository, organisation, or community you agree to abide by its terms.
 
 <!-- Definitions -->
 
-[build-badge]: https://img.shields.io/travis/remarkjs/remark-message-control.svg
+[build-badge]: https://img.shields.io/travis/unifiedjs/unified-message-control.svg
 
-[build-status]: https://travis-ci.org/remarkjs/remark-message-control
+[build-status]: https://travis-ci.org/unifiedjs/unified-message-control
 
 [coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-message-control.svg
 
 [coverage-status]: https://codecov.io/github/remarkjs/remark-message-control
 
-[chat-badge]: https://img.shields.io/gitter/room/remarkjs/Lobby.svg
+[chat-badge]: https://img.shields.io/gitter/room/unifiedjs/Lobby.svg
 
-[chat]: https://gitter.im/remarkjs/Lobby
+[chat]: https://gitter.im/unifiedjs/Lobby
 
 [license]: LICENSE