Ignore comments in an ignored block (#428)

* updating dependencies

* linting test config

* comments inside blocks are considered as already printed

* couldn`t get around this one

Author: Janther

package-lock.json

@@ -61,22 +61,22 @@
     "node": ">=10"
   },
   "devDependencies": {
-    "codecov": "^3.6.5",
-    "eslint": "^7.3.1",
-    "eslint-config-airbnb-base": "^14.1.0",
+    "codecov": "^3.8.1",
+    "eslint": "^7.19.0",
+    "eslint-config-airbnb-base": "^14.2.1",
     "eslint-config-prettier": "^7.0.0",
-    "eslint-plugin-import": "^2.20.2",
-    "jest": "^26.0.1",
+    "eslint-plugin-import": "^2.22.1",
+    "jest": "^26.6.3",
     "jest-mock-now": "^1.3.0",
-    "jest-watch-typeahead": "^0.6.0"
+    "jest-watch-typeahead": "^0.6.1"
   },
   "dependencies": {
     "@solidity-parser/parser": "^0.11.0",
     "dir-to-object": "^2.0.0",
-    "emoji-regex": "^9.0.0",
+    "emoji-regex": "^9.2.1",
     "escape-string-regexp": "^4.0.0",
-    "prettier": "^2.0.5",
-    "semver": "^7.3.2",
+    "prettier": "^2.2.1",
+    "semver": "^7.3.4",
     "solidity-comments-extractor": "^0.0.4",
     "string-width": "^4.2.0"
   }

package.json

@@ -0,0 +1,18 @@
+function ignoreComments(node) {
+  if (node === undefined || node === null) return;
+  const keys = Object.keys(node);
+  keys.forEach((key) => {
+    if (key === 'comments') {
+      node.comments.forEach((comment) => {
+        // eslint-disable-next-line no-param-reassign
+        comment.printed = true;
+      });
+      return;
+    }
+    if (typeof node[key] === 'object') {
+      ignoreComments(node[key]);
+    }
+  });
+}
+
+module.exports = ignoreComments;

src/comments/ignore.js

@@ -1,5 +1,6 @@
 const nodes = require('./nodes');
 const { hasNodeIgnoreComment } = require('./prettier-comments/common/util.js');
+const ignoreComments = require('./comments/ignore.js');
 
 function genericPrint(path, options, print) {
   const node = path.getValue();
@@ -12,6 +13,8 @@ function genericPrint(path, options, print) {
   }
 
   if (hasNodeIgnoreComment(node)) {
+    ignoreComments(node);
+
     return options.originalText.slice(
       options.locStart(node),
       options.locEnd(node) + 1

src/printer.js

@@ -16,3 +16,20 @@ contract PrettierIgnore {
         );
     }
 }
+
+// prettier-ignore
+contract Example {
+// Test comment
+    function() public payable {        
+        // this should be marked as printed
+        // Everything inside is also ignored
+        matrix(
+            1, 0, 0,
+            0, 1, 0,
+            0, 0, 1
+        );
+        if (true) {
+            // comments of children should be marked as printed
+        }
+    }
+}

tests/PrettierIgnore/PrettierIgnore.sol

@@ -19,6 +19,23 @@ contract PrettierIgnore {
         );
     }
 }
+
+// prettier-ignore
+contract Example {
+// Test comment
+    function() public payable {        
+        // this should be marked as printed
+        // Everything inside is also ignored
+        matrix(
+            1, 0, 0,
+            0, 1, 0,
+            0, 0, 1
+        );
+        if (true) {
+            // comments of children should be marked as printed
+        }
+    }
+}
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 pragma solidity ^0.5.2;
 
@@ -35,4 +52,21 @@ contract PrettierIgnore {
     }
 }
 
+// prettier-ignore
+contract Example {
+// Test comment
+    function() public payable {        
+        // this should be marked as printed
+        // Everything inside is also ignored
+        matrix(
+            1, 0, 0,
+            0, 1, 0,
+            0, 0, 1
+        );
+        if (true) {
+            // comments of children should be marked as printed
+        }
+    }
+}
+
 `;

tests/PrettierIgnore/__snapshots__/jsfmt.spec.js.snap

@@ -0,0 +1,44 @@
+const fs = require('fs');
+const path = require('path');
+const prettier = require('prettier');
+
+function mergeDefaultOptions(parserConfig) {
+  return {
+    plugins: [path.dirname(__dirname)],
+    printWidth: 80,
+    ...parserConfig
+  };
+}
+
+function prettyprint(src, options) {
+  const result = prettier.formatWithCursor(src, options);
+  if (options.cursorOffset >= 0) {
+    result.formatted = `${result.formatted.slice(
+      0,
+      result.cursorOffset
+    )}<|>${result.formatted.slice(result.cursorOffset)}`;
+  }
+  return result.formatted;
+}
+
+/**
+ * Wraps a string in a marker object that is used by `./raw-serializer.js` to
+ * directly print that string in a snapshot without escaping all double quotes.
+ * Backticks will still be escaped.
+ */
+function raw(string) {
+  if (typeof string !== 'string') {
+    throw new Error('Raw snapshots have to be strings.');
+  }
+  return { [Symbol.for('raw')]: string };
+}
+
+function read(filename) {
+  return fs.readFileSync(filename, 'utf8');
+}
+
+function parse(string, opts) {
+  return prettier.__debug.parse(string, opts, /* massage */ true).ast;
+}
+
+module.exports = { mergeDefaultOptions, parse, prettyprint, raw, read };

tests_config/helpers.js

@@ -1,6 +1,4 @@
 // source: https://github.com/prettier/prettier/blob/ee2839bacbf6a52d004fa2f0373b732f6f191ccc/tests_config/raw-serializer.js
-'use strict';
-
 const RAW = Symbol.for('raw');
 
 module.exports = {

tests_config/raw-serializer.js

@@ -1,16 +1,19 @@
 // source: https://github.com/prettier/prettier/blob/ee2839bacbf6a52d004fa2f0373b732f6f191ccc/tests_config/run_spec.js
-'use strict';
-
 const fs = require('fs');
 const path = require('path');
+const {
+  read,
+  mergeDefaultOptions,
+  prettyprint,
+  raw,
+  parse
+} = require('./helpers');
 
-const AST_COMPARE = process.env['AST_COMPARE'];
-
-const prettier = require('prettier');
+const { AST_COMPARE } = process.env;
 
-function run_spec(dirname, options) {
-  fs.readdirSync(dirname).forEach(filename => {
-    const filepath = dirname + '/' + filename;
+function runSpec(dirname, options) {
+  fs.readdirSync(dirname).forEach((filename) => {
+    const filepath = `${dirname}/${filename}`;
     if (
       path.extname(filename) !== '.snap' &&
       fs.lstatSync(filepath).isFile() &&
@@ -45,16 +48,16 @@ function run_spec(dirname, options) {
       const output = prettyprint(input, mergedOptions);
       test(filename, () => {
         expect(
-          raw(source + '~'.repeat(mergedOptions.printWidth) + '\n' + output)
+          raw(`${source + '~'.repeat(mergedOptions.printWidth)}\n${output}`)
         ).toMatchSnapshot();
       });
 
       if (AST_COMPARE) {
         test(`${filepath} parse`, () => {
-          const compareOptions = Object.assign({}, mergedOptions);
+          const compareOptions = { ...mergedOptions };
           delete compareOptions.cursorOffset;
           const astMassaged = parse(input, compareOptions);
-          let ppastMassaged = undefined;
+          let ppastMassaged;
 
           expect(() => {
             ppastMassaged = parse(
@@ -73,45 +76,4 @@ function run_spec(dirname, options) {
   });
 }
 
-global.run_spec = run_spec;
-
-function parse(string, opts) {
-  return prettier.__debug.parse(string, opts, /* massage */ true).ast;
-}
-
-function prettyprint(src, options) {
-  const result = prettier.formatWithCursor(src, options);
-  if (options.cursorOffset >= 0) {
-    result.formatted =
-      result.formatted.slice(0, result.cursorOffset) +
-      '<|>' +
-      result.formatted.slice(result.cursorOffset);
-  }
-  return result.formatted;
-}
-
-function read(filename) {
-  return fs.readFileSync(filename, 'utf8');
-}
-
-/**
- * Wraps a string in a marker object that is used by `./raw-serializer.js` to
- * directly print that string in a snapshot without escaping all double quotes.
- * Backticks will still be escaped.
- */
-function raw(string) {
-  if (typeof string !== 'string') {
-    throw new Error('Raw snapshots have to be strings.');
-  }
-  return { [Symbol.for('raw')]: string };
-}
-
-function mergeDefaultOptions(parserConfig) {
-  return Object.assign(
-    {
-      plugins: [path.dirname(__dirname)],
-      printWidth: 80
-    },
-    parserConfig
-  );
-}
+global.run_spec = runSpec;