fix: insert pragma when first docblock mid-file (#1310) (#1311)

Author: leighman

src/pragma.js

@@ -5,10 +5,21 @@ const memoize = require("mem");
 
 const reHasPragma = /@prettier|@format/;
 
-const extractDocBlocks = memoize(text => {
+const getPageLevelDocBlock = memoize(text => {
   const parsed = parse(text);
 
-  return parsed.comments.filter(el => el.kind === "commentblock");
+  const [firstChild] = parsed.children;
+  const [firstDocBlock] = parsed.comments.filter(
+    el => el.kind === "commentblock"
+  );
+
+  if (
+    firstChild &&
+    firstDocBlock &&
+    firstDocBlock.loc.start.line < firstChild.loc.start.line
+  ) {
+    return firstDocBlock;
+  }
 });
 
 function guessLineEnding(text) {
@@ -27,10 +38,10 @@ function hasPragma(text) {
     return false;
   }
 
-  const [firstDocBlock] = extractDocBlocks(text);
+  const pageLevelDocBlock = getPageLevelDocBlock(text);
 
-  if (firstDocBlock) {
-    const { value } = firstDocBlock;
+  if (pageLevelDocBlock) {
+    const { value } = pageLevelDocBlock;
 
     return reHasPragma.test(value);
   }
@@ -59,17 +70,17 @@ function injectPragma(docblock, text) {
 }
 
 function insertPragma(text) {
-  const [firstDocBlock] = extractDocBlocks(text);
+  const pageLevelDocBlock = getPageLevelDocBlock(text);
 
-  if (firstDocBlock) {
+  if (pageLevelDocBlock) {
     const {
       start: { offset: startOffset },
       end: { offset: endOffset }
-    } = firstDocBlock.loc;
+    } = pageLevelDocBlock.loc;
     const before = text.substring(0, startOffset);
     const after = text.substring(endOffset);
 
-    return `${before}${injectPragma(firstDocBlock.value, text)}${after}`;
+    return `${before}${injectPragma(pageLevelDocBlock.value, text)}${after}`;
   }
 
   const openTag = "<?php";

tests/insert-pragma/__snapshots__/jsfmt.spec.js.snap

@@ -204,6 +204,129 @@ echo "Hello World";<LF>
 ================================================================================
 `;
 
+exports[`pragma-firstdocblockmidfile.php 1`] = `
+====================================options=====================================
+endOfLine: "cr"
+insertPragma: true
+parsers: ["php"]
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+<?php<LF>
+<LF>
+class Something<LF>
+{<LF>
+    function whatever ()<LF>
+    {<LF>
+        /**<LF>
+         * Some mid-file docblock<LF>
+         */<LF>
+        $variable = 3;<LF>
+    }<LF>
+}<LF>
+
+=====================================output=====================================
+<?php<CR>
+/**<CR>
+ * @format<CR>
+ */<CR>
+<CR>
+class Something<CR>
+{<CR>
+    function whatever()<CR>
+    {<CR>
+        /**<CR>
+         * Some mid-file docblock<CR>
+         */<CR>
+        $variable = 3;<CR>
+    }<CR>
+}<CR>
+
+================================================================================
+`;
+
+exports[`pragma-firstdocblockmidfile.php 2`] = `
+====================================options=====================================
+endOfLine: "crlf"
+insertPragma: true
+parsers: ["php"]
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+<?php<LF>
+<LF>
+class Something<LF>
+{<LF>
+    function whatever ()<LF>
+    {<LF>
+        /**<LF>
+         * Some mid-file docblock<LF>
+         */<LF>
+        $variable = 3;<LF>
+    }<LF>
+}<LF>
+
+=====================================output=====================================
+<?php<CRLF>
+/**<CRLF>
+ * @format<CRLF>
+ */<CRLF>
+<CRLF>
+class Something<CRLF>
+{<CRLF>
+    function whatever()<CRLF>
+    {<CRLF>
+        /**<CRLF>
+         * Some mid-file docblock<CRLF>
+         */<CRLF>
+        $variable = 3;<CRLF>
+    }<CRLF>
+}<CRLF>
+
+================================================================================
+`;
+
+exports[`pragma-firstdocblockmidfile.php 3`] = `
+====================================options=====================================
+endOfLine: "lf"
+insertPragma: true
+parsers: ["php"]
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+<?php<LF>
+<LF>
+class Something<LF>
+{<LF>
+    function whatever ()<LF>
+    {<LF>
+        /**<LF>
+         * Some mid-file docblock<LF>
+         */<LF>
+        $variable = 3;<LF>
+    }<LF>
+}<LF>
+
+=====================================output=====================================
+<?php<LF>
+/**<LF>
+ * @format<LF>
+ */<LF>
+<LF>
+class Something<LF>
+{<LF>
+    function whatever()<LF>
+    {<LF>
+        /**<LF>
+         * Some mid-file docblock<LF>
+         */<LF>
+        $variable = 3;<LF>
+    }<LF>
+}<LF>
+
+================================================================================
+`;
+
 exports[`pragma-nodocblock-CRLF.php 1`] = `
 ====================================options=====================================
 endOfLine: "cr"

tests/insert-pragma/pragma-firstdocblockmidfile.php

@@ -0,0 +1,12 @@
+<?php
+
+class Something
+{
+    function whatever ()
+    {
+        /**
+         * Some mid-file docblock
+         */
+        $variable = 3;
+    }
+}