From 253c9edcff346cb1c317593f18d6fa8b99fba30b Mon Sep 17 00:00:00 2001
From: Jamie Magee <JamieMagee@users.noreply.github.com>
Date: Sun, 26 Jan 2020 07:31:19 +0100
Subject: [PATCH] Add types for yawn-yaml (#41627)

* Add types for yawn-yaml

* PR comments
---
 types/yawn-yaml/cjs/index.d.ts     |  7 +++++++
 types/yawn-yaml/index.d.ts         | 11 +++++++++++
 types/yawn-yaml/tsconfig.json      | 23 +++++++++++++++++++++++
 types/yawn-yaml/tslint.json        |  1 +
 types/yawn-yaml/yawn-yaml-tests.ts |  7 +++++++
 5 files changed, 49 insertions(+)
 create mode 100644 types/yawn-yaml/cjs/index.d.ts
 create mode 100644 types/yawn-yaml/index.d.ts
 create mode 100644 types/yawn-yaml/tsconfig.json
 create mode 100644 types/yawn-yaml/tslint.json
 create mode 100644 types/yawn-yaml/yawn-yaml-tests.ts

diff --git a/types/yawn-yaml/cjs/index.d.ts b/types/yawn-yaml/cjs/index.d.ts
new file mode 100644
index 0000000000..86da2fde63
--- /dev/null
+++ b/types/yawn-yaml/cjs/index.d.ts
@@ -0,0 +1,7 @@
+export default class YAWN {
+    constructor(content: string);
+    json: any;
+    yaml: string;
+    getRemark(path: string): string;
+    setRemark(path: string, remark: string): boolean;
+}
diff --git a/types/yawn-yaml/index.d.ts b/types/yawn-yaml/index.d.ts
new file mode 100644
index 0000000000..76d6af9bc4
--- /dev/null
+++ b/types/yawn-yaml/index.d.ts
@@ -0,0 +1,11 @@
+// Type definitions for yawn-yaml 1.4
+// Project: https://github.com/mohsen1/yawn-yaml#readme
+// Definitions by: Jamie Magee <https://github.com/JamieMagee>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+export default class YAWN {
+    constructor(content: string);
+    json: any;
+    yaml: string;
+    getRemark(path: string): string;
+    setRemark(path: string, remark: string): boolean;
+}
diff --git a/types/yawn-yaml/tsconfig.json b/types/yawn-yaml/tsconfig.json
new file mode 100644
index 0000000000..8c59cd6f73
--- /dev/null
+++ b/types/yawn-yaml/tsconfig.json
@@ -0,0 +1,23 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "yawn-yaml-tests.ts"
+    ]
+}
diff --git a/types/yawn-yaml/tslint.json b/types/yawn-yaml/tslint.json
new file mode 100644
index 0000000000..3db14f85ea
--- /dev/null
+++ b/types/yawn-yaml/tslint.json
@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }
diff --git a/types/yawn-yaml/yawn-yaml-tests.ts b/types/yawn-yaml/yawn-yaml-tests.ts
new file mode 100644
index 0000000000..52f4e85386
--- /dev/null
+++ b/types/yawn-yaml/yawn-yaml-tests.ts
@@ -0,0 +1,7 @@
+import YAML from 'yawn-yaml/cjs';
+
+const yaml = new YAML(''); // $ExpectType YAWN
+yaml.json; // $ExpectType any
+yaml.yaml; // $ExpectType string
+yaml.getRemark(''); // $ExpectType string
+yaml.setRemark('', ''); // $ExpectType boolean