feat: TS type information for remark-stringify and remark-parse

.travis.yml

@@ -1,15 +1,25 @@
 language: node_js
-node_js:
-- lts/boron
-- node
 sudo: false
+
+jobs:
+  fail_fast: true
+  include:
+    - stage: Tests
+      name: 'Node LTS/Boron'
+      node_js: lts/boron
+    - name: 'Node Stable'
+      node_js: 10
+    - name: Type information Tests
+      node_js: 10
+      script: lerna run test:types
+
 deploy:
   provider: releases
   skip_cleanup: true
   api_key:
     secure: GCfTZxoqpp1tMmslM5MTI13BLv+bvFhZUuhX+dQFbcVYODQKUjnUj9EBF10PJSTpYqm3GnGpxEoQ6RAUVxlH7rBQUFm4czaZPPgCDSZT3B8pszmQkl1aRyvdmXFoKfyNhFUwBUSsoBpM92wp/UrgIZ/CI0jLoIZbCwn4KH02rf8=
   file:
-    - "remark.js"
-    - "remark.min.js"
+    - 'remark.js'
+    - 'remark.min.js'
   on:
     tags: true

packages/remark-stringify/package.json

@@ -23,6 +23,7 @@
     "index.js",
     "lib"
   ],
+  "types": "types/index.d.ts",
   "dependencies": {
     "ccount": "^1.0.0",
     "is-alphanumeric": "^1.0.0",
@@ -40,14 +41,16 @@
     "xtend": "^4.0.1"
   },
   "devDependencies": {
+    "dtslint": "^0.4.2",
     "tape": "^4.9.1",
     "unified": "^7.0.0",
     "unist-builder": "^1.0.3",
     "unist-util-visit": "^1.4.0",
     "wcwidth": "^1.0.1"
   },
   "scripts": {
-    "test": "tape test.js"
+    "test": "tape test.js",
+    "test:types": "dtslint types"
   },
   "xo": false
 }

packages/remark-stringify/types/index.d.ts

@@ -0,0 +1,14 @@
+// TypeScript Version: 3.0
+
+declare module 'remark-stringify' {
+  import {RemarkStringifyOptions} from 'remark-stringify/types'
+  import {Attacher, Compiler, Processor} from 'unified'
+  import {Node} from 'unist'
+
+  interface Stringify extends Attacher {
+    Compiler: Compiler
+    (this: Processor, options?: Partial<RemarkStringifyOptions>): void
+  }
+  const stringify: Stringify
+  export = stringify
+}

packages/remark-stringify/types/test.ts

@@ -0,0 +1,18 @@
+import * as remarkStringify from 'remark-stringify'
+import {RemarkStringifyOptions} from 'remark-stringify/types'
+import * as unified from 'unified'
+
+const stringifyOptions: Partial<RemarkStringifyOptions> = {
+  gfm: true,
+  bullet: '*',
+  fences: true,
+  fence: '`',
+  incrementListMarker: false
+}
+
+unified().use(remarkStringify, stringifyOptions)
+
+const badStringifyOptions: Partial<RemarkStringifyOptions> = {
+  // $ExpectError
+  gfm: 'true'
+}

packages/remark-stringify/types/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "lib": ["es6"],
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "noEmit": true,
+    "baseUrl": ".",
+    "paths": {
+      "remark-stringify": ["."],
+      "remark-stringify/*": ["./*"]
+    }
+  }
+}

packages/remark-stringify/types/tslint.json

@@ -0,0 +1,9 @@
+{
+  "extends": "dtslint/dtslint.json", // Or "dtslint/dt.json" if on DefinitelyTyped
+  "rules": {
+    "semicolon": false,
+    "indent": false,
+    "whitespace": false,
+    "no-single-declare-module": false
+  }
+}

packages/remark-stringify/types/types.d.ts

@@ -0,0 +1,21 @@
+export interface RemarkStringifyOptions {
+  gfm: boolean
+  commonmark: boolean
+  entities: boolean | 'numbers' | 'escape'
+  setext: boolean
+  closeAtx: boolean
+  looseTable: boolean
+  spacedTable: boolean
+  paddedTable: boolean
+  stringLength: (s: string) => number
+  fence: '~' | '`'
+  fences: boolean
+  bullet: '-' | '*' | '+'
+  listItemIndent: 'tab' | '1' | 'mixed'
+  incrementListMarker: boolean
+  rule: '-' | '_' | '*'
+  ruleRepetition: number
+  ruleSpaces: boolean
+  strong: '_' | '*'
+  emphasis: '_' | '*'
+}