Prettier

Author: schmidt-sebastian

scripts/prune-dts/package.json

@@ -26,6 +26,8 @@
     "reportDir": "./coverage/node"
   },
   "devDependencies": {
-    "mocha": "8.2.1"
+    "@types/prettier": "2.1.5",
+    "mocha": "8.2.1",
+    "prettier": "2.1.2"
   }
 }

scripts/prune-dts/prune-dts.test.ts

@@ -18,6 +18,7 @@
 import * as os from 'os';
 import * as fs from 'fs';
 import * as path from 'path';
+import { format, resolveConfig } from 'prettier';
 import { expect } from 'chai';
 import { describe, it } from 'mocha';
 
@@ -27,13 +28,12 @@ const testCasesDir = path.resolve(__dirname, 'tests');
 const tmpDir = os.tmpdir();
 
 const testDataFilter = /(.*).input.d.ts/;
-const testCaseFilterRe = /.*inherits.*/;
+const testCaseFilterRe = /.*/;
 
-function runScript(filename: string): string {
-  const inputFile = path.resolve(testCasesDir, filename);
+function runScript(inputFile: string): string {
   const outputFile = path.resolve(tmpDir, 'output.d.ts');
   pruneDts(inputFile, outputFile);
-  return fs.readFileSync(outputFile, 'utf-8');
+  return outputFile;
 }
 
 interface TestCase {
@@ -67,12 +67,33 @@ function getTestCases(): TestCase[] {
 
 describe('Prune DTS', () => {
   for (const testCase of getTestCases()) {
-    it(testCase.name, () => {
-      const expectedDts = fs.readFileSync(
-        path.resolve(testCasesDir, testCase.outputFileName),
+    it(testCase.name, async () => {
+      const absoluteInputFile = path.resolve(
+        testCasesDir,
+        testCase.inputFileName
+      );
+      const absoluteOutputFile = path.resolve(
+        testCasesDir,
+        testCase.outputFileName
+      );
+
+      const tmpFile = runScript(absoluteInputFile);
+      const prettierConfig = await resolveConfig(absoluteInputFile);
+
+      const expectedDtsUnformatted = fs.readFileSync(
+        absoluteOutputFile,
         'utf-8'
       );
-      const actualDts = runScript(testCase.inputFileName);
+      const expectedDts = format(expectedDtsUnformatted, {
+        filepath: absoluteOutputFile,
+        ...prettierConfig
+      });
+      const actualDtsUnformatted = fs.readFileSync(tmpFile, 'utf-8');
+      const actualDts = format(actualDtsUnformatted, {
+        filepath: tmpFile,
+        ...prettierConfig
+      });
+
       expect(actualDts).to.equal(expectedDts);
     });
   }

scripts/prune-dts/prune-dts.ts

@@ -227,7 +227,7 @@ function convertPropertiesForEnclosingClass(
     /* importAdder= */ undefined,
     (c: ts.ClassElement) => newMembers.push(c)
   );
-  return [];
+  return newMembers;
 }
 /**
  * Replaces input types of public APIs that consume non-exported types, which

scripts/prune-dts/tests/hide-constructor.input.d.ts

@@ -19,3 +19,5 @@ export class Foo {
   /** @hideconstructor */
   constructor(bar: string);
 }
+
+export {};

scripts/prune-dts/tests/hide-constructor.output.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 export class Foo {
   private constructor();
 }
+export {};

scripts/prune-dts/tests/inherits-non-exported-members.input.d.ts

@@ -21,3 +21,4 @@ declare class Bar {
 export class Foo extends Bar {
   foo: string;
 }
+export {};

scripts/prune-dts/tests/inherits-non-exported-members.output.d.ts

@@ -14,8 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 export class Foo {
-  bar: string;
   foo: string;
+  bar: string;
 }
+export {};

scripts/prune-dts/tests/prunes-non-exported-types.input.d.ts

@@ -19,3 +19,5 @@ export function foo(): void;
 declare function bar(): void;
 export class Foo {}
 declare class Bar {}
+
+export {};

scripts/prune-dts/tests/prunes-non-exported-types.output.d.ts

@@ -14,6 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 export function foo(): void;
 export class Foo {}
+export {};

scripts/prune-dts/tests/prunes-underscores.input.d.ts

@@ -18,4 +18,9 @@
 export class Foo {
   foo: string;
   _bar: string;
+  _barMethod(): string;
+  get _barGetter(): string;
+  readonly _barProperty: string;
 }
+
+export {};

scripts/prune-dts/tests/prunes-underscores.output.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 export class Foo {
   foo: string;
 }
+export {};

scripts/prune-dts/tests/references-public-types.input.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare class Bar {}
+export class Foo extends Bar {}
+export function foo(bar: Bar): Bar;
+export class Foobar {
+  constructor(bar: Bar);
+  bar: Bar;
+  readonly barProperty: Bar;
+  get barGetter(): Bar;
+  barMethod(bar: Bar): Bar;
+}
+export {};

scripts/prune-dts/tests/references-public-types.output.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export class Foo {}
+export function foo(bar: Foo): Foo;
+export class Foobar {
+  constructor(bar: Foo);
+  bar: Foo;
+  readonly barProperty: Foo;
+  get barGetter(): Foo;
+  barMethod(bar: Foo): Foo;
+}
+export {};