Document how to ignore sections of files, or whole files

[NateRadebaugh]

[alexander-akait]

@NateRadebaugh Should be works https://prettier.io/docs/en/ignore.html. If some code will be change with comment(s) please create new issue with examples. Thanks!

[NateRadebaugh]

That's for whole files, but how do we ignore a section of a file? I have some graphql in my PHP I don't want to be collapsed.

[alexander-akait]

@NateRadebaugh Can you provide example? Should works:

<!-- prettier-ignore-start -->
$var   =   1;
<!-- prettier-ignore-end -->

[sseypt]

@evilebottnawi What am I missing here?

Input:

<?php

// <!-- prettier-ignore-start -->
$var1   =   1;
// <!-- prettier-ignore-end -->

/* <!-- prettier-ignore-start --> */
$var2   =   1;
/* <!-- prettier-ignore-end --> */

// prettier-ignore
$var3   =   1;

/* prettier-ignore */
$var4   =   1;

Output:

<?php
// <!-- prettier-ignore-start -->
$var1 = 1;
// <!-- prettier-ignore-end -->
/* <!-- prettier-ignore-start --> */
$var2 = 1;
/* <!-- prettier-ignore-end --> */

// prettier-ignore
$var3 = 1;

/* prettier-ignore */
$var4 = 1;

Nothing is ignored.

[nikolasmatt]

To respect ignores we need the printer to export a hasPrettierIgnore function like here

So far only built-in language that supports start-to-end ignore is markdown but it's implementation is not too complicated

We need to decide out which markers we want to use for php. Using /* <!-- prettier-ignore-start/end --> */ seems like an overkill, maybe just /* prettier-ignore-start/end */ ?

Additionally, personal opinion would be to add an @ to the front of these similar to PHP_CodeSniffer tags, but there is something to say for consistency with prettier.

Lastly, I have something almost there in this branch but I'm facing an issue where it drops the semicolon at the end of the node. I've spend a couple of hours and I'm not getting anywhere. Would much appreciate a second pair of eyes!
Seems to me like options.locEnd(node) points to the character before the ; here

[mgrip]

Awesome thanks @nikolasmatt! 🎉

My vote would be for the regular php comments as well. Looks like the way you have it implemented either // @prettier-ignore or // prettier-ignore will work. And where exactly is the problem with the semicolon? The test output looks good from what I can see

[nikolasmatt]

tests in my branch don't pass

input:

// prettier-ignore
$var1   =   1;

current output

// prettier-ignore
$var1   =   1

[mgrip]

Gotchya - is that the only failing one?

The locEnd is behaving as expected because the semicolon isn't part of the assign node. Normally when the node gets run through print we see if a semicolon should be added for that node type here: https://github.com/prettier/plugin-php/blob/master/src/printer.js#L170, but because this doesn't go through print that doesn't happen. Im not sure how this works for JS...

[nikolasmatt]

All the ones that end with a ; fail. The function one passes because it doesn't have a semicolon in the end.
In js the equivalent node ("type": "VariableDeclaration") includes the semicolon but doesn't include it in it's children ("declarations").

Test script I used:

"use strict";
console.log(
  JSON.stringify(
    require("@babel/parser").parse(
      "// prettier-ignore\nconst a = 1;",
      { sourceType: "module"}
    )
  )
);

output (paste it on a json prettifier):

{"type":"File","start":0,"end":31,"loc":{"start":{"line":1,"column":0},"end":{"line":2,"column":12}},"program":{"type":"Program","start":0,"end":31,"loc":{"start":{"line":1,"column":0},"end":{"line":2,"column":12}},"sourceType":"module","interpreter":null,"body":[{"type":"VariableDeclaration","start":19,"end":31,"loc":{"start":{"line":2,"column":0},"end":{"line":2,"column":12}},"declarations":[{"type":"VariableDeclarator","start":25,"end":30,"loc":{"start":{"line":2,"column":6},"end":{"line":2,"column":11}},"id":{"type":"Identifier","start":25,"end":26,"loc":{"start":{"line":2,"column":6},"end":{"line":2,"column":7},"identifierName":"a"},"name":"a"},"init":{"type":"NumericLiteral","start":29,"end":30,"loc":{"start":{"line":2,"column":10},"end":{"line":2,"column":11}},"extra":{"rawValue":1,"raw":"1"},"value":1}}],"kind":"const","leadingComments":[{"type":"CommentLine","value":" prettier-ignore","start":0,"end":18,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":18}}}]}],"directives":[]},"comments":[{"type":"CommentLine","value":" prettier-ignore","start":0,"end":18,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":18}}}]}